Package com.day.cq.reporting

Interface Report

public interface Report
This interface represents a report (for serverside calculation) as a whole.

  • Method Details

    • calculate

      Data calculate() throws RepositoryException
      Creates the report and returns the data as a result.
      Returns:
      The report's data
      Throws:
      RepositoryException - if calculating data fails due to a repository error

    • getColumnIterator

      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:
      true if any column is grouped

    • getSnapshotDataCols

      Iterator<Column> getSnapshotDataCols()
      Creates an iterator for iterating over the columns to be used for snapshot data.
      Returns:
      Snapshot column iterator

    • getDataRoot

      String getDataRoot()
      Gets the root path of this report (for querying the data).
      Returns:
      Root path of this report; null if no root path is specified for the report

    • cleanup

      void cleanup()
      Cleans up the report after using it.