Package lib.aide.tabular

Record Class TabularRowsRequest

java.lang.Object

java.lang.Record

lib.aide.tabular.TabularRowsRequest

Record Components:

startRow - The index of the first row to fetch.

endRow - The index of the last row to fetch.

filterModel - The filter model applied to the grid.

valueCols - The columns to aggregate.

rowGroupCols - The columns to group by.

pivotMode - Indicates if pivot mode is enabled.

pivotCols - The columns to pivot.

groupKeys - The keys to group by.

sortModel - The sort model applied to the grid.

requestContext - Additional context data for the request.

rangeSelection - The selected ranges in the grid.

aggregationFunctions - The aggregation functions to apply.

public record TabularRowsRequest(int startRow, int endRow, Map<String,TabularRowsRequest.FilterModel> filterModel, List<TabularRowsRequest.ColumnVO> valueCols, List<TabularRowsRequest.ColumnVO> rowGroupCols, boolean pivotMode, List<TabularRowsRequest.ColumnVO> pivotCols, List<String> groupKeys, List<TabularRowsRequest.SortModel> sortModel, Map<String,Object> requestContext, List<TabularRowsRequest.RangeSelection> rangeSelection, List<TabularRowsRequest.AggregationFunction> aggregationFunctions)
extends Record

Record representing a server-side rows request from AG Grid. This record includes all necessary parameters for pagination, sorting, filtering, and grouping.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	TabularRowsRequest.AggregationFunction	Record representing an aggregation function.
static final record	TabularRowsRequest.ColumnVO	Record representing a column definition.
static final record	TabularRowsRequest.ConditionsFilterModel	Record representing a filter model.
static final record	TabularRowsRequest.FilterModel	Record representing a filter model.
static final record	TabularRowsRequest.RangeSelection	Record representing a range selection.
static final record	TabularRowsRequest.SortModel	Record representing a sort model.

Constructor Summary

Constructors

Constructor

Description

TabularRowsRequest(int startRow, int endRow, Map<String,TabularRowsRequest.FilterModel> filterModel, List<TabularRowsRequest.ColumnVO> valueCols, List<TabularRowsRequest.ColumnVO> rowGroupCols, boolean pivotMode, List<TabularRowsRequest.ColumnVO> pivotCols, List<String> groupKeys, List<TabularRowsRequest.SortModel> sortModel, Map<String,Object> requestContext, List<TabularRowsRequest.RangeSelection> rangeSelection, List<TabularRowsRequest.AggregationFunction> aggregationFunctions)

Creates an instance of a TabularRowsRequest record class.

Method Summary

Modifier and Type	Method	Description
List<TabularRowsRequest.AggregationFunction>	aggregationFunctions()	Returns the value of the aggregationFunctions record component.
int	endRow()	Returns the value of the endRow record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Map<String,TabularRowsRequest.FilterModel>	filterModel()	Returns the value of the filterModel record component.
List<String>	groupKeys()	Returns the value of the groupKeys record component.
final int	hashCode()	Returns a hash code value for this object.
List<TabularRowsRequest.ColumnVO>	pivotCols()	Returns the value of the pivotCols record component.
boolean	pivotMode()	Returns the value of the pivotMode record component.
List<TabularRowsRequest.RangeSelection>	rangeSelection()	Returns the value of the rangeSelection record component.
Map<String,Object>	requestContext()	Returns the value of the requestContext record component.
List<TabularRowsRequest.ColumnVO>	rowGroupCols()	Returns the value of the rowGroupCols record component.
List<TabularRowsRequest.SortModel>	sortModel()	Returns the value of the sortModel record component.
int	startRow()	Returns the value of the startRow record component.
final String	toString()	Returns a string representation of this record class.
List<TabularRowsRequest.ColumnVO>	valueCols()	Returns the value of the valueCols record component.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

TabularRowsRequest

public TabularRowsRequest(int startRow,
 int endRow,
 Map<String,TabularRowsRequest.FilterModel> filterModel,
 List<TabularRowsRequest.ColumnVO> valueCols,
 List<TabularRowsRequest.ColumnVO> rowGroupCols,
 boolean pivotMode,
 List<TabularRowsRequest.ColumnVO> pivotCols,
 List<String> groupKeys,
 List<TabularRowsRequest.SortModel> sortModel,
 Map<String,Object> requestContext,
 List<TabularRowsRequest.RangeSelection> rangeSelection,
 List<TabularRowsRequest.AggregationFunction> aggregationFunctions)

Creates an instance of a TabularRowsRequest record class.

Parameters:

startRow - the value for the startRow record component

endRow - the value for the endRow record component

filterModel - the value for the filterModel record component

valueCols - the value for the valueCols record component

rowGroupCols - the value for the rowGroupCols record component

pivotMode - the value for the pivotMode record component

pivotCols - the value for the pivotCols record component

groupKeys - the value for the groupKeys record component

sortModel - the value for the sortModel record component

requestContext - the value for the requestContext record component

rangeSelection - the value for the rangeSelection record component

aggregationFunctions - the value for the aggregationFunctions record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

startRow

public int startRow()

Returns the value of the startRow record component.

Returns:

the value of the startRow record component

endRow

public int endRow()

Returns the value of the endRow record component.

Returns:

the value of the endRow record component

filterModel

public Map<String,TabularRowsRequest.FilterModel> filterModel()

Returns the value of the filterModel record component.

Returns:

the value of the filterModel record component

valueCols

public List<TabularRowsRequest.ColumnVO> valueCols()

Returns the value of the valueCols record component.

Returns:

the value of the valueCols record component

rowGroupCols

public List<TabularRowsRequest.ColumnVO> rowGroupCols()

Returns the value of the rowGroupCols record component.

Returns:

the value of the rowGroupCols record component

pivotMode

public boolean pivotMode()

Returns the value of the pivotMode record component.

Returns:

the value of the pivotMode record component

pivotCols

public List<TabularRowsRequest.ColumnVO> pivotCols()

Returns the value of the pivotCols record component.

Returns:

the value of the pivotCols record component

groupKeys

public List<String> groupKeys()

Returns the value of the groupKeys record component.

Returns:

the value of the groupKeys record component

sortModel

public List<TabularRowsRequest.SortModel> sortModel()

Returns the value of the sortModel record component.

Returns:

the value of the sortModel record component

requestContext

public Map<String,Object> requestContext()

Returns the value of the requestContext record component.

Returns:

the value of the requestContext record component

rangeSelection

public List<TabularRowsRequest.RangeSelection> rangeSelection()

Returns the value of the rangeSelection record component.

Returns:

the value of the rangeSelection record component

aggregationFunctions

public List<TabularRowsRequest.AggregationFunction> aggregationFunctions()

Returns the value of the aggregationFunctions record component.

Returns:

the value of the aggregationFunctions record component