Class WarmTask
Warm reader task: retrieve all reader documents.
Implements
Inherited Members
Namespace: Lucene.Net.Benchmarks.ByTask.Tasks
Assembly: Lucene.Net.Benchmark.dll
Syntax
public class WarmTask : ReadTask, 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.
Other side effects: counts additional 1 (record) for each retrieved (non null) document.Constructors
WarmTask(PerfRunData)
Warm reader task: retrieve all reader documents.
Declaration
public WarmTask(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.
Other side effects: counts additional 1 (record) for each retrieved (non null) document.Properties
WithRetrieve
Return true
if, with search & results traversing, docs should be retrieved.
Declaration
public override bool WithRetrieve { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
Remarks
Note: This task reuses the reader if it is already open. Otherwise a reader is opened at start and closed at the end.
Other side effects: counts additional 1 (record) for each retrieved (non null) document.WithSearch
Return true
if search should be performed.
Declaration
public override bool WithSearch { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
Remarks
Note: This task reuses the reader if it is already open. Otherwise a reader is opened at start and closed at the end.
Other side effects: counts additional 1 (record) for each retrieved (non null) document.WithTraverse
Return true
if, with search, results should be traversed.
Declaration
public override bool WithTraverse { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
Remarks
Note: This task reuses the reader if it is already open. Otherwise a reader is opened at start and closed at the end.
Other side effects: counts additional 1 (record) for each retrieved (non null) document.WithWarm
Return true
if warming should be performed.
Declaration
public override bool WithWarm { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
Remarks
Note: This task reuses the reader if it is already open. Otherwise a reader is opened at start and closed at the end.
Other side effects: counts additional 1 (record) for each retrieved (non null) document.Methods
GetQueryMaker()
Return query maker used for this task.
Declaration
public override IQueryMaker GetQueryMaker()
Returns
Type | Description |
---|---|
IQueryMaker |
Overrides
Remarks
Note: This task reuses the reader if it is already open. Otherwise a reader is opened at start and closed at the end.
Other side effects: counts additional 1 (record) for each retrieved (non null) document.