Class SearchTravRetHighlightTask
Search and Traverse and Retrieve docs task. Highlight the fields in the retrieved documents.
Inherited Members
Assembly: Lucene.Net.Benchmark.dll
Syntax
public class SearchTravRetHighlightTask : SearchTravTaskRemarks
Uses the SimpleHTMLFormatter for formatting.
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 multivalued, comma separated param string as:
size[<traversal size>],highlight[<int>],maxFrags[<int>],mergeContiguous[<boolean>],fields[name1;name2;...]| traversal size | The number of hits to traverse, otherwise all will be traversed. |
| highlight | The number of the hits to highlight. Will always be less than or equal to traversal size. Default is |
| maxFrags | The maximum number of fragments to score by the highlighter. |
| mergeContiguous | true if contiguous fragments should be merged. |
| fields | The fields to highlight. If not specified all fields will be highlighted (or at least attempted). |
Example:
"SearchHlgtSameRdr" SearchTravRetHighlight(size[10],highlight[10],mergeContiguous[true],maxFrags[3],fields[body]) > : 1000Documents must be stored in order for this task to work. Additionally, term vector positions can be used as well.
Other side effects: counts additional 1 (record) for each traversed hit, and 1 more for each retrieved (non null) document and 1 for each fragment returned.
Constructors
| Name | Description |
|---|---|
| SearchTravRetHighlightTask(PerfRunData) |
Fields
| Name | Description |
|---|---|
| m_highlighter | |
| m_maxDocCharsToAnalyze | |
| m_maxFrags | |
| m_mergeContiguous | |
| m_numToHighlight | |
| m_paramFields |
Properties
| Name | Description |
|---|---|
| NumToHighlight | |
| WithRetrieve |
Methods
| Name | Description |
|---|---|
| GetBenchmarkHighlighter(Query) | |
| GetFieldsToHighlight(Document) | |
| SetParams(String) | |
| Setup() |
