Class AddIndexesTask
java.lang.Object
org.apache.lucene.benchmark.byTask.tasks.PerfTask
org.apache.lucene.benchmark.byTask.tasks.AddIndexesTask
- All Implemented Interfaces:
Cloneable
Adds an input index to an existing index, using
IndexWriter.addIndexes(Directory...)
or
IndexWriter.addIndexes(CodecReader...)
. The location of the input index is specified by
the parameter ADDINDEXES_INPUT_DIR
and is assumed to be a directory on the file system.
Takes optional parameter useAddIndexesDir
which specifies which addIndexes variant to
use (defaults to true, to use addIndexes(Directory)).
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
doLogic()
Perform the task once (ignoring repetitions specification) Return number of work items done by this task.void
Set the params (useAddIndexesDir only)void
setup()
Task setup work that should not be measured for that specific task.boolean
Sub classes that support parameters must override 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, close, getAlgLineNum, getBackgroundDeltaPriority, getDepth, getLogMessage, getName, getParams, getRunData, getRunInBackground, isDisableCounting, runAndMaybeStats, setAlgLineNum, setDepth, setDisableCounting, setName, setRunInBackground, shouldNeverLogAtStart, shouldNotRecordStats, stopNow, toString
-
Field Details
-
ADDINDEXES_INPUT_DIR
- See Also:
-
-
Constructor Details
-
AddIndexesTask
-
-
Method Details
-
setup
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 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
Description copied from class:PerfTask
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. -
setParams
Set the params (useAddIndexesDir only)- Overrides:
setParams
in classPerfTask
- Parameters:
params
-useAddIndexesDir=true
for usingIndexWriter.addIndexes(Directory...)
orfalse
for usingIndexWriter.addIndexes(CodecReader...)
. Defaults totrue
.
-
supportsParams
public boolean supportsParams()Description copied from class:PerfTask
Sub classes that support parameters must override this method to return true.- Overrides:
supportsParams
in classPerfTask
- Returns:
- true iff this task supports command line params.
-
tearDown
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 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.
-