net.objectlab.qalab.ant
Class BuildStatChartTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by net.objectlab.qalab.ant.BuildStatChartTask

public class BuildStatChartTask
extends org.apache.tools.ant.Task

 

Field Summary
 
Fields inherited from class org.apache.tools.ant.Task
description, location, target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
 
Constructor Summary
BuildStatChartTask()
           
 
Method Summary
 void execute()
          Method invoked by the ant or maven framework to execute the action associated with this task.
 java.lang.String getFilePrefix()
           
 int getHeight()
           
 int getMovingAverage()
           
 java.lang.String getSummaryType()
           
 int getWidth()
           
 java.lang.String getXAxisSummaryTitle()
           
 java.lang.String getXAxisTitle()
           
 java.lang.String getYAxisSummaryTitle()
           
 java.lang.String getYAxisTitle()
           
 boolean isSummaryOnly()
           
 void setFilePrefix(java.lang.String prefix)
           
 void setHeight(int chartHeight)
          set the chart height in pixels.
 void setInputFile(java.io.File statisticsFile)
          Sets the base file (qalab.xml).
 void setMovingAverage(int aMovingAverage)
          Set the number of points taken to form the moving average line, no moving average line will be created if value <=0.
 void setQuiet(boolean beQuiet)
          Sets the quiet mode.
 void setSummaryOnly(boolean onlySummary)
          set the boolean summary only, if true, only a summary chart will be generated.
 void setSummaryType(java.lang.String theSummaryType)
           
 void setToDir(java.io.File targetDirectory)
          Set the to directory where to output the charts.
 void setType(java.lang.String statisticsType)
           
 void setWidth(int chartWidth)
          set the chart width in pixels.
 void setXAxisSummaryTitle(java.lang.String axisSummaryTitle)
           
 void setXAxisTitle(java.lang.String axisTitle)
           
 void setYAxisSummaryTitle(java.lang.String axisSummaryTitle)
           
 void setYAxisTitle(java.lang.String axisTitle)
           
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject, setProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BuildStatChartTask

public BuildStatChartTask()
Method Detail

execute

public final void execute()
Method invoked by the ant or maven framework to execute the action associated with this task.

Overrides:
execute in class org.apache.tools.ant.Task

setType

public final void setType(java.lang.String statisticsType)
Parameters:
statisticsType - the statistics type to take into account.

setInputFile

public final void setInputFile(java.io.File statisticsFile)
Sets the base file (qalab.xml).

Parameters:
statisticsFile - the qalab.xml

setToDir

public final void setToDir(java.io.File targetDirectory)
Set the to directory where to output the charts.

Parameters:
targetDirectory - the destination directory where the charts are written. The directory will be created if it does not exist.

setQuiet

public final void setQuiet(boolean beQuiet)
Sets the quiet mode.

Parameters:
beQuiet - if true, no messages are displayed while generating charts.

getWidth

public final int getWidth()
Returns:
the chart width in pixels.

setWidth

public final void setWidth(int chartWidth)
set the chart width in pixels.

Parameters:
chartWidth - number of pixels.

getHeight

public final int getHeight()
Returns:
the chart height in pixels.

setHeight

public final void setHeight(int chartHeight)
set the chart height in pixels.

Parameters:
chartHeight - number of pixels.

getMovingAverage

public final int getMovingAverage()
Returns:
number of points taken for form the moving average line.

setMovingAverage

public final void setMovingAverage(int aMovingAverage)
Set the number of points taken to form the moving average line, no moving average line will be created if value <=0.

Parameters:
aMovingAverage - no average if <=0

isSummaryOnly

public final boolean isSummaryOnly()
Returns:
if true, only a summary chart will be generated (default).

setSummaryOnly

public final void setSummaryOnly(boolean onlySummary)
set the boolean summary only, if true, only a summary chart will be generated.

Parameters:
onlySummary - true will generate only 1 chart.

getFilePrefix

public final java.lang.String getFilePrefix()
Returns:
Returns the filePrefix.

setFilePrefix

public final void setFilePrefix(java.lang.String prefix)
Parameters:
prefix - The filePrefix to set.

getSummaryType

public java.lang.String getSummaryType()
Returns:
Returns the summaryType.

setSummaryType

public void setSummaryType(java.lang.String theSummaryType)
Parameters:
theSummaryType - The summaryType to set.

getXAxisSummaryTitle

public java.lang.String getXAxisSummaryTitle()
Returns:
Returns the xAxisSummaryTitle.

setXAxisSummaryTitle

public void setXAxisSummaryTitle(java.lang.String axisSummaryTitle)
Parameters:
axisSummaryTitle - The xAxisSummaryTitle to set.

getXAxisTitle

public java.lang.String getXAxisTitle()
Returns:
Returns the xAxisTitle.

setXAxisTitle

public void setXAxisTitle(java.lang.String axisTitle)
Parameters:
axisTitle - The xAxisTitle to set.

getYAxisSummaryTitle

public java.lang.String getYAxisSummaryTitle()
Returns:
Returns the yAxisSummaryTitle.

setYAxisSummaryTitle

public void setYAxisSummaryTitle(java.lang.String axisSummaryTitle)
Parameters:
axisSummaryTitle - The yAxisSummaryTitle to set.

getYAxisTitle

public java.lang.String getYAxisTitle()
Returns:
Returns the yAxisTitle.

setYAxisTitle

public void setYAxisTitle(java.lang.String axisTitle)
Parameters:
axisTitle - The yAxisTitle to set.