org.apache.lucene.benchmark.byTask.tasks

Class AddDocTask

java.lang.Object

org.apache.lucene.benchmark.byTask.tasks.PerfTask

org.apache.lucene.benchmark.byTask.tasks.AddDocTask

All Implemented Interfaces:

Cloneable

public class AddDocTask
extends PerfTask

Add a document, optionally with of a certain size.
Other side effects: none.
Relevant properties: doc.add.log.step.
Takes optional param: document size.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ADD_DOC_LOG_STEP Default value for property doc.add.log.step - indicating how often an "added N docs" message should be logged.

Fields inherited from class org.apache.lucene.benchmark.byTask.tasks.PerfTask

NEW_LINE, params

Constructor Summary

Constructors

Constructor and Description
AddDocTask(PerfRunData runData)

Method Summary

Methods

Modifier and Type	Method and Description
int	doLogic() Perform the task once (ignoring repetions specification) Return number of work items done by this task.
void	setParams(String params) Set the params (docSize only)
void	setup() Task setup work that should not be measured for that specific task.
boolean	supportsParams() Sub classes that supports parameters must overide this method to return true.
void	tearDown() Task tearDown work that should not be measured for that specific task.

Methods inherited from class org.apache.lucene.benchmark.byTask.tasks.PerfTask

clone, getDepth, getName, getParams, getRunData, isDisableCounting, runAndMaybeStats, setDepth, setDisableCounting, setName, shouldNeverLogAtStart, shouldNotRecordStats, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_ADD_DOC_LOG_STEP

public static final int DEFAULT_ADD_DOC_LOG_STEP

Default value for property doc.add.log.step - indicating how often an "added N docs" message should be logged.

See Also:

Constant Field Values

Constructor Detail

AddDocTask

public AddDocTask(PerfRunData runData)

Method Detail

setup

public void setup()
           throws Exception

Description copied from class: PerfTask

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 doLogicis 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.

Overrides:

setup in class PerfTask

Throws:

Exception

tearDown

public void tearDown()
              throws Exception

Description copied from class: PerfTask

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 doLogicis 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.

Overrides:

tearDown in class PerfTask

Throws:

Exception

doLogic

public int doLogic()
            throws Exception

Description copied from class: PerfTask

Perform the task once (ignoring repetions 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.

Specified by:

doLogic in class PerfTask

Returns:

number of work items done by this task.

Throws:

Exception

setParams

public void setParams(String params)

Set the params (docSize only)

Overrides:

setParams in class PerfTask

Parameters:

params - docSize, or 0 for no limit.

supportsParams

public boolean supportsParams()

Description copied from class: PerfTask

Sub classes that supports parameters must overide this method to return true.

Overrides:

supportsParams in class PerfTask

Returns:

true iff this task supports command line params.