|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.benchmark.byTask.tasks.PerfTask
public abstract class PerfTask
An abstract task to be tested for performance.
Every performance task extends this class, and provides its own
doLogic()
method, which performs the actual task.
Tasks performing some work that should be measured for the task, can override
setup()
and/or tearDown()
and place that work there.
Relevant properties: task.max.depth.log
.
Also supports the following logging attributes:
doLogic()
invocations. Set to -1 to disable
logging.
AddDocTask
, but not for DeleteDocTask
. It's a way to control
per task logging settings. If you want to omit logging for any other task,
include log.step=-1. The syntax is "log.step." together with the Task's
'short' name (i.e., without the 'Task' part).
Field Summary | |
---|---|
protected int |
logStep
|
protected static java.lang.String |
NEW_LINE
|
protected java.lang.String |
params
|
Constructor Summary | |
---|---|
PerfTask(PerfRunData runData)
|
Method Summary | |
---|---|
protected java.lang.Object |
clone()
|
void |
close()
|
abstract int |
doLogic()
Perform the task once (ignoring repetitions specification) Return number of work items done by this task. |
int |
getDepth()
|
protected java.lang.String |
getLogMessage(int recsCount)
|
java.lang.String |
getName()
|
java.lang.String |
getParams()
|
PerfRunData |
getRunData()
|
boolean |
isDisableCounting()
Return true if counting is disabled for this task. |
int |
runAndMaybeStats(boolean reportStats)
Run the task, record statistics. |
void |
setDepth(int depth)
|
void |
setDisableCounting(boolean disableCounting)
See isDisableCounting() |
protected void |
setName(java.lang.String name)
|
void |
setParams(java.lang.String params)
Set the params of this task. |
void |
setup()
Task setup work that should not be measured for that specific task. |
protected boolean |
shouldNeverLogAtStart()
Tasks that should never log at start can override this. |
protected boolean |
shouldNotRecordStats()
Tasks that should not record statistics can override this. |
boolean |
supportsParams()
Sub classes that supports parameters must override this method to return true. |
void |
tearDown()
Task tearDown work that should not be measured for that specific task. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected int logStep
protected java.lang.String params
protected static final java.lang.String NEW_LINE
Constructor Detail |
---|
public PerfTask(PerfRunData runData)
Method Detail |
---|
protected java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public void close() throws java.lang.Exception
java.lang.Exception
public final int runAndMaybeStats(boolean reportStats) throws java.lang.Exception
java.lang.Exception
public abstract int doLogic() throws java.lang.Exception
java.lang.Exception
public java.lang.String getName()
protected void setName(java.lang.String name)
name
- The name to set.public PerfRunData getRunData()
public int getDepth()
public void setDepth(int depth)
depth
- The depth to set.public java.lang.String toString()
toString
in class java.lang.Object
protected java.lang.String getLogMessage(int recsCount)
protected boolean shouldNeverLogAtStart()
protected boolean shouldNotRecordStats()
public void setup() throws java.lang.Exception
java.lang.Exception
public void tearDown() throws java.lang.Exception
java.lang.Exception
public boolean supportsParams()
public void setParams(java.lang.String params)
java.lang.UnsupportedOperationException
- for tasks supporting command line parameters.public java.lang.String getParams()
public boolean isDisableCounting()
public void setDisableCounting(boolean disableCounting)
isDisableCounting()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |