com.day.crx.statistics.keyword

Class KeywordsReport

java.lang.Object

com.day.crx.statistics.Report

com.day.crx.statistics.keyword.KeywordsReport

public class KeywordsReport
extends Report

KeywordsReport implements a report that returns the paths of all nodes with a given keyword property.

Constructor Summary

Constructors

Constructor and Description
KeywordsReport(String dataPath, String keywordRelPath) Creates a new report.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

KeywordsReport

public KeywordsReport(String dataPath,
                      String keywordRelPath)

Creates a new report.

Parameters:

dataPath - the path where the content is stored. E.g. '/content' or '' (empty String) if the complete workspace should be considered.

keywordRelPath - the relative path of the keyword property.

Method Detail

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:

• Path String of a page.
• Keywords as String[].

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.