org.ow2.clif.analyze.api.graph
Interface ChartControl

All Known Implementing Classes:
ChartEngineImpl

public interface ChartControl

The Interface ChartControl.


Field Summary
static java.lang.String AREA_RENDERER
          The Constant AREA_RENDERER.
static java.lang.String BAR_RENDERER
          The Constant BAR_RENDERER.
static java.lang.String CHART_CONTROL
          The Constant CHART_CONTROL.
static java.lang.String DOT_RENDERER
          The Constant DOT_RENDERER.
static java.lang.String LINE_RENDERER
          The Constant LINE_RENDERER.
 
Method Summary
 void addYAxis(int chartId, java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, java.lang.String fieldLabel)
          Add an Y axis to the chart.
 int createNewChart(java.lang.String type)
          Create a new chart of the type type.
 javax.swing.JPanel getChart(int chartId)
          Get a panel with a chart in.
 java.awt.image.BufferedImage getChartImage(int chartId, int width, int height)
          Get an image of the chart.
 java.awt.Color getColor(int chartId, java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, java.lang.String fieldLabel)
          Gets the color.
 int getLowerLimit(int chartId)
          Gets the lower limit.
 int getMaxNumberOfPoint(int chartId)
          Gets the max number of point.
 java.util.Map getRendererList()
          Gets the renderer list.
 int getUpperLimit(int chartId)
          Gets the upper limit.
 void removeYAxis(int chartId, java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, java.lang.String fieldLabel)
          Remove a Y axis to the chart.
 void setChartTitle(int chartId, java.lang.String title)
          Define the chart's title.
 void setColor(int chartId, java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, java.lang.String fieldLabel, java.awt.Color color)
          Sets the color of a plot.
 void setDomainRange(int chartId, int lower, int upper)
          Sets the domain range.
 void setMaxNumberOfPoint(int chartId, int number)
          Sets the max number of point.
 void setRenderer(int chartId, java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, java.lang.String fieldLabel, java.lang.String rendererType)
          Sets the renderer.
 void setXAxis(int chartId, java.lang.String fieldName)
          Define the X axis for the chart.
 void setXAxisLabel(int chartId, java.lang.String label)
          Define the X axis' label.
 void setYAxisLabel(int chartId, java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, java.lang.String fieldLabel, java.lang.String label)
          Define a Y axis' label.
 void setYAxisMovingStatistics(int chartId, java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, java.lang.String fieldLabel, java.lang.String movingStatistic, int timeWindow, int step)
          Sets the Y axis moving statistics.
 

Field Detail

CHART_CONTROL

static final java.lang.String CHART_CONTROL
The Constant CHART_CONTROL.

See Also:
Constant Field Values

LINE_RENDERER

static final java.lang.String LINE_RENDERER
The Constant LINE_RENDERER.

See Also:
Constant Field Values

AREA_RENDERER

static final java.lang.String AREA_RENDERER
The Constant AREA_RENDERER.

See Also:
Constant Field Values

BAR_RENDERER

static final java.lang.String BAR_RENDERER
The Constant BAR_RENDERER.

See Also:
Constant Field Values

DOT_RENDERER

static final java.lang.String DOT_RENDERER
The Constant DOT_RENDERER.

See Also:
Constant Field Values
Method Detail

setXAxis

void setXAxis(int chartId,
              java.lang.String fieldName)
Define the X axis for the chart.

Parameters:
chartId - the chart id
fieldName - the field name

addYAxis

void addYAxis(int chartId,
              java.lang.String testName,
              java.lang.String bladeId,
              java.lang.String eventTypeLabel,
              java.lang.String fieldLabel)
Add an Y axis to the chart.

Parameters:
chartId - the chart id
testName - the name of the test
bladeId - the id of a blade
eventTypeLabel - the label of an event type
fieldLabel - the field label

setYAxisMovingStatistics

void setYAxisMovingStatistics(int chartId,
                              java.lang.String testName,
                              java.lang.String bladeId,
                              java.lang.String eventTypeLabel,
                              java.lang.String fieldLabel,
                              java.lang.String movingStatistic,
                              int timeWindow,
                              int step)
Sets the Y axis moving statistics.

Parameters:
chartId - the chart id
testName - the test name
bladeId - the blade id
eventTypeLabel - the event type label
fieldLabel - the field label
movingStatistic - the moving statistic
timeWindow - the time window
step - the step

removeYAxis

void removeYAxis(int chartId,
                 java.lang.String testName,
                 java.lang.String bladeId,
                 java.lang.String eventTypeLabel,
                 java.lang.String fieldLabel)
Remove a Y axis to the chart.

Parameters:
chartId - the chart id
testName - the name of the test
bladeId - the id of a blade
eventTypeLabel - the label of an event type
fieldLabel - the field label

setChartTitle

void setChartTitle(int chartId,
                   java.lang.String title)
Define the chart's title.

Parameters:
title - the chart's title
chartId - the chart id

setXAxisLabel

void setXAxisLabel(int chartId,
                   java.lang.String label)
Define the X axis' label.

Parameters:
chartId - the chart id
label - the label of the X axis

setYAxisLabel

void setYAxisLabel(int chartId,
                   java.lang.String testName,
                   java.lang.String bladeId,
                   java.lang.String eventTypeLabel,
                   java.lang.String fieldLabel,
                   java.lang.String label)
Define a Y axis' label.

Parameters:
chartId - the chart id
testName - the name of the test
bladeId - the id of a blade
eventTypeLabel - the label of an event type
label - the label of the Y axis
fieldLabel - the field label

getChart

javax.swing.JPanel getChart(int chartId)
Get a panel with a chart in.

Parameters:
chartId - the chart id
Returns:
a panel with the request chart in

createNewChart

int createNewChart(java.lang.String type)
Create a new chart of the type type.

Parameters:
type - the type of chart
Returns:
the chart id

getChartImage

java.awt.image.BufferedImage getChartImage(int chartId,
                                           int width,
                                           int height)
Get an image of the chart.

Parameters:
chartId - the chart id
width - the width
height - the height
Returns:
an buffered image of the chart

setColor

void setColor(int chartId,
              java.lang.String testName,
              java.lang.String bladeId,
              java.lang.String eventTypeLabel,
              java.lang.String fieldLabel,
              java.awt.Color color)
Sets the color of a plot.

Parameters:
chartId - the chart id
color - the color
testName - the test name
bladeId - the blade id
eventTypeLabel - the event type label
fieldLabel - the field label

getColor

java.awt.Color getColor(int chartId,
                        java.lang.String testName,
                        java.lang.String bladeId,
                        java.lang.String eventTypeLabel,
                        java.lang.String fieldLabel)
Gets the color.

Parameters:
chartId - the chart id
testName - the test name
bladeId - the blade id
eventTypeLabel - the event type label
fieldLabel - the field label
Returns:
the color

setRenderer

void setRenderer(int chartId,
                 java.lang.String testName,
                 java.lang.String bladeId,
                 java.lang.String eventTypeLabel,
                 java.lang.String fieldLabel,
                 java.lang.String rendererType)
Sets the renderer.

Parameters:
chartId - the chart id
testName - the test name
bladeId - the blade id
eventTypeLabel - the event type label
fieldLabel - the field label
rendererType - the type renderer

getRendererList

java.util.Map getRendererList()
Gets the renderer list.

Returns:
the list of renderer list

setDomainRange

void setDomainRange(int chartId,
                    int lower,
                    int upper)
Sets the domain range.

Parameters:
chartId - the chart id
lower - the lower
upper - the upper

setMaxNumberOfPoint

void setMaxNumberOfPoint(int chartId,
                         int number)
Sets the max number of point.

Parameters:
chartId - the chart id
number - the number

getMaxNumberOfPoint

int getMaxNumberOfPoint(int chartId)
Gets the max number of point.

Parameters:
chartId - the chart id
Returns:
the max number of point

getUpperLimit

int getUpperLimit(int chartId)
Gets the upper limit.

Parameters:
chartId - the chart id
Returns:
the upper limit

getLowerLimit

int getLowerLimit(int chartId)
Gets the lower limit.

Parameters:
chartId - the chart id
Returns:
the lower limit