Class AddDocTask

Add a document, optionally of a certain size.

Other side effects: none.

Takes optional param: document size.
Inheritance
object
PerfTask
AddDocTask
AddFacetedDocTask
Implements
Inherited Members
Namespace: Lucene.Net.Benchmarks.ByTask.Tasks
Assembly: Lucene.Net.Benchmark.dll
Syntax
public class AddDocTask : PerfTask, IDisposable

Constructors

AddDocTask(PerfRunData)

Add a document, optionally of a certain size.

Other side effects: none.

Takes optional param: document size.
Declaration
public AddDocTask(PerfRunData runData)
Parameters
Type Name Description
PerfRunData runData

Fields

m_doc

Volatile data passed between Setup(), DoLogic(), TearDown(). The doc is created at Setup() and added at DoLogic().

Declaration
protected Document m_doc
Field Value
Type Description
Document

Properties

SupportsParams

Add a document, optionally of a certain size.

Other side effects: none.

Takes optional param: document size.
Declaration
public override bool SupportsParams { get; }
Property Value
Type Description
bool
Overrides
See Also

Methods

DoLogic()

Perform the task once (ignoring repetitions specification). Return number of work items done by this task. For indexing that can be number of docs added. For warming that can be number of scanned items, etc.

Declaration
public override int DoLogic()
Returns
Type Description
int

Number of work items done by this task.
Overrides

GetLogMessage(int)

Add a document, optionally of a certain size.

Other side effects: none.

Takes optional param: document size.
Declaration
protected override string GetLogMessage(int recsCount)
Parameters
Type Name Description
int recsCount
Returns
Type Description
string
Overrides

SetParams(string)

Set the params (docSize only).

Declaration
public override void SetParams(string @params)
Parameters
Type Name Description
string params

docSize, or 0 for no limit.
Overrides

Setup()

Task setup work that should not be measured for that specific task. By default it does nothing, but tasks can implement this, moving work from DoLogic() to this method. Only the work done in DoLogic() is measured for this task. Notice that higher level (sequence) tasks containing this task would then measure larger time than the sum of their contained tasks.

Declaration
public override void Setup()
Overrides

TearDown()

Task teardown work that should not be measured for that specific task. By default it does nothing, but tasks can implement this, moving work from DoLogic() to this method. Only the work done in DoLogic() is measured for this task. Notice that higher level (sequence) tasks containing this task would then measure larger time than the sum of their
contained tasks.

Declaration
public override void TearDown()
Overrides

Implements