public interface Column
Modifier and Type | Method and Description |
---|---|
void |
cleanup()
Cleans up the column after using it.
|
void |
endProcessing()
Ends the postprocessing of data.
|
java.lang.String |
getActualType()
Returns the column's actual type for the current report setting.
|
java.lang.String |
getAggregateType()
Returns the aggregate type defined for the column.
|
QueryEngineConfig |
getColumnDef()
Get the query engine-specific column definitions.
|
java.lang.String |
getColumnType()
Returns the column's data type.
|
java.lang.String |
getName()
Gets the name of this instance of the column.
|
java.lang.String |
getPath()
Gets the path of this instance of the column.
|
Sorting |
getSorting()
Returns the sorting defined for the column.
|
java.lang.String |
getTitle()
Gets the title of this instance of the column.
|
boolean |
isGrouped()
Checks if the column is currently grouped.
|
boolean |
matchesFilter(FilteringPhase phase,
DataRow rowToCheck)
Checks if the specified
DataRow matches the current filter settings |
CellValue |
preprocessData(ProcessingPhase type,
DataRow row,
boolean isAggregated,
boolean isReportGrouped)
Preprocesses the specified data row.
|
void |
resolve(Session session,
DataRow rowToResolve)
Resolves the column's value in the specified row if applicable.
|
void |
startProcessing()
Starts the postprocessing of data.
|
java.lang.String getPath()
java.lang.String getName()
java.lang.String getTitle()
java.lang.String getColumnType()
java.lang.String getActualType()
Returns the column's actual type for the current report setting.
Contrary to getColumnType()
, this method considers aggregation state.
The returned value must be supported by the clientside reporting implementation.
See DisplayDataType
for a list of officially
supported display types. Note that there might be more supported types (which is why
a String
is returned rather than a DisplayDataType
).
QueryEngineConfig getColumnDef()
boolean isGrouped()
true
if the column is groupedjava.lang.String getAggregateType()
Sorting getSorting()
void startProcessing()
void endProcessing()
CellValue preprocessData(ProcessingPhase type, DataRow row, boolean isAggregated, boolean isReportGrouped)
Preprocesses the specified data row.
If required by the type
parameter (for example for
ProcessingPhase.APPLY
), the preprocessed data gets changed in the
DataRow
specified.
type
- Type of preprocessing to be executedrow
- The row to be preprocessedisAggregated
- true
if the preprocessing is executed for
the aggregated column value (if the column actually represents
an aggregated value)isReportGrouped
- true
if the report as a whole is groupedvoid resolve(Session session, DataRow rowToResolve) throws RepositoryException
Resolves the column's value in the specified row if applicable.
The resolved value must be set in the row.
session
- JCR Session used for resolvingrowToResolve
- The rowRepositoryException
- if resolving the value has failed due to a repository
problemboolean matchesFilter(FilteringPhase phase, DataRow rowToCheck)
DataRow
matches the current filter settingsphase
- The current filtering phaserowToCheck
- The row to be checked against the filtertrue
if the row matches the filter and should be kept in the
result setvoid cleanup()
Copyright © 2010 - 2020 Adobe. All Rights Reserved