org.openmrs.web.controller.bean

Class DatatableResponse

java.lang.Object

org.openmrs.web.controller.bean.DatatableResponse

public class DatatableResponse
extends Object

Class dedicated for DataTables. It is a response that can be translated to JSON.

See Also:

http://datatables.net/

Constructor Summary

Constructors

Constructor and Description
DatatableResponse(DatatableRequest request)

Method Summary

Modifier and Type	Method and Description
void	addRow(Map<String,String> row) Adds the given row to the data.
void	addRow(String... row) Adds the given row to the data.
String[][]	getAaData() The data in a 2D array.
Integer	getiTotalDisplayRecords()
Integer	getiTotalRecords()
String[]	getsColumns()
Integer	getsEcho() An unaltered copy of sEcho sent from the client side.
void	setiTotalDisplayRecords(Integer iTotalDisplayRecords) Total records, after filtering (i.e.
void	setiTotalRecords(Integer iTotalRecords) Total records, before filtering (i.e.
void	setsColumns(String... sColumns) Optional - this is a string of column names, comma separated (used in combination with sName) which will allow DataTables to reorder data on the client-side if required for display.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatatableResponse

public DatatableResponse(DatatableRequest request)

Method Detail

getsEcho

public Integer getsEcho()

An unaltered copy of sEcho sent from the client side. This parameter will change with each draw (it is basically a draw count) - so it is important that this is implemented. Note that it strongly recommended for security reasons that you 'cast' this parameter to an integer in order to prevent Cross Site Scripting (XSS) attacks.

Returns:

the sEcho

getiTotalRecords

public Integer getiTotalRecords()

Returns:

the iTotalRecords

See Also:

setiTotalRecords(Integer)

setiTotalRecords

public void setiTotalRecords(Integer iTotalRecords)

Total records, before filtering (i.e. the total number of records in the database).

Parameters:

iTotalRecords - the iTotalRecords to set

getiTotalDisplayRecords

public Integer getiTotalDisplayRecords()

Returns:

the iTotalDisplayRecords

See Also:

setiTotalDisplayRecords(Integer)

setiTotalDisplayRecords

public void setiTotalDisplayRecords(Integer iTotalDisplayRecords)

Total records, after filtering (i.e. the total number of records after filtering has been applied - not just the number of records being returned in this result set).

Parameters:

iTotalDisplayRecords - the iTotalDisplayRecords to set

getsColumns

public String[] getsColumns()

Returns:

the sColumns

See Also:

setsColumns(String...)

setsColumns

public void setsColumns(String... sColumns)

Optional - this is a string of column names, comma separated (used in combination with sName) which will allow DataTables to reorder data on the client-side if required for display. Note that the number of column names returned must exactly match the number of columns in the table. For a more flexible JSON format, please consider using mDataProp.

Parameters:

sColumns - the sColumns to set

getAaData

public String[][] getAaData()

The data in a 2D array. Note that you can change the name of this parameter with sAjaxDataProp.

Returns:

the aaData

addRow

public void addRow(String... row)

Adds the given row to the data. Consecutive calls must contain the same amount of columns.

Parameters:

row -

addRow

public void addRow(Map<String,String> row)

Adds the given row to the data.

Parameters:

row -