org.apache.lucene.benchmark.byTask.tasks
Class ReportTask

java.lang.Object
  extended by org.apache.lucene.benchmark.byTask.tasks.PerfTask
      extended by org.apache.lucene.benchmark.byTask.tasks.ReportTask
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
RepAllTask, RepSumByNameRoundTask, RepSumByNameTask, RepSumByPrefTask

public abstract class ReportTask
extends PerfTask

Report (abstract) task - all report tasks extend this task.


Field Summary
protected static String[] COLS
           
protected static String ELAPSED
           
protected static String newline
           
protected static String OP
          Get a textual summary of the benchmark results, average from all test runs.
protected static String RECCNT
           
protected static String RECSEC
           
protected static String ROUND
           
protected static String RUNCNT
           
protected static String TOTMEM
           
protected static String USEDMEM
           
 
Fields inherited from class org.apache.lucene.benchmark.byTask.tasks.PerfTask
logStep, NEW_LINE, params, stopNow
 
Constructor Summary
ReportTask(PerfRunData runData)
           
 
Method Summary
protected  Report genPartialReport(int reported, LinkedHashMap<String,TaskStats> partOfTasks, int totalSize)
           
protected  String longestOp(Iterable<TaskStats> taskStats)
          find the longest op name out of completed tasks.
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.
protected  String tableTitle(String longestOp)
          Compute a title line for a report table
protected  String taskReportLine(String longestOp, TaskStats stat)
          Compute a report line for the given task stat.
 
Methods inherited from class org.apache.lucene.benchmark.byTask.tasks.PerfTask
clone, close, doLogic, getBackgroundDeltaPriority, getDepth, getLogMessage, getName, getParams, getRunData, getRunInBackground, isDisableCounting, runAndMaybeStats, setDepth, setDisableCounting, setName, setParams, setRunInBackground, setup, stopNow, supportsParams, tearDown, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

newline

protected static final String newline

OP

protected static final String OP
Get a textual summary of the benchmark results, average from all test runs.

See Also:
Constant Field Values

ROUND

protected static final String ROUND
See Also:
Constant Field Values

RUNCNT

protected static final String RUNCNT
See Also:
Constant Field Values

RECCNT

protected static final String RECCNT
See Also:
Constant Field Values

RECSEC

protected static final String RECSEC
See Also:
Constant Field Values

ELAPSED

protected static final String ELAPSED
See Also:
Constant Field Values

USEDMEM

protected static final String USEDMEM
See Also:
Constant Field Values

TOTMEM

protected static final String TOTMEM
See Also:
Constant Field Values

COLS

protected static final String[] COLS
Constructor Detail

ReportTask

public ReportTask(PerfRunData runData)
Method Detail

shouldNeverLogAtStart

protected boolean shouldNeverLogAtStart()
Description copied from class: PerfTask
Tasks that should never log at start can override this.

Overrides:
shouldNeverLogAtStart in class PerfTask
Returns:
true if this task should never log when it start.

shouldNotRecordStats

protected boolean shouldNotRecordStats()
Description copied from class: PerfTask
Tasks that should not record statistics can override this.

Overrides:
shouldNotRecordStats in class PerfTask
Returns:
true if this task should never record its statistics.

tableTitle

protected String tableTitle(String longestOp)
Compute a title line for a report table

Parameters:
longestOp - size of longest op name in the table
Returns:
the table title line.

longestOp

protected String longestOp(Iterable<TaskStats> taskStats)
find the longest op name out of completed tasks.

Parameters:
taskStats - completed tasks to be considered.
Returns:
the longest op name out of completed tasks.

taskReportLine

protected String taskReportLine(String longestOp,
                                TaskStats stat)
Compute a report line for the given task stat.

Parameters:
longestOp - size of longest op name in the table.
stat - task stat to be printed.
Returns:
the report line.

genPartialReport

protected Report genPartialReport(int reported,
                                  LinkedHashMap<String,TaskStats> partOfTasks,
                                  int totalSize)


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