Class ReadTask
Read index (abstract) task. Sub classes implement WithSearch, WithWarm, WithTraverse and WithRetrieve
Inherited Members
Assembly: Lucene.Net.Benchmark.dll
Syntax
public abstract class ReadTask : PerfTaskRemarks
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.hits config parameter sets
the top number of hits to collect during searching. If
print.hits.field is set, then each hit is
printed along with the value of that field.
Other side effects: none.
Constructors
| Name | Description |
|---|---|
| ReadTask(PerfRunData) |
Properties
| Name | Description |
|---|---|
| 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 |
| NumToHighlight | The number of documents to highlight. 0 means no docs will be highlighted. |
| Sort | |
| TraversalSize | Specify the number of hits to traverse. Tasks should override this if they want to restrict the number
of hits that are traversed when WithTraverse is
Read task calculates the traversal as: |
| WithCollector | |
| WithMaxScore | Whether maxScores should be computed (only useful with field sort) |
| WithRetrieve | Return |
| WithScore | Whether scores should be computed (only useful with field sort) |
| WithSearch | Return |
| WithTraverse | Return |
| WithWarm | Return |
Methods
| Name | Description |
|---|---|
| CreateCollector() | |
| DoLogic() | |
| GetBenchmarkHighlighter(Query) | Return an appropriate highlighter to be used with highlighting tasks. |
| GetFieldsToHighlight(Document) | Define the fields to highlight. Base implementation returns all fields. |
| GetQueryMaker() | Return query maker used for this task. |
| RetrieveDoc(IndexReader, Int32) | |
| Setup() |
