public interface DataSetHandler
Modifier and Type | Method and Description |
---|---|
boolean |
drillDown(org.dashbuilder.dataset.group.DataSetGroup op)
Applies the specified group interval selection operation over the existing group op.
|
boolean |
drillUp(org.dashbuilder.dataset.group.DataSetGroup op)
Reverts the changes applied by a previous drillDown operation.
|
void |
exportCurrentDataSetLookup(ExportFormat format,
int maxRows,
ExportCallback callback,
Map<String,String> columnNameMap)
Export the current data set to a file in the specified output format.
|
boolean |
filter(org.dashbuilder.dataset.filter.DataSetFilter op)
Forces the underlying data set to be updated according the specified filter.
|
boolean |
filter(org.dashbuilder.dataset.group.DataSetGroup op)
Forces the underlying data set to be updated according the group interval selection filter.
|
org.dashbuilder.dataset.DataSetLookup |
getCurrentDataSetLookup()
Get the current data set lookup (if any)
|
org.dashbuilder.dataset.group.DataSetGroup |
getGroupOperation(String columnId)
Retrieves any group operation present in the current data set lookup for the target column specified.
|
org.dashbuilder.dataset.group.Interval |
getInterval(String columnId,
int row)
Get the interval at the given row for the column specified.
|
org.dashbuilder.dataset.DataSet |
getLastDataSet()
Get the data set get on the last lookup call (if any)
|
void |
limitDataSetRows(int offset,
int rows)
Forces the next data set lookup request to retrieve only the specified row sub set.
|
void |
lookupDataSet(DataSetReadyCallback callback)
Executes the current data set lookup request configured within this handler.
|
void |
resetAllOperations()
Restore the current data set lookup instance to its base status.
|
void |
sort(String columnId,
org.dashbuilder.dataset.sort.SortOrder sortOrder)
Set the sort order operation to apply to the data set.
|
boolean |
unfilter(org.dashbuilder.dataset.filter.DataSetFilter op)
Reverts the changes applied by a previous filter operation.
|
boolean |
unfilter(org.dashbuilder.dataset.group.DataSetGroup op)
Reverts the changes applied by a previous filter operation.
|
org.dashbuilder.dataset.group.DataSetGroup getGroupOperation(String columnId)
columnId
- The column id. to look for.org.dashbuilder.dataset.group.Interval getInterval(String columnId, int row)
In case of grouped data sets, the interval may contain information related to the group operation. For instance, for a data set grouped by month, will return an interval containing the min/max dates of such month.
For non-grouped or grouped by label data sets, will return only an interval with the value of the row/column selected.
The interval information is useful for filtering purposes as the data provider needs all the information related to the selected interval.columnId
- The column id.row
- The row which interval we want to retrieve.boolean filter(org.dashbuilder.dataset.group.DataSetGroup op)
op
- The group interval selection operation to apply op.getSelectedIntervalNames() MUST NOT BE EMPTY.boolean unfilter(org.dashbuilder.dataset.group.DataSetGroup op)
op
- The operation to remove.boolean filter(org.dashbuilder.dataset.filter.DataSetFilter op)
op
- The filter operation to apply.boolean unfilter(org.dashbuilder.dataset.filter.DataSetFilter op)
op
- The operation to remove.boolean drillDown(org.dashbuilder.dataset.group.DataSetGroup op)
op
- The group interval selection operation to apply op.getSelectedIntervalNames() MUST NOT BE EMPTY.boolean drillUp(org.dashbuilder.dataset.group.DataSetGroup op)
op
- The operation to remove.void sort(String columnId, org.dashbuilder.dataset.sort.SortOrder sortOrder)
columnId
- The name of the column to sort.sortOrder
- The sort order.void limitDataSetRows(int offset, int rows)
offset
- The position where the row sub set starts.rows
- The number of rows to get.void resetAllOperations()
void lookupDataSet(DataSetReadyCallback callback) throws Exception
callback
- The callback interface that is invoked right after the data is available.Exception
org.dashbuilder.dataset.DataSet getLastDataSet()
org.dashbuilder.dataset.DataSetLookup getCurrentDataSetLookup()
void exportCurrentDataSetLookup(ExportFormat format, int maxRows, ExportCallback callback, Map<String,String> columnNameMap)
format
- The output formatmaxRows
- Max rows to be exported.callback
- The callback instance to be notifiedcolumnNameMap
- A map containing the column header names for every column in the data set lookupCopyright © 2012–2020 JBoss by Red Hat. All rights reserved.