Class JQueryDataTableParamModel
- java.lang.Object
-
- org.drdeesw.commons.queries.datatables.JQueryDataTableParamModel
-
- All Implemented Interfaces:
java.io.Serializable
public class JQueryDataTableParamModel extends java.lang.Object implements java.io.Serializable- Author:
- gary_kephart
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description JQueryDataTableParamModel()The default constructor.JQueryDataTableParamModel(JQueryDataTableParamModel that)The copy constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.Object>getAjaxData()java.lang.String[]getColumnData()Column's data source, as defined by columns.data option.java.lang.String[]getColumnNames()Column names, as defined by columns.name option.boolean[]getColumnOrderables()Flag to indicate if this column is orderable (true) or not (false).boolean[]getColumnSearchable()Flag to indicate if this column is searchable (true) or not (false).boolean[]getColumnSearchRegex()Flag to indicate if the search term for this column should be treated as regular expression (true) or not (false).java.lang.StringgetColumnSearchValue(java.lang.String data)java.lang.String[]getColumnSearchValues()Comma-separated search values to apply to this specific column.java.lang.IntegergetDraw()Draw counter.java.lang.IntegergetLength()Number of records that the table can display in the current draw.int[]getOrderColumns()Columns to which ordering should be applied.boolean[]getOrderDirs()Ordering direction for this column.java.lang.BooleangetSearchCaseInsensitive()java.lang.BooleangetSearchRegex()true if the global filter should be treated as a regular expression for advanced searching, false otherwise.java.lang.StringgetSearchValue()Global search value.java.lang.StringgetSearchValue(java.lang.String data)java.lang.IntegergetStart()Paging first record indicator.booleanisPerformCount()voidsetAjaxData(java.lang.String key, java.lang.Object value)voidsetColumnData(java.lang.String[] columnData)voidsetColumnNames(java.lang.String[] columnNames)voidsetColumnOrderables(boolean[] columnOrderables)voidsetColumnSearchable(boolean[] columnSearchable)voidsetColumnSearchRegex(boolean[] columnSearchRegex)voidsetColumnSearchValues(java.lang.String[] columnSearchValues)voidsetDraw(java.lang.Integer draw)voidsetLength(java.lang.Integer length)voidsetOrderColumns(int[] orderColumns)voidsetOrderDirs(boolean[] orderDirs)voidsetPerformCount(boolean performCount)voidsetSearchCaseInsensitive(java.lang.Boolean searchCaseInsensitive)voidsetSearchRegex(java.lang.Boolean searchRegex)voidsetSearchValue(java.lang.String searchValue)voidsetStart(java.lang.Integer start)java.lang.StringtoString()
-
-
-
Field Detail
-
ASC
public static final java.lang.String ASC
- See Also:
- Constant Field Values
-
DESC
public static final java.lang.String DESC
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
JQueryDataTableParamModel
public JQueryDataTableParamModel()
The default constructor.
-
JQueryDataTableParamModel
public JQueryDataTableParamModel(JQueryDataTableParamModel that)
The copy constructor.- Parameters:
that-
-
-
Method Detail
-
getAjaxData
public java.util.Map<java.lang.String,java.lang.Object> getAjaxData()
- Returns:
- the ajaxData
-
getColumnData
public java.lang.String[] getColumnData()
Column's data source, as defined by columns.data option.- Returns:
- the columnData
-
getColumnNames
public java.lang.String[] getColumnNames()
Column names, as defined by columns.name option.- Returns:
- the columnNames
-
getColumnOrderables
public boolean[] getColumnOrderables()
Flag to indicate if this column is orderable (true) or not (false).- Returns:
- the columnOrderables
-
getColumnSearchable
public boolean[] getColumnSearchable()
Flag to indicate if this column is searchable (true) or not (false).- Returns:
- the columnSearchable
-
getColumnSearchRegex
public boolean[] getColumnSearchRegex()
Flag to indicate if the search term for this column should be treated as regular expression (true) or not (false). As with global search, normally server-side processing scripts will not perform regular expression searching for performance reasons on large data sets, but it is technically possible and at the discretion of your script.- Returns:
- the columnSearchRegex
-
getColumnSearchValue
public java.lang.String getColumnSearchValue(java.lang.String data)
- Parameters:
data-- Returns:
-
getColumnSearchValues
public java.lang.String[] getColumnSearchValues()
Comma-separated search values to apply to this specific column.- Returns:
- the columnSearchValues
-
getDraw
public java.lang.Integer getDraw()
Draw counter. A draw is a page of data. This is used by DataTables to ensure that the Ajax returns from server-side processing requests are drawn in sequence by DataTables (Ajax requests are asynchronous and thus can return out of sequence). This is used as part of the draw return parameter.- Returns:
- the draw
-
getLength
public java.lang.Integer getLength()
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. Note that this can be -1 to indicate that all records should be returned (although that negates any benefits of server-side processing!)- Returns:
- the length
-
getOrderColumns
public int[] getOrderColumns()
Columns to which ordering should be applied. This is an index reference to the columns array of information that is also submitted to the server.- Returns:
- the orderColumns
-
getOrderDirs
public boolean[] getOrderDirs()
Ordering direction for this column. It will be asc or desc to indicate ascending ordering or descending ordering, respectively.- Returns:
- the orderDirs
-
getSearchCaseInsensitive
public java.lang.Boolean getSearchCaseInsensitive()
- Returns:
- the searchCaseInsensitive
-
getSearchRegex
public java.lang.Boolean getSearchRegex()
true if the global filter should be treated as a regular expression for advanced searching, false otherwise. Note that normally server-side processing scripts will not perform regular expression searching for performance reasons on large data sets, but it is technically possible and at the discretion of your script.- Returns:
- the searchRegex
-
getSearchValue
public java.lang.String getSearchValue()
Global search value. To be applied to all columns which have searchable as true.- Returns:
- the searchValue
-
getSearchValue
public java.lang.String getSearchValue(java.lang.String data)
- Parameters:
data-- Returns:
-
getStart
public java.lang.Integer getStart()
Paging first record indicator. This is the start point in the current data set (0 index based - i.e. 0 is the first record).- Returns:
- the start
-
isPerformCount
public boolean isPerformCount()
- Returns:
- the performCount
-
setAjaxData
public void setAjaxData(java.lang.String key, java.lang.Object value)
-
setColumnData
public void setColumnData(java.lang.String[] columnData)
- Parameters:
columnData- the columnData to set
-
setColumnNames
public void setColumnNames(java.lang.String[] columnNames)
-
setColumnOrderables
public void setColumnOrderables(boolean[] columnOrderables)
- Parameters:
columnOrderables- the columnOrderables to set
-
setColumnSearchable
public void setColumnSearchable(boolean[] columnSearchable)
- Parameters:
columnSearchable- the columnSearchable to set
-
setColumnSearchRegex
public void setColumnSearchRegex(boolean[] columnSearchRegex)
- Parameters:
columnSearchRegex- the columnSearchRegex to set
-
setColumnSearchValues
public void setColumnSearchValues(java.lang.String[] columnSearchValues)
- Parameters:
columnSearchValues- the columnSearchValues to set
-
setDraw
public void setDraw(java.lang.Integer draw)
- Parameters:
draw- the draw to set
-
setLength
public void setLength(java.lang.Integer length)
- Parameters:
length- the length to set
-
setOrderColumns
public void setOrderColumns(int[] orderColumns)
- Parameters:
orderColumns- the orderColumns to set
-
setOrderDirs
public void setOrderDirs(boolean[] orderDirs)
- Parameters:
orderDirs- the orderDirs to set
-
setPerformCount
public void setPerformCount(boolean performCount)
- Parameters:
performCount- the performCount to set
-
setSearchCaseInsensitive
public void setSearchCaseInsensitive(java.lang.Boolean searchCaseInsensitive)
- Parameters:
searchCaseInsensitive- the searchCaseInsensitive to set
-
setSearchRegex
public void setSearchRegex(java.lang.Boolean searchRegex)
- Parameters:
searchRegex- the searchRegex to set
-
setSearchValue
public void setSearchValue(java.lang.String searchValue)
- Parameters:
searchValue- the searchValue to set
-
setStart
public void setStart(java.lang.Integer start)
- Parameters:
start- the start to set
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-