|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectDataGridURLBuilder
public abstract class DataGridURLBuilder
This abstract class provides methods that are used to build maps of URL parameters containing current ahd future data grid state. These are useful for building anchors and other kinds of requests that when clicked / submitted can move to the next or previous page of data or change the state of sorts or filters for a data grid.
Subclasses are free to implement the contents of the parameter map with whatever parameter key / values that make sense for a particular data grid. For example, some data grids may encode sort, filter, and paging information in the URL. Others may add information about row selection and not add sort / filter parameters. Be sure to check the documentation for a specific DataGridURLBuilder subclass to find out what specific parameters are available in the parameter maps.
Parameter maps produced by methods on this class should contain key / value pairs
where the key is of type String
and the values are of type
String[]
. The parameter maps should also include all of the
additional "current" URL parameters in order to maintain the "current" view
state and modifying only state associated with a single data grid. Subclasses are
free to change this behavior.
Constructor Summary | |
---|---|
DataGridURLBuilder()
|
Method Summary | |
---|---|
abstract Map |
buildSortQueryParamsMap(String sortExpression)
Get a parameter map that contains the grid's current state with the sort matching the given sortExpression switched to the
next available sort direction. |
abstract String[] |
getPagerParamValues()
Get a String array that contains the values which can be used to reach any page in the data grid. |
abstract String |
getPagerRowQueryParamKey()
Get the String for the pager query parameter key. |
abstract Map |
getQueryParams()
Get a Map containing the current state of the data grid. |
abstract Map |
getQueryParamsForFirstPage()
Get a parameter map that contains the grid's current state with a value that will set the current to the first page. |
abstract Map |
getQueryParamsForLastPage()
Get a parameter map that contains the grid's current state with a value that will set the current page to the last page. |
abstract Map |
getQueryParamsForNextPage()
Get a parameter map that contains the grid's current state with a value that will set the current page to the next page. |
abstract Map |
getQueryParamsForPreviousPage()
Get a parameter map that contains the grid's current state with a value that will set the current page to the previous page. |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DataGridURLBuilder()
Method Detail |
---|
public abstract Map getQueryParams()
Map
containing the current state of the data grid.
public abstract Map getQueryParamsForFirstPage()
public abstract Map getQueryParamsForPreviousPage()
public abstract Map getQueryParamsForNextPage()
public abstract Map getQueryParamsForLastPage()
public abstract String[] getPagerParamValues()
public abstract String getPagerRowQueryParamKey()
public abstract Map buildSortQueryParamsMap(String sortExpression)
sortExpression
switched to the
next available sort direction.
sortExpression
- the sort expression whose sort value to change
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |