net.windward.chart.datasource

Interface IGraphDataSet

public interface IGraphDataSet

Holds a set of data for a single graph. There may be multiple series per graph and multiple graphs per chart.

Sometimes, there can be multiple GraphDataSets that correspond to a single graph. The responsibility of combining such GraphDataSets is placed upon the DatasetTools class.

The term "columns" is used to refer to each axis/coordinate and the series. Think of it as one column for each axis (x, y, z, etc), and one more column for the series name.

series	x	y
Denver	0	100
Denver	1	200
Denver	2	400
New York	0	500
New York	1	1500
New York	2	4500

Version:

5.0 June 5, 2007

Method Summary

Modifier and Type	Method and Description
void	close() Call when done.
ChartColumnMetaData[]	getColumnMetaData() Meta data for each column.
java.lang.String	getDateRange() ChartTag.DATE_RANGE_* type.
java.lang.String	getGraphBaseType() Gets the graph base type.
java.lang.String	getGraphFullType() Gets the graph full type.
java.lang.String	getGraphSubtype() gets the graph subtype.
java.lang.String	getGraphXAxSide() Gets the graph x-axis side.
java.lang.String	getGraphYAxSide() Gets the graph y-axis side.
int	getNumColumns() Gets the number of columns we have including the series text.
int	getNumSeries() The number os series held by this object.
java.util.List<IChartSeries>	getSeries() Gets an Iterator for the GraphDataSet's ChartSeries collection.
default boolean	useSeriesTitle() Tells if the graph should use its series title to be drawn in the legend.

Method Detail

getSeries

java.util.List<IChartSeries> getSeries()

Gets an Iterator for the GraphDataSet's ChartSeries collection.

Returns:

An Iterator for the GraphDataSet's ChartSeries collection.

getNumSeries

int getNumSeries()

The number os series held by this object.

getNumColumns

int getNumColumns()

Gets the number of columns we have including the series text.

Returns:

number of columns including the series text.

getColumnMetaData

ChartColumnMetaData[] getColumnMetaData()

Meta data for each column.

Returns:

meta data for each column.

close

void close()

Call when done.

getGraphFullType

java.lang.String getGraphFullType()

Gets the graph full type. ChartTag.FULLTYPE_*

Returns:

graph full type

getGraphBaseType

java.lang.String getGraphBaseType()

Gets the graph base type. ChartTag.TYPE_*

Returns:

graph base type

getGraphSubtype

java.lang.String getGraphSubtype()

gets the graph subtype. ChartTag.SUBTYPE_*

Returns:

graph subtype

getGraphYAxSide

java.lang.String getGraphYAxSide()

Gets the graph y-axis side. ChartTag.CHART_SIDE_*

Returns:

graph y-axis side

getGraphXAxSide

java.lang.String getGraphXAxSide()

Gets the graph x-axis side. ChartTag.CHART_SIDE_*

Returns:

graph x-axis side

getDateRange

java.lang.String getDateRange()

ChartTag.DATE_RANGE_* type. Only for dates - null otherwise.

Returns:

date range type

useSeriesTitle

default boolean useSeriesTitle()

Tells if the graph should use its series title to be drawn in the legend.

Returns:

true if series title shoule be used.