Class SearchTravTask

  • All Implemented Interfaces:
    Direct Known Subclasses:
    SearchTravRetHighlightTask, SearchTravRetLoadFieldSelectorTask, SearchTravRetTask

    public class SearchTravTask
    extends ReadTask
    Search and Traverse task.

    Note: This task reuses the reader if it is already open. Otherwise a reader is opened at start and closed at the end.

    Takes optional param: traversal size (otherwise all results are traversed).

    Other side effects: counts additional 1 (record) for each traversed hit.

    • Field Detail

      • traversalSize

        protected int traversalSize
    • Constructor Detail

      • SearchTravTask

        public SearchTravTask​(PerfRunData runData)
    • Method Detail

      • withRetrieve

        public boolean withRetrieve()
        Description copied from class: ReadTask
        Return true if, with search and results traversing, docs should be retrieved.
        Specified by:
        withRetrieve in class ReadTask
      • withSearch

        public boolean withSearch()
        Description copied from class: ReadTask
        Return true if search should be performed.
        Specified by:
        withSearch in class ReadTask
      • withTraverse

        public boolean withTraverse()
        Description copied from class: ReadTask
        Return true if, with search, results should be traversed.
        Specified by:
        withTraverse in class ReadTask
      • withWarm

        public boolean withWarm()
        Description copied from class: ReadTask
        Return true if warming should be performed.
        Specified by:
        withWarm in class ReadTask
      • traversalSize

        public int traversalSize()
        Description copied from class: ReadTask
        Specify the number of hits to traverse. Tasks should override this if they want to restrict the number of hits that are traversed when ReadTask.withTraverse() is true. Must be greater than 0.

        Read task calculates the traversal as: Math.min(hits.length(), traversalSize())

        traversalSize in class ReadTask
      • setParams

        public void setParams​(String params)
        Description copied from class: PerfTask
        Set the params of this task.
        setParams in class PerfTask
      • supportsParams

        public boolean supportsParams()
        Description copied from class: PerfTask
        Sub classes that support parameters must override this method to return true.
        supportsParams in class PerfTask
        true iff this task supports command line params.