anl.aida.bubble
Interface BubbleDataset

All Known Implementing Classes:
BubbleExperiments.Data, DefaultBubbleDataset

public interface BubbleDataset

Data access interface for a bubble chart. The shape of the data is each category is a row and each column is some numeric value of that category for that column. That shape is then repeated for each timestep.


Method Summary
 java.lang.Iterable<java.lang.String> categories()
          Gets an iterable over the categories in this dataset.
 int getCategoryCount()
          Gets the number of categories in this dataset.
 int getCategoryIndex(java.lang.String category)
          Gets the index of the specified category.
 java.lang.String getFormattedTimeStep(int timestep)
          Gets the formatted timestep (e.g.
 int getTimeStepCount()
          Gets the number of timesteps.
 NumericRange getXRange()
          Gets the range of x values over all timesteps and categories.
 double getXValue(int categoryIndex, int timestep)
          Gets the x value for the particular category at the specified timestep.
 NumericRange getYRange()
          Gets the range of y values over all timesteps and categories.
 double getYValue(int categoryIndex, int timestep)
          Gets the y value for the particular category at the specified timestep.
 NumericRange getZRange()
          Gets the range of z values over all timesteps and categories.
 double getZValue(int categoryIndex, int timestep)
          Gets the z value for the particular category at the specified timestep.
 

Method Detail

categories

java.lang.Iterable<java.lang.String> categories()
Gets an iterable over the categories in this dataset.

Returns:
an iterable over the categories in this dataset.

getCategoryCount

int getCategoryCount()
Gets the number of categories in this dataset.

Returns:
the number of categories in this dataset.

getTimeStepCount

int getTimeStepCount()
Gets the number of timesteps.

Returns:
the number of timesteps.

getFormattedTimeStep

java.lang.String getFormattedTimeStep(int timestep)
Gets the formatted timestep (e.g. a formatted date, a year, etc.)

Parameters:
timestep - the formatted timestep
Returns:

getCategoryIndex

int getCategoryIndex(java.lang.String category)
Gets the index of the specified category.

Parameters:
category - the category whose index we want
Returns:
the index of the specified category.

getXValue

double getXValue(int categoryIndex,
                 int timestep)
Gets the x value for the particular category at the specified timestep.

Parameters:
categoryIndex - the category index
timestep - the timestep
Returns:
the x value for the particular category at the specified timestep.

getYValue

double getYValue(int categoryIndex,
                 int timestep)
Gets the y value for the particular category at the specified timestep.

Parameters:
categoryIndex - the category index
timestep - the timestep
Returns:
the y value for the particular category at the specified timestep.

getZValue

double getZValue(int categoryIndex,
                 int timestep)
Gets the z value for the particular category at the specified timestep.

Parameters:
categoryIndex - the category index
timestep - the timestep
Returns:
the z value for the particular category at the specified timestep.

getXRange

NumericRange getXRange()
Gets the range of x values over all timesteps and categories.

Returns:
the range of x values over all timesteps and categories.

getYRange

NumericRange getYRange()
Gets the range of y values over all timesteps and categories.

Returns:
the range of y values over all timesteps and categories.

getZRange

NumericRange getZRange()
Gets the range of z values over all timesteps and categories.

Returns:
the range of z values over all timesteps and categories.