SSJ
V. labo.

umontreal.iro.lecuyer.charts
Class SSJCategorySeriesCollection

java.lang.Object
  extended by umontreal.iro.lecuyer.charts.SSJCategorySeriesCollection
Direct Known Subclasses:
BoxSeriesCollection

public abstract class SSJCategorySeriesCollection
extends Object

SSJCategorySeriesCollection

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
SSJCategorySeriesCollection()
           
 
Method Summary
 String getCategory(int series)
          .
 Color getColor(int series)
          .
abstract  double[] getRangeBounds()
          .
 CategoryItemRenderer getRenderer()
          .
 CategoryDataset getSeriesCollection()
          .
 double getValue(int series, int index)
          .
 void setColor(int series, Color color)
          .
 void setRenderer(CategoryItemRenderer renderer)
          .
abstract  String toLatex(double YScale, double YShift, double ymin, double ymax)
          .
abstract  String toString()
          .
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SSJCategorySeriesCollection

public SSJCategorySeriesCollection()
Method Detail

getCategory

public String getCategory(int series)
. \begin{tabb}
 Returns the category-value in the specified series.
 \end{tabb}
seriesrequired series value. x-value at the specified index in the specified series.


getValue

public double getValue(int series,
                       int index)
. \begin{tabb}
 Returns the $y$-value at the specified index in the specified series.
 \end{tabb}
seriesrequired series value. indexvalue's index. y-value at the specified index in the specified series.


getSeriesCollection

public CategoryDataset getSeriesCollection()
. \begin{tabb}
 Returns the \texttt{CategoryDataset} object associated with the current object.
 \end{tabb}
CategoryDataset object associated with the current variable.


getRangeBounds

public abstract double[] getRangeBounds()
. \begin{tabb}
 Returns range ($y$-coordinates) min and max values.
 \end{tabb}
range min and max values.


toString

public abstract String toString()
. \begin{tabb}
 Returns in a \texttt{String} all data contained in the current object.
 \end{tabb}
All data contained in the current object as a String.

Overrides:
toString in class Object

getRenderer

public CategoryItemRenderer getRenderer()
. \begin{tabb}
 Returns the \texttt{CategoryItemRenderer} object associated with the current object.
 \end{tabb}
CategoryItemRenderer object associated with the current variable.


setRenderer

public void setRenderer(CategoryItemRenderer renderer)
. \begin{tabb}
 Sets the \texttt{CategoryItemRenderer} object associated with the ...
 ...iew} in class
 \externalclass{umontreal.iro.lecuyer.charts}{XYChart}.
 \end{tabb}
renderer new CategoryItemRenderer object.


getColor

public Color getColor(int series)
. \begin{tabb}
 Gets the current plotting color of the selected series.
 \end{tabb}
current plotting color.


setColor

public void setColor(int series,
                     Color color)
. \begin{tabb}
 Sets a new plotting color to the series $series$.
 \end{tabb}
seriesseries index. colorplotting color.


toLatex

public abstract String toLatex(double YScale,
                               double YShift,
                               double ymin,
                               double ymax)
. \begin{tabb}
 Formats and returns a string containing a \LaTeX -compatible sourc...
 ...ameters.
 \texttt{ymin} and \texttt{ymax} represent the chart bounds.
 \end{tabb}
YScaleRange original data scale. YShiftRange original data shift value. yminRange min bound. ymaxRange max bound. Latex code.


SSJ
V. labo.

To submit a bug or ask questions, send an e-mail to Pierre L'Ecuyer.