Package com.day.cq.reporting
Interface Report
-
public interface ReportThis interface represents a report (for serverside calculation) as a whole.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Datacalculate()Creates the report and returns the data as a result.voidcleanup()Cleans up the report after using it.intgetColumnCnt()Returns the number of columns.java.util.Iterator<Column>getColumnIterator()Creates an iterator for iterating over the report's columns.java.lang.StringgetDataRoot()Gets the root path of this report (for querying the data).java.util.Iterator<Column>getSnapshotDataCols()Creates an iterator for iterating over the columns to be used for snapshot data.booleanhasGroupedColumns()Returns if any group is grouped.
-
-
-
Method Detail
-
calculate
Data calculate() throws javax.jcr.RepositoryException
Creates the report and returns the data as a result.- Returns:
- The report's data
- Throws:
javax.jcr.RepositoryException- if calculating data fails due to a repository error
-
getColumnIterator
java.util.Iterator<Column> getColumnIterator()
Creates an iterator for iterating over the report's columns.- Returns:
- Column iterator
-
getColumnCnt
int getColumnCnt()
Returns the number of columns.- Returns:
- Number of columns
-
hasGroupedColumns
boolean hasGroupedColumns()
Returns if any group is grouped.- Returns:
trueif any column is grouped
-
getSnapshotDataCols
java.util.Iterator<Column> getSnapshotDataCols()
Creates an iterator for iterating over the columns to be used for snapshot data.- Returns:
- Snapshot column iterator
-
getDataRoot
java.lang.String getDataRoot()
Gets the root path of this report (for querying the data).- Returns:
- Root path of this report;
nullif no root path is specified for the report
-
cleanup
void cleanup()
Cleans up the report after using it.
-
-