A query table exposed by this app, populated by calling the row-producing JavaScript function declared for it in the app's controllers.xml. Column headers may be static or produced by their own function, and rows are fetched a page at a time.

Implements: Table


Properties

PropertyReturnsDescription
descriptionStringA short description of what this table shows, as declared for it in the app's controllers.xml.
headersList<String>This table's column headers: either the static list declared for it, or, if a headers function is declared, that static list extended by calling the function.
tableIdStringThis table's unique identifier, as declared for it in the app's controllers.xml.

Inherited from Table

Methods

getRows(int start, Integer maxRows)

Returns: RowsResult

Reads a page of rows starting at the given row, discarding any progress status. Delegates to the three argument overload with a status callback that does nothing.

ParameterDescription
startthe zero based index of the first row to return
maxRowsthe maximum number of rows to return, or null for no limit

getRows(int start, Integer maxRows, Consumer<String> status)

Returns: RowsResult

Reads a page of rows starting at the given row, reporting progress through the supplied callback. This is the core method every table implementation provides; the other getRows overloads delegate to it.

ParameterDescription
startthe zero based index of the first row to return
maxRowsthe maximum number of rows to return, or null for no limit
statuscallback invoked with progress messages while the rows are being read

getRows(int start, Integer maxRows, Consumer<String> status, Map<String,Object> extraParams)

Returns: RowsResult

Reads a page of rows, optionally taking extra parameters that a specific table implementation can use to filter its results. The default implementation ignores extraParams and reads from row zero rather than the given start; implementations that use extraParams override this method directly.

ParameterDescription
startthe zero based index of the first row to return; not used by the default implementation
maxRowsthe maximum number of rows to return, or null for no limit
statuscallback invoked with progress messages while the rows are being read
extraParamsimplementation specific filter parameters; not used by the default implementation

supportsPagination()

Returns: boolean

Whether this table supports paged reads via the start and maxRows parameters of getRows. A table that returns false always returns its full result set regardless of the paging parameters supplied.


Methods

getHeaders()

Returns: List<String>

This table's column headers: either the static list declared for it, or, if a headers function is declared, that static list extended by calling the function.

getTableId()

Returns: String

This table's unique identifier, as declared for it in the app's controllers.xml.

getDescription()

Returns: String

A short description of what this table shows, as declared for it in the app's controllers.xml.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.