Class AddIndexesTask
- java.lang.Object
-
- org.apache.lucene.benchmark.byTask.tasks.PerfTask
-
- org.apache.lucene.benchmark.byTask.tasks.AddIndexesTask
-
- All Implemented Interfaces:
Cloneable
public class AddIndexesTask extends PerfTask
Adds an input index to an existing index, usingIndexWriter.addIndexes(Directory...)orIndexWriter.addIndexes(CodecReader...). The location of the input index is specified by the parameterADDINDEXES_INPUT_DIRand is assumed to be a directory on the file system.Takes optional parameter
useAddIndexesDirwhich specifies which addIndexes variant to use (defaults to true, to use addIndexes(Directory)).
-
-
Constructor Summary
Constructors Constructor Description AddIndexesTask(PerfRunData runData)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intdoLogic()Perform the task once (ignoring repetitions specification) Return number of work items done by this task.voidsetParams(String params)Set the params (useAddIndexesDir only)voidsetup()Task setup work that should not be measured for that specific task.booleansupportsParams()Sub classes that support parameters must override this method to return true.voidtearDown()Task tearDown work that should not be measured for that specific task.-
Methods inherited from class org.apache.lucene.benchmark.byTask.tasks.PerfTask
clone, close, getAlgLineNum, getBackgroundDeltaPriority, getDepth, getLogMessage, getName, getParams, getRunData, getRunInBackground, isDisableCounting, runAndMaybeStats, setAlgLineNum, setDepth, setDisableCounting, setName, setRunInBackground, shouldNeverLogAtStart, shouldNotRecordStats, stopNow, toString
-
-
-
-
Field Detail
-
ADDINDEXES_INPUT_DIR
public static final String ADDINDEXES_INPUT_DIR
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AddIndexesTask
public AddIndexesTask(PerfRunData runData)
-
-
Method Detail
-
setup
public void setup() throws ExceptionDescription copied from class:PerfTaskTask setup work that should not be measured for that specific task. By default it does nothing, but tasks can implement this, moving work fromPerfTask.doLogic()to this method. Only the work done inPerfTask.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.
-
doLogic
public int doLogic() throws ExceptionDescription copied from class:PerfTaskPerform 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.
-
setParams
public void setParams(String params)
Set the params (useAddIndexesDir only)- Overrides:
setParamsin classPerfTask- Parameters:
params-useAddIndexesDir=truefor usingIndexWriter.addIndexes(Directory...)orfalsefor usingIndexWriter.addIndexes(CodecReader...). Defaults totrue.
-
supportsParams
public boolean supportsParams()
Description copied from class:PerfTaskSub classes that support parameters must override this method to return true.- Overrides:
supportsParamsin classPerfTask- Returns:
- true iff this task supports command line params.
-
tearDown
public void tearDown() throws ExceptionDescription copied from class:PerfTaskTask tearDown work that should not be measured for that specific task. By default it does nothing, but tasks can implement this, moving work fromPerfTask.doLogic()to this method. Only the work done inPerfTask.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.
-
-