Package com.day.crx.statistics.keyword

Class 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 Description
      KeywordsReport​(java.lang.String dataPath, java.lang.String keywordRelPath)
      Creates a new report.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.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​(java.lang.String dataPath,
                      java.lang.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 java.util.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.