Class ReadTask
- java.lang.Object
-
- org.apache.lucene.benchmark.byTask.tasks.PerfTask
-
- org.apache.lucene.benchmark.byTask.tasks.ReadTask
-
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
SearchTask,SearchTravTask,SearchWithSortTask,WarmTask
public abstract class ReadTask extends PerfTask
Read index (abstract) task. Sub classes implement withSearch(), withWarm(), withTraverse() and withRetrieve() methods to configure the actual action.Note: All ReadTasks reuse the reader if it is already open. Otherwise a reader is opened at start and closed at the end.
The
search.num.hitsconfig parameter sets the top number of hits to collect during searching. Ifprint.hits.fieldis set, then each hit is printed along with the value of that field.Other side effects: none.
-
-
Constructor Summary
Constructors Constructor Description ReadTask(PerfRunData runData)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected CollectorcreateCollector()intdoLogic()Perform the task once (ignoring repetitions specification) Return number of work items done by this task.abstract QueryMakergetQueryMaker()Return query maker used for this task.protected SortgetSort()intnumHits()Specify the number of hits to retrieve.protected DocumentretrieveDoc(StoredFields storedFields, int id)voidsetup()Task setup work that should not be measured for that specific task.inttraversalSize()Specify the number of hits to traverse.booleanwithCollector()abstract booleanwithRetrieve()Return true if, with search and results traversing, docs should be retrieved.abstract booleanwithSearch()Return true if search should be performed.protected intwithTopDocs(IndexSearcher searcher, Query q, TopDocs hits)booleanwithTotalHits()Whether totalHits should be computed (only useful with field sort)abstract booleanwithTraverse()Return true if, with search, results should be traversed.abstract booleanwithWarm()Return true if warming should be performed.-
Methods inherited from class org.apache.lucene.benchmark.byTask.tasks.PerfTask
clone, close, getAlgLineNum, getBackgroundDeltaPriority, getDepth, getLogMessage, getName, getParams, getRunData, getRunInBackground, isDisableCounting, runAndMaybeStats, setAlgLineNum, setDepth, setDisableCounting, setName, setParams, setRunInBackground, shouldNeverLogAtStart, shouldNotRecordStats, stopNow, supportsParams, tearDown, toString
-
-
-
-
Constructor Detail
-
ReadTask
public ReadTask(PerfRunData runData)
-
-
Method Detail
-
doLogic
public int doLogic() throws ExceptionDescription copied from class:PerfTaskPerform the task once (ignoring repetitions specification) Return number of work items done by this task. For indexing that can be number of docs added. For warming that can be number of scanned items, etc.
-
withTopDocs
protected int withTopDocs(IndexSearcher searcher, Query q, TopDocs hits) throws Exception
- Throws:
Exception
-
retrieveDoc
protected Document retrieveDoc(StoredFields storedFields, int id) throws IOException
- Throws:
IOException
-
getQueryMaker
public abstract QueryMaker getQueryMaker()
Return query maker used for this task.
-
withSearch
public abstract boolean withSearch()
Return true if search should be performed.
-
withCollector
public boolean withCollector()
-
withWarm
public abstract boolean withWarm()
Return true if warming should be performed.
-
withTraverse
public abstract boolean withTraverse()
Return true if, with search, results should be traversed.
-
withTotalHits
public boolean withTotalHits()
Whether totalHits should be computed (only useful with field sort)
-
traversalSize
public int traversalSize()
Specify the number of hits to traverse. Tasks should override this if they want to restrict the number of hits that are traversed whenwithTraverse()is true. Must be greater than 0.Read task calculates the traversal as: Math.min(hits.length(), traversalSize())
- Returns:
- Integer.MAX_VALUE
-
setup
public void setup() throws ExceptionDescription copied from class:PerfTaskTask setup work that should not be measured for that specific task. By default it does nothing, but tasks can implement this, moving work fromPerfTask.doLogic()to this method. Only the work done inPerfTask.doLogic()is measured for this task. Notice that higher level (sequence) tasks containing this task would then measure larger time than the sum of their contained tasks.
-
numHits
public int numHits()
Specify the number of hits to retrieve. Tasks should override this if they want to restrict the number of hits that are collected during searching. Must be greater than 0.- Returns:
- 10 by default, or search.num.hits config if set.
-
withRetrieve
public abstract boolean withRetrieve()
Return true if, with search and results traversing, docs should be retrieved.
-
getSort
protected Sort getSort()
-
-