Class SearchTravRetVectorHighlightTask

Search and Traverse and Retrieve docs task. Highlight the fields in the retrieved documents by using FastVectorHighlighter.

Inheritance
System.Object
PerfTask
ReadTask
SearchTravTask
SearchTravRetVectorHighlightTask
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Benchmarks.ByTask.Tasks
Assembly: Lucene.Net.Benchmark.dll
Syntax
public class SearchTravRetVectorHighlightTask : SearchTravTask, IDisposable
Remarks

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 sizeThe number of hits to traverse, otherwise all will be traversed.
  • highlightThe number of the hits to highlight. Will always be less than or equal to traversal size. Default is System.Int32.MaxValue (i.e. hits.Length).
  • maxFragsThe maximum number of fragments to score by the highlighter.
  • fragSizeThe length of fragments.
  • fieldsThe fields to highlight. If not specified all fields will be highlighted (or at least attempted).

Example:

"SearchVecHlgtSameRdr" SearchTravRetVectorHighlight(size[10],highlight[10],maxFrags[3],fields[body]) > : 1000

Fields must be stored and term vector offsets and positions in order must be true for this task to work.

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

| Improve this Doc View Source

SearchTravRetVectorHighlightTask(PerfRunData)

Declaration
public SearchTravRetVectorHighlightTask(PerfRunData runData)
Parameters
Type Name Description
PerfRunData runData

Fields

| Improve this Doc View Source

m_fragSize

Declaration
protected int m_fragSize
Field Value
Type Description
System.Int32
| Improve this Doc View Source

m_highlighter

Declaration
protected FastVectorHighlighter m_highlighter
Field Value
Type Description
FastVectorHighlighter
| Improve this Doc View Source

m_maxFrags

Declaration
protected int m_maxFrags
Field Value
Type Description
System.Int32
| Improve this Doc View Source

m_numToHighlight

Declaration
protected int m_numToHighlight
Field Value
Type Description
System.Int32
| Improve this Doc View Source

m_paramFields

Declaration
protected ISet<string> m_paramFields
Field Value
Type Description
System.Collections.Generic.ISet<System.String>

Properties

| Improve this Doc View Source

NumToHighlight

Declaration
public override int NumToHighlight { get; }
Property Value
Type Description
System.Int32
Overrides
| Improve this Doc View Source

WithRetrieve

Declaration
public override bool WithRetrieve { get; }
Property Value
Type Description
System.Boolean
Overrides

Methods

| Improve this Doc View Source

GetBenchmarkHighlighter(Query)

Declaration
protected override BenchmarkHighlighter GetBenchmarkHighlighter(Query q)
Parameters
Type Name Description
Query q
Returns
Type Description
BenchmarkHighlighter
Overrides
| Improve this Doc View Source

GetFieldsToHighlight(Document)

Declaration
protected override ICollection<string> GetFieldsToHighlight(Document document)
Parameters
Type Name Description
Document document
Returns
Type Description
System.Collections.Generic.ICollection<System.String>
Overrides
| Improve this Doc View Source

SetParams(String)

Declaration
public override void SetParams(string params)
Parameters
Type Name Description
System.String params
Overrides
| Improve this Doc View Source

Setup()

Declaration
public override void Setup()
Overrides

Implements

System.IDisposable