umontreal.iro.lecuyer.charts

Class SSJCategorySeriesCollection

java.lang.Object

umontreal.iro.lecuyer.charts.SSJCategorySeriesCollection

Direct Known Subclasses:

BoxSeriesCollection

public abstract class SSJCategorySeriesCollection
extends java.lang.Object

Stores data used in a CategoryChart. This class provides tools to manage data sets and rendering options, and modify plot color, plot style, and marks on points for each series.

Constructor Summary

Constructors

Constructor and Description
SSJCategorySeriesCollection()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategory(int series) Returns the category-value in the specified series.
java.awt.Color	getColor(int series) Gets the current plotting color of the selected series.
abstract double[]	getRangeBounds() Returns range (y-coordinates) min and max values.
CategoryItemRenderer	getRenderer() Returns the CategoryItemRenderer object associated with the current object.
CategoryDataset	getSeriesCollection() Returns the CategoryDataset object associated with the current object.
double	getValue(int series, int index) Returns the y-value at the specified index in the specified series.
void	setColor(int series, java.awt.Color color) Sets a new plotting color to the series series.
void	setRenderer(CategoryItemRenderer renderer) Sets the CategoryItemRenderer object associated with the current variable.
abstract java.lang.String	toLatex(double YScale, double YShift, double ymin, double ymax) Formats and returns a string containing a LATEX-compatible source code which represents this data series collection.
abstract java.lang.String	toString() Returns in a String all data contained in the current object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SSJCategorySeriesCollection

public SSJCategorySeriesCollection()

Method Detail

getCategory

public java.lang.String getCategory(int series)

Returns the category-value in the specified series.

Parameters:

series - required series value.

Returns:

x-value at the specified index in the specified series.

getValue

public double getValue(int series,
                       int index)

Returns the y-value at the specified index in the specified series.

Parameters:

series - required series value.

index - value's index.

Returns:

y-value at the specified index in the specified series.

getSeriesCollection

public CategoryDataset getSeriesCollection()

Returns the CategoryDataset object associated with the current object.

Returns:

CategoryDataset object associated with the current variable.

getRangeBounds

public abstract double[] getRangeBounds()

Returns range (y-coordinates) min and max values.

Returns:

range min and max values.

toString

public abstract java.lang.String toString()

Returns in a String all data contained in the current object.

Overrides:

toString in class java.lang.Object

Returns:

All data contained in the current object as a String.

getRenderer

public CategoryItemRenderer getRenderer()

Returns the CategoryItemRenderer object associated with the current object.

Returns:

CategoryItemRenderer object associated with the current variable.

setRenderer

public void setRenderer(CategoryItemRenderer renderer)

Sets the CategoryItemRenderer object associated with the current variable. This object determines the chart JFreeChart look, produced by method view in class XYChart.

Parameters:

renderer - new CategoryItemRenderer object.

getColor

public java.awt.Color getColor(int series)

Gets the current plotting color of the selected series.

Returns:

current plotting color.

setColor

public void setColor(int series,
                     java.awt.Color color)

Sets a new plotting color to the series series.

Parameters:

series - series index.

color - plotting color.

toLatex

public abstract java.lang.String toLatex(double YScale,
                                         double YShift,
                                         double ymin,
                                         double ymax)

Formats and returns a string containing a L^ATEX-compatible source code which represents this data series collection. The original datasets are shifted and scaled with the YShift and YScale parameters. ymin and ymax represent the chart bounds.

Parameters:

YScale - Range original data scale.

YShift - Range original data shift value.

ymin - Range min bound.

ymax - Range max bound.

Returns:

Latex code.