org.openmrs.web.controller.bean

Class DatatableRequest

java.lang.Object

org.openmrs.web.controller.bean.DatatableRequest

public class DatatableRequest
extends Object

Class dedicated for DataTables. It is a request that can be extracted from HttpServletRequest with parseRequest(HttpServletRequest).

See Also:

http://datatables.net/

Constructor Summary

Constructors

Constructor and Description
DatatableRequest()

Method Summary

Modifier and Type	Method and Description
Boolean	getbRegex() True if the global filter should be treated as a regular expression for advanced filtering, false if not.
Boolean[]	getbRegexCol() True if the individual column filter should be treated as a regular expression for advanced filtering, false if not.
Boolean[]	getbSearchableCol() Indicator for if a column is flagged as searchable or not on the client-side.
Boolean[]	getbSortableCol() Indicator for if a column is flagged as sortable or not on the client-side.
Integer	getiColumns() Number of columns being displayed (useful for getting individual column search info).
Integer	getiDisplayLength() Number of records that the table can display in the current draw.
Integer	getiDisplayStart() Display start point in the current data set.
Integer[]	getiSortCol() Column being sorted on (you will need to decode this number for your database).
Integer	getiSortingCols() Number of columns to sort on.
String[]	getmDataPropCol() The value specified by mDataProp for each column.
Integer	getsEcho() Information for DataTables to use for rendering.
String	getsSearch() Global search field.
String[]	getsSearchCol() Individual column filter.
String[]	getsSortDirCol() Direction to be sorted - "desc" or "asc".
static DatatableRequest	parseRequest(javax.servlet.http.HttpServletRequest request) Creates DatatableRequest from parameters found in the given request.
void	setbRegex(Boolean bRegex)
void	setbRegexCol(Boolean[] bRegexCol)
void	setbSearchableCol(Boolean[] bSearchableCol)
void	setbSortableCol(Boolean[] bSortableCol)
void	setiColumns(Integer iColumns)
void	setiDisplayLength(Integer iDisplayLength)
void	setiDisplayStart(Integer iDisplayStart)
void	setiSortCol(Integer[] iSortCol)
void	setiSortingCols(Integer iSortingCols)
void	setmDataPropCol(String[] mDataPropCol)
void	setsEcho(Integer sEcho)
void	setsSearch(String sSearch)
void	setsSearchCol(String[] sSearchCol)
void	setsSortDirCol(String[] sSortDirCol)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatatableRequest

public DatatableRequest()

Method Detail

getiDisplayStart

public Integer getiDisplayStart()

Display start point in the current data set.

Returns:

the iDisplayStart

setiDisplayStart

public void setiDisplayStart(Integer iDisplayStart)

Parameters:

iDisplayStart - the iDisplayStart to set

See Also:

getiDisplayStart()

getiDisplayLength

public Integer getiDisplayLength()

Number of records that the table can display in the current draw. It is expected that the number of records returned will be equal to this number, unless the server has fewer records to return.

Returns:

the iDisplayLength

setiDisplayLength

public void setiDisplayLength(Integer iDisplayLength)

Parameters:

iDisplayLength - the iDisplayLength to set

See Also:

getiDisplayLength()

getiColumns

public Integer getiColumns()

Number of columns being displayed (useful for getting individual column search info).

Returns:

the iColumns

setiColumns

public void setiColumns(Integer iColumns)

Parameters:

iColumns - the iColumns to set

See Also:

getiColumns()

getsSearch

public String getsSearch()

Global search field.

Returns:

the sSearch

setsSearch

public void setsSearch(String sSearch)

Parameters:

sSearch - the sSearch to set

See Also:

getsSearch()

getbRegex

public Boolean getbRegex()

True if the global filter should be treated as a regular expression for advanced filtering, false if not.

Returns:

the bRegex

setbRegex

public void setbRegex(Boolean bRegex)

Parameters:

bRegex - the bRegex to set

See Also:

getbRegex()

getbSearchableCol

public Boolean[] getbSearchableCol()

Indicator for if a column is flagged as searchable or not on the client-side.

Returns:

the bSearchableCol

setbSearchableCol

public void setbSearchableCol(Boolean[] bSearchableCol)

Parameters:

bSearchableCol - the bSearchable to set

See Also:

getbSearchableCol()

getsSearchCol

public String[] getsSearchCol()

Individual column filter.

Returns:

the sSearchCol

setsSearchCol

public void setsSearchCol(String[] sSearchCol)

Parameters:

sSearchCol - the sSearchColumn to set

See Also:

getsSearchCol()

getbRegexCol

public Boolean[] getbRegexCol()

True if the individual column filter should be treated as a regular expression for advanced filtering, false if not.

Returns:

the bRegexCol

setbRegexCol

public void setbRegexCol(Boolean[] bRegexCol)

Parameters:

bRegexCol - the bRegexColumn to set

See Also:

getbRegexCol()

getbSortableCol

public Boolean[] getbSortableCol()

Indicator for if a column is flagged as sortable or not on the client-side.

Returns:

the bSortableCol

setbSortableCol

public void setbSortableCol(Boolean[] bSortableCol)

Parameters:

bSortableCol - the bSortable to set

See Also:

getbSortableCol()

getiSortingCols

public Integer getiSortingCols()

Number of columns to sort on.

Returns:

the iSortingCols

setiSortingCols

public void setiSortingCols(Integer iSortingCols)

Parameters:

iSortingCols - the iSortingCols to set

See Also:

getiSortingCols()

getiSortCol

public Integer[] getiSortCol()

Column being sorted on (you will need to decode this number for your database).

Returns:

the iSortCol

setiSortCol

public void setiSortCol(Integer[] iSortCol)

Parameters:

iSortCol - the iSortCol to set

See Also:

getiSortCol()

getsSortDirCol

public String[] getsSortDirCol()

Direction to be sorted - "desc" or "asc".

Returns:

the sSortDirCol

setsSortDirCol

public void setsSortDirCol(String[] sSortDirCol)

Parameters:

sSortDirCol - the sSortDir to set

See Also:

getsSortDirCol()

getmDataPropCol

public String[] getmDataPropCol()

The value specified by mDataProp for each column. This can be useful for ensuring that the processing of data is independent from the order of the columns.

Returns:

the mDataPropCol

setmDataPropCol

public void setmDataPropCol(String[] mDataPropCol)

Parameters:

mDataPropCol - the mDataProp to set

See Also:

getmDataPropCol()

getsEcho

public Integer getsEcho()

Information for DataTables to use for rendering.

Returns:

the sEcho

setsEcho

public void setsEcho(Integer sEcho)

Parameters:

sEcho - the sEcho to set

See Also:

getsEcho()

parseRequest

public static DatatableRequest parseRequest(javax.servlet.http.HttpServletRequest request)

Creates DatatableRequest from parameters found in the given request.

Parameters:

request -

Returns:

DatatableRequest