net.windward.chart.datasource

Interface IChartDataSet

All Known Implementing Classes:

BaseChartDataSet

public interface IChartDataSet

Holds the data returned from a datasource for a chart. A chart always has at least one and can have multiple graphs. Each graph has it's own series, optional select, and 1 - N (usually 2) sets of data (ie, axes/coordinates, x/y, x/y/z, o/h/l/c/v).

Builders of ChartDataSet ensure the state of the ChartDataSet is as follows. (Recall that a set of chart data is graph-compatible if it is for the same graph type and the same graph axis. Otherwise the data is graph-incompatible. See ChartTag.isGraphCompatible().)

There is one GraphDataSet under ChartDataSet for each graph-incompatible set of data.

There is a set of ChartSeries under each GraphDataSet. There's one unique ChartSeries for each unique series of plot points in the graph.

For category charts, each set of plot points that is within a single series, and that has the same category (x-value) will be replaced by a single plot point with the sum of the y-values.

For string-based and date-based data sets, plot points with null y-values will be inserted so that each series has one plot point for each x-value.

For date-based data sets, all plot points will be sorted in ascending order, with respect to the dates.

Version:

4.0 May 25, 2005

Method Summary

Modifier and Type	Method and Description
void	applyChartML(IChartMLCarrier chartml, DocHeader docHdr) sets the series colors and line weight from chartml
void	close() Call when done.
java.util.List<IChartSeries>	getAllSeriesData()
java.lang.String	getChartTitle() The main chart title.
java.lang.String[]	getLegendTitles() Gets an array of titles that will be in the legend.
java.lang.String	getXAxisTitle() The x axis title.
java.lang.String	getYAxisTitle() The y axis title.
java.lang.String	getZAxisTitle() The z axis title.
java.util.List<IGraphDataSet>	graphs() The data for this chart.
void	setTitles(ChartTitles titles) Set titles for the chart.

Method Detail

graphs

java.util.List<IGraphDataSet> graphs()

The data for this chart. There will always be at least 1 graph.

Returns:

the chart's graphs.

close

void close()

Call when done.

setTitles

void setTitles(ChartTitles titles)

Set titles for the chart.

Parameters:

titles - the new titles for the chart.

getChartTitle

java.lang.String getChartTitle()

The main chart title.

Returns:

the main chart title or an empty string if not set.

getXAxisTitle

java.lang.String getXAxisTitle()

The x axis title.

Returns:

the x axis title or an empty string if not set.

getYAxisTitle

java.lang.String getYAxisTitle()

The y axis title.

Returns:

the y axis title or an empty string if not set.

getZAxisTitle

java.lang.String getZAxisTitle()

The z axis title.

Returns:

the z axis title or an empty string if not set.

applyChartML

void applyChartML(IChartMLCarrier chartml,
                  DocHeader docHdr)
           throws DataSourceException

sets the series colors and line weight from chartml

Parameters:

chartml - the chartml

docHdr -

Throws:

DataSourceException

getLegendTitles

java.lang.String[] getLegendTitles()

Gets an array of titles that will be in the legend.

Returns:

the array of legend titles.

getAllSeriesData

java.util.List<IChartSeries> getAllSeriesData()