Package step.core.tables

Interface Table<T>

All Known Implementing Classes:

AbstractTable, ExecutionTable, LeafReportNodeTable, ParameterTable, PlanTable, ReportNodeTable

public interface Table<T>

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	distinct(java.lang.String columnName)
java.util.List<java.lang.String>	distinct(java.lang.String columnName, step.core.collections.Filter filter)
T	enrichEntity(T entity)
TableFindResult<T>	find(step.core.collections.Filter filter, step.core.collections.SearchOrder order, java.lang.Integer skip, java.lang.Integer limit, int maxTime)
java.util.List<step.core.collections.Filter>	getAdditionalQueryFragments(javax.json.JsonObject queryParameters)
java.util.Map<java.lang.String,TableColumn>	getExportFields()
step.core.collections.Filter	getQueryFragmentForColumnSearch(java.lang.String columnName, java.lang.String searchValue)
boolean	isFiltered()

Method Detail

distinct

java.util.List<java.lang.String> distinct(java.lang.String columnName)

Parameters:

columnName - the name of the column (field)

Returns:

the distinct values of the column

distinct

java.util.List<java.lang.String> distinct(java.lang.String columnName,
                                          step.core.collections.Filter filter)

Parameters:

columnName - the name of the column (field)

query - : the query filter

Returns:

the distinct values of the column

find

TableFindResult<T> find(step.core.collections.Filter filter,
                        step.core.collections.SearchOrder order,
                        java.lang.Integer skip,
                        java.lang.Integer limit,
                        int maxTime)

getQueryFragmentForColumnSearch

step.core.collections.Filter getQueryFragmentForColumnSearch(java.lang.String columnName,
                                                             java.lang.String searchValue)

Parameters:

columnName - the name of the column on which the search is applied

searchValue - the value entered by the end user

Returns:

a list of query fragments to be appended to the queries when performing a column search

getAdditionalQueryFragments

java.util.List<step.core.collections.Filter> getAdditionalQueryFragments(javax.json.JsonObject queryParameters)

Parameters:

queryParameters - some context parameters that might be required to generate the additional query fragments

Returns:

a list of query fragments to be appended to the queries when calling the method find()

isFiltered

boolean isFiltered()

Returns:

true if the filter defined by the ObjectFilter of the ObjectHookRegistry have to be applied when performing a search

getExportFields

java.util.Map<java.lang.String,TableColumn> getExportFields()

enrichEntity

T enrichEntity(T entity)