Class SearchTravRetLoadFieldSelectorTask

Search and Traverse and Retrieve docs task using a FieldVisitor loading only the requested fields.

Inheritance

object

PerfTask

ReadTask

SearchTravTask

SearchTravRetLoadFieldSelectorTask

Implements

IDisposable

Inherited Members

SearchTravTask.m_traversalSize

SearchTravTask.WithSearch

SearchTravTask.WithTraverse

SearchTravTask.WithWarm

SearchTravTask.GetQueryMaker()

SearchTravTask.TraversalSize

ReadTask.DoLogic()

ReadTask.CreateCollector()

ReadTask.WithCollector

ReadTask.WithScore

ReadTask.WithMaxScore

ReadTask.Setup()

ReadTask.NumHits

ReadTask.NumToHighlight

ReadTask.GetBenchmarkHighlighter(Query)

ReadTask.Sort

ReadTask.GetFieldsToHighlight(Document)

PerfTask.m_logStep

PerfTask.m_params

PerfTask.NEW_LINE

PerfTask.SetRunInBackground(int)

PerfTask.RunInBackground

PerfTask.BackgroundDeltaPriority

PerfTask.Stop

PerfTask.StopNow()

PerfTask.Clone()

PerfTask.Dispose()

PerfTask.Dispose(bool)

PerfTask.RunAndMaybeStats(bool)

PerfTask.GetName()

PerfTask.SetName(string)

PerfTask.RunData

PerfTask.Depth

PerfTask.ToString()

PerfTask.GetLogMessage(int)

PerfTask.ShouldNeverLogAtStart

PerfTask.ShouldNotRecordStats

PerfTask.TearDown()

PerfTask.Params

PerfTask.DisableCounting

PerfTask.AlgLineNum

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Benchmarks.ByTask.Tasks

Assembly: Lucene.Net.Benchmark.dll

Syntax

public class SearchTravRetLoadFieldSelectorTask : 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 param: comma separated list of Fields to load.

Other side effects: counts additional 1 (record) for each traversed hit, and 1 more for each retrieved (non null) document.

Constructors

SearchTravRetLoadFieldSelectorTask(PerfRunData)

Search and Traverse and Retrieve docs task using a FieldVisitor loading only the requested fields.

Declaration

public SearchTravRetLoadFieldSelectorTask(PerfRunData runData)

Parameters

Type	Name	Description
PerfRunData	runData

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 param: comma separated list of Fields to load.

Other side effects: counts additional 1 (record) for each traversed hit, and 1 more for each retrieved (non null) document.

Fields

m_fieldsToLoad

Search and Traverse and Retrieve docs task using a FieldVisitor loading only the requested fields.

Declaration

protected ISet<string> m_fieldsToLoad

Field Value

Type	Description
ISet<string>

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 param: comma separated list of Fields to load.

Other side effects: counts additional 1 (record) for each traversed hit, and 1 more for each retrieved (non null) document.

Properties

SupportsParams

Search and Traverse and Retrieve docs task using a FieldVisitor loading only the requested fields.

Declaration

public override bool SupportsParams { get; }

Property Value

Type	Description
bool

Overrides

SearchTravTask.SupportsParams

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 param: comma separated list of Fields to load.

Other side effects: counts additional 1 (record) for each traversed hit, and 1 more for each retrieved (non null) document.

See Also

SupportsParams

WithRetrieve

Return true if, with search & results traversing, docs should be retrieved.

Declaration

public override bool WithRetrieve { get; }

Property Value

Type	Description
bool

Overrides

SearchTravTask.WithRetrieve

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 param: comma separated list of Fields to load.

Other side effects: counts additional 1 (record) for each traversed hit, and 1 more for each retrieved (non null) document.

Methods

RetrieveDoc(IndexReader, int)

Search and Traverse and Retrieve docs task using a FieldVisitor loading only the requested fields.

Declaration

protected override Document RetrieveDoc(IndexReader ir, int id)

Parameters

Type	Name	Description
IndexReader	ir
int	id

Returns

Type	Description
Document

Overrides

ReadTask.RetrieveDoc(IndexReader, int)

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 param: comma separated list of Fields to load.

Other side effects: counts additional 1 (record) for each traversed hit, and 1 more for each retrieved (non null) document.

SetParams(string)

Set the params of this task.

Declaration

public override void SetParams(string @params)

Parameters

Type	Name	Description
string	params

Overrides

SearchTravTask.SetParams(string)

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 param: comma separated list of Fields to load.

Other side effects: counts additional 1 (record) for each traversed hit, and 1 more for each retrieved (non null) document.

Exceptions

Type	Condition
NotSupportedException	For tasks supporting command line parameters.

Implements

IDisposable