com.day.cq.reporting

Interface QueryEngine

public interface QueryEngine

This interface represents a "query engine" that is used for retrieving the basic result set. The basic result set is later used for providing grouped and filtered report data.

Method Summary

Modifier and Type	Method and Description
QueryEngineConfig	createColumnConfig(javax.jcr.Node colComponent) Creates a suitable QueryEngineConfig object from the given column component node.
void	execute(Report report, Data data, javax.jcr.Session session) Executes the query for the specified report and builds the given Data instance accordingly.

Method Detail

createColumnConfig

QueryEngineConfig createColumnConfig(javax.jcr.Node colComponent)
                              throws javax.jcr.RepositoryException

Creates a suitable QueryEngineConfig object from the given column component node.

Parameters:

colComponent - The column's component node

Returns:

The QueryEngineConfig

Throws:

javax.jcr.RepositoryException - if creating the config failed due to a repository problem

execute

void execute(Report report,
             Data data,
             javax.jcr.Session session)
      throws javax.jcr.RepositoryException

Executes the query for the specified report and builds the given Data instance accordingly.

Note that the report data must be raw (= ungrouped, unfiltered).

Parameters:

report - The report

data - The data object to be filled

session - The session to be used

Throws:

javax.jcr.RepositoryException - if the query fails due to a repository problem