Class SearchTravTask
Search and Traverse task.
Inheritance
Implements
Inherited Members
Namespace: Lucene.Net.Benchmarks.ByTask.Tasks
Assembly: Lucene.Net.Benchmark.dll
Syntax
public class SearchTravTask : ReadTask, IDisposableRemarks
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: traversal size (otherwise all results are traversed). Other side effects: counts additional 1 (record) for each traversed hit.Constructors
SearchTravTask(PerfRunData)
Search and Traverse task.
Declaration
public SearchTravTask(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: traversal size (otherwise all results are traversed). Other side effects: counts additional 1 (record) for each traversed hit.Fields
m_traversalSize
Search and Traverse task.
Declaration
protected int m_traversalSizeField Value
| Type | Description |
|---|---|
| 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: traversal size (otherwise all results are traversed). Other side effects: counts additional 1 (record) for each traversed hit.Properties
SupportsParams
Search and Traverse task.
Declaration
public override bool SupportsParams { 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.
Takes optional param: traversal size (otherwise all results are traversed). Other side effects: counts additional 1 (record) for each traversed hit.See Also
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 true. Must be greater than 0.
Math.Min(hits.Length, TraversalSize)
Declaration
public override int TraversalSize { get; }Property Value
| Type | Description |
|---|---|
| int |
Overrides
Remarks
Unless overridden, the return value is MaxValue.
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.
Takes optional param: traversal size (otherwise all results are traversed). Other side effects: counts additional 1 (record) for each traversed hit.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.
Takes optional param: traversal size (otherwise all results are traversed). Other side effects: counts additional 1 (record) for each traversed hit.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.
Takes optional param: traversal size (otherwise all results are traversed). Other side effects: counts additional 1 (record) for each traversed hit.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.
Takes optional param: traversal size (otherwise all results are traversed). Other side effects: counts additional 1 (record) for each traversed hit.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.
Takes optional param: traversal size (otherwise all results are traversed). Other side effects: counts additional 1 (record) for each traversed hit.SetParams(string)
Set the params of this task.
Declaration
public override void SetParams(string @params)Parameters
| Type | Name | Description |
|---|---|---|
| string | params |
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.
Takes optional param: traversal size (otherwise all results are traversed). Other side effects: counts additional 1 (record) for each traversed hit.Exceptions
| Type | Condition |
|---|---|
| NotSupportedException | For tasks supporting command line parameters. |