org.cafesip.gwtcomp.client.common
Class TimeSeriesPlotInfo

java.lang.Object
  org.cafesip.gwtcomp.client.common.TimeSeriesPlotInfo

All Implemented Interfaces:

Serializable, PlotInfo

public class TimeSeriesPlotInfo
extends Object
implements Serializable, PlotInfo

This class contains the information on the time series plot. The org.cafesip.gwtcomp.client.ui.charting.LiveDataService object can display a line plot consisting of multiple series plotted against time. This class represents the characteristics of one such a plot.

Author:

Amit Chatterjee

See Also:

Serialized Form

Constructor Summary

TimeSeriesPlotInfo()
A constructor for this class.

TimeSeriesPlotInfo(SeriesInfo[] series, double minValue, double maxValue, long refreshInterval)
Similar to the constructor above but it uses the default values for some of the parameters.

TimeSeriesPlotInfo(SeriesInfo[] series, double minValue, double maxValue, long refreshInterval, int numXTicks, int numYTicks, String label, int maxPlots)
A constructor for this class.

Method Summary

int	getMaxPlots()
double	getMaxValue()
double	getMinValue()
int	getNumXTicks()
int	getNumYTicks()
long	getRefreshInterval()
SeriesInfo[]	getSeries()
String	getYLabel()
void	setMaxPlots(int maxPlots)
void	setMaxValue(double maxValue)
void	setMinValue(double minValue)
void	setNumXTicks(int numXTicks)
void	setNumYTicks(int numYTicks)
void	setRefreshInterval(long refreshInterval)
void	setSeries(SeriesInfo[] series)
void	setYLabel(String label)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TimeSeriesPlotInfo

public TimeSeriesPlotInfo()

A constructor for this class.

TimeSeriesPlotInfo

public TimeSeriesPlotInfo(SeriesInfo[] series,
                          double minValue,
                          double maxValue,
                          long refreshInterval,
                          int numXTicks,
                          int numYTicks,
                          String label,
                          int maxPlots)

A constructor for this class.

Parameters:

series - properties for one or more series that is to be displayed

minValue - bottom range. If all the series have a common bottom range, it must be specified here. It is also possible to specify separate bottom ranges for each the series.

maxValue - top range. If all the series have a common top range, it must be specified here. It is also possible to specify separate top ranges for each the series.

refreshInterval - specifies how frequently must the plot be refreshed. A value of 0 specifies no refresh after the inital data load.

numXTicks - number of axis markers to display on the X axis.

numYTicks - number of axis markers to display on the Y axis.

label - Y Axis label.

maxPlots - maximum number of plots to display for a given series.

TimeSeriesPlotInfo

public TimeSeriesPlotInfo(SeriesInfo[] series,
                          double minValue,
                          double maxValue,
                          long refreshInterval)

Similar to the constructor above but it uses the default values for some of the parameters.

Method Detail

getSeries

public SeriesInfo[] getSeries()

Returns:

Returns the series.

setSeries

public void setSeries(SeriesInfo[] series)

Parameters:

series - The series to set.

getMinValue

public double getMinValue()

Returns:

Returns the rangeBottom.

setMinValue

public void setMinValue(double minValue)

Parameters:

minValue - The rangeBottom to set.

getMaxValue

public double getMaxValue()

Returns:

Returns the rangeTop.

setMaxValue

public void setMaxValue(double maxValue)

Parameters:

maxValue - The rangeTop to set.

getRefreshInterval

public long getRefreshInterval()

Returns:

Returns the refreshInterval.

setRefreshInterval

public void setRefreshInterval(long refreshInterval)

Parameters:

refreshInterval - The refreshInterval to set.

getNumXTicks

public int getNumXTicks()

Returns:

Returns the numXTicks.

setNumXTicks

public void setNumXTicks(int numXTicks)

Parameters:

numXTicks - The numXTicks to set.

getNumYTicks

public int getNumYTicks()

Returns:

Returns the numYTicks.

setNumYTicks

public void setNumYTicks(int numYTicks)

Parameters:

numYTicks - The numYTicks to set.

getYLabel

public String getYLabel()

Returns:

Returns the yLabel.

setYLabel

public void setYLabel(String label)

Parameters:

label - The yLabel to set.

getMaxPlots

public int getMaxPlots()

Returns:

Returns the maxPlots.

setMaxPlots

public void setMaxPlots(int maxPlots)

Parameters:

maxPlots - The maxPlots to set.