Package com.day.crx.statistics.result

Class ResultsByQueryReport

java.lang.Object

com.day.crx.statistics.Report

com.day.crx.statistics.result.ResultsByQueryReport

public class ResultsByQueryReport
extends Report

ResultsByQueryReport implements a report, which returns the result pages that were selected the most for a given query. This report operates on the daily statistics nodes.

Constructor Summary

Constructors

Constructor	Description
ResultsByQueryReport(String dataPath, String query)	Creates a new report.
ResultsByQueryReport(String dataPath, String query, boolean traversalOk)	Creates a new report.

Method Summary

Modifier and Type	Method	Description
Iterator	getResult(Session session)	Runs the report and returns a result iterator over Object[] instances.
int	getSize()
void	setSize(int size)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ResultsByQueryReport

public ResultsByQueryReport(String dataPath,
 String query)

Creates a new report.

Parameters:

dataPath - the path prefix to the data.

query - the user query.

ResultsByQueryReport

public ResultsByQueryReport(String dataPath,
 String query,
 boolean traversalOk)

Creates a new report.

Parameters:

dataPath - the path prefix to the data.

query - the user query.

traversalOk - set to true to put "traveral ok" option in the statistics query

Method Details

getResult

public Iterator getResult(Session session)
                   throws RepositoryException

Runs the report and returns a result iterator over Object[] instances.

Returns result rows with the following objects:

• String path of a result path
• Long count (how many times this result was picked)

Specified by:

getResult in class Report

Parameters:

session - the session giving access to the workspace.

Returns:

Iterator over Object results.

Throws:

RepositoryException - if an error occurs while reading from the repository.

getSize

public int getSize()

Returns:

the maximum number of results to return.

setSize

public void setSize(int size)

Parameters:

size - the maximum number of results to return.