au.edu.swin.synergy.plugin.syndicate.charts
Interface BChartProducer

All Known Implementing Classes:

BTotalHoursByGroup, BTotalHoursChart

public abstract interface BChartProducer

Defines the interface to extend in order to make a server side chart plug-in for Syndicate.

Method Summary

void	doQuery(Vector queryParams) Tells the plug-in to perform database access, and store data for retrieval.
String	getChartDescription() Returns the description of the purpose of the graph.
Vector	getLabels() Returns a vector containing the label of each item in the chart.
Vector	getRequiredParamNames() Tells the plug-in what the names of the parameters are.
Vector	getRequiredParams() Tells the plug-in what information is required from the user in order for the plu-in to work properly.
Vector	getValues() Returns a vector containing the value of each item in the chart.
String	getXAxisTitle() Returns the title of the X axis.
String	getYAxisTitle() Returns the title of the Y axis.
boolean	isQueryComplete() Tells whether or not there is data available to be retrieved.

Method Detail

getChartDescription

public String getChartDescription()

Returns the description of the purpose of the graph. For example: "Hours worked by group in last seven days".

Returns:

The description of the chart plug-in.

getRequiredParams

public Vector getRequiredParams()

Tells the plug-in what information is required from the user in order for the plu-in to work properly.

getRequiredParamNames

public Vector getRequiredParamNames()

Tells the plug-in what the names of the parameters are.

doQuery

public void doQuery(Vector queryParams)

Tells the plug-in to perform database access, and store data for retrieval. To retrieve the data, use the getLabels() method for the labels of each item in the chart, or getValues() method for the actual data values. The parameter queryParams contains option information that can be passed to the chart plugin for performing the query.

Parameters:

queryParams - Any additional information that may be used by the chart plug-in.

getYAxisTitle

public String getYAxisTitle()

Returns the title of the Y axis.

Returns:

The Y axis title.

getXAxisTitle

public String getXAxisTitle()

Returns the title of the X axis.

Returns:

The X axis title.

isQueryComplete

public boolean isQueryComplete()

Tells whether or not there is data available to be retrieved.

Returns:

True if data is available, false otherwise.

getLabels

public Vector getLabels()

Returns a vector containing the label of each item in the chart.

Returns:

The vector of labels, or null if query is not complete.

getValues

public Vector getValues()

Returns a vector containing the value of each item in the chart.

Returns:

The vector of values, or null if the query is not complete.