org.apache.lucene.benchmark.byTask.tasks

Class AddDocTask

Implemented Interfaces:
Cloneable

public class AddDocTask
extends PerfTask

Add a document, optionally with of a cetrain size. Other side effects: none.

Field Summary

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

NEW_LINE, params

Constructor Summary

AddDocTask(PerfRunData runData)

Method Summary

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.
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, doLogic, getDepth, getName, getParams, getRunData, runAndMaybeStats, setDepth, setName, setParams, setup, shouldNeverLogAtStart, shouldNotRecordStats, tearDown, toString

Constructor Details

AddDocTask

public AddDocTask(PerfRunData runData)

Method Details

doLogic

public int doLogic()
            throws Exception
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.
Overrides:
doLogic in interface PerfTask
Returns:
number of work items done by this task.

setParams

public void setParams(String params)
Set the params (docSize only)
Overrides:
setParams in interface PerfTask
Parameters:
params - docSize, or 0 for no limit.

setup

public void setup()
            throws Exception
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 interface PerfTask

tearDown

public void tearDown()
            throws Exception
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 interface PerfTask

Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.