Wraps one export configuration of a funnel as a Table, so it can be read through the reporting and query engine. An instance is created for each export of each funnel that defines at least one field, when LeadManApp registers its tables via appendTables.
Implements: Table
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Human readable description of this table, naming the funnel it exports leads from and the export configuration used. |
| headers | List<String> | Column header labels for this table, taken directly from the wrapped export's configured field list. |
| tableId | String | Unique id for this table, combining the funnel name and export name so each export of each funnel is distinguishable when tables are looked up via QueryManager.getTable. |
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.
| Parameter | Description |
|---|---|
start | the zero based index of the first row to return |
maxRows | the maximum number of rows to return, or null for no limit |
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.
| Parameter | Description |
|---|---|
start | the zero based index of the first row to return; not used by the default implementation |
maxRows | the maximum number of rows to return, or null for no limit |
status | callback invoked with progress messages while the rows are being read |
extraParams | implementation 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
getTableId()
Returns: String
Unique id for this table, combining the funnel name and export name so each export of each funnel is distinguishable when tables are looked up via QueryManager.getTable.
getDescription()
Returns: String
Human readable description of this table, naming the funnel it exports leads from and the export configuration used.
getHeaders()
Returns: List<String>
Column header labels for this table, taken directly from the wrapped export's configured field list.
getRows(int start, Integer maxRows, Consumer<String> status)
Returns: RowsResult
Reads a page of exported lead rows by delegating to LeadsHelper.doExport, using either the current HTTP request's parameters or the current ReportParams as the filter parameters, depending on which is available. The start parameter is not applied by this implementation; reading always begins at row zero.
| Parameter | Description |
|---|---|
start | the zero based index of the first row to return; not used, reading always starts at row zero |
maxRows | the maximum number of rows to return, or null for no limit |
status | callback invoked with progress messages while the rows are being read |