agentgui.core.charts.timeseriesChart

Class TimeSeriesOntologyModel

java.lang.Object

agentgui.core.charts.OntologyModel

agentgui.core.charts.timeseriesChart.TimeSeriesOntologyModel

public class TimeSeriesOntologyModel
extends OntologyModel

The Class TimeSeriesOntologyModel.

Constructor Summary

Constructors

Constructor and Description
TimeSeriesOntologyModel(TimeSeriesChart timeSeriesChart, TimeSeriesDataModel parentDataModel) Instantiates a new time series ontology model.

Method Summary

Modifier and Type	Method and Description
void	addOrUpdateValuePair(int seriesIndex, java.lang.Number key, java.lang.Number value) Adds or updates a value pair.
void	addSeries(DataSeries series) Adds a data series.
void	exchangeSeries(int seriesIndex, DataSeries dataSeries) Exchange data series.
jade.util.leap.List	getChartData() Gets the chart data.
ChartSettingsGeneral	getChartSettings() Gets the chart settings for this chart.
protected int	getIndexByKey(int seriesIndex, java.lang.Number key) Gets the index of the value pair with the given key of the series with the given index.
TimeSeries	getSeries(int seriesIndex) Gets the data series.
int	getSeriesCount() Gets the number of current data series.
jade.util.leap.List	getSeriesData(int seriesIndex) Gets the list of value pairs for the data series with the specified index.
TimeSeriesChart	getTimeSeriesChart() Gets the complete ontology representation (data and visualization settings) for this chart.
TimeSeriesChartRealTimeWrapper	getTimeSeriesChartRealTimeWrapper() Gets the time series chart real time wrapper.
void	removeSeries(int seriesIndex) Removes a data series.
void	removeValuePair(int seriesIndex, java.lang.Number key) Removes a value pair.
void	setTimeFormat(java.lang.String timeFormat) Sets the time format in the settings object.
void	setTimeSeriesChart(TimeSeriesChart timeSeriesChart)
void	updateKey(java.lang.Number oldKey, java.lang.Number newKey) Exchanges one key in all series that contain it

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TimeSeriesOntologyModel

public TimeSeriesOntologyModel(TimeSeriesChart timeSeriesChart,
                               TimeSeriesDataModel parentDataModel)

Instantiates a new time series ontology model.

Parameters:

timeSeriesChart - the time series chart

parentDataModel - the parent data model

Method Detail

getChartSettings

public ChartSettingsGeneral getChartSettings()

Description copied from class: OntologyModel

Gets the chart settings for this chart.

Specified by:

getChartSettings in class OntologyModel

Returns:

the general chart settings

getTimeSeriesChart

public TimeSeriesChart getTimeSeriesChart()

Gets the complete ontology representation (data and visualization settings) for this chart.

Returns:

the timeSeriesChart

setTimeSeriesChart

public void setTimeSeriesChart(TimeSeriesChart timeSeriesChart)

Parameters:

timeSeriesChart - The timeSeriesChart to set

getIndexByKey

protected int getIndexByKey(int seriesIndex,
                            java.lang.Number key)
                     throws NoSuchSeriesException

Gets the index of the value pair with the given key of the series with the given index.

Parameters:

seriesIndex - The series index

key - The key

Returns:

The value pair's index

Throws:

NoSuchSeriesException - Thrown if there is no series with the specified index

removeValuePair

public void removeValuePair(int seriesIndex,
                            java.lang.Number key)
                     throws NoSuchSeriesException

Removes a value pair.

Parameters:

seriesIndex - the series index

key - the key

Throws:

NoSuchSeriesException - the no such series exception

addOrUpdateValuePair

public void addOrUpdateValuePair(int seriesIndex,
                                 java.lang.Number key,
                                 java.lang.Number value)
                          throws NoSuchSeriesException

Adds or updates a value pair.

Parameters:

seriesIndex - the series index

key - the key

value - the value

Throws:

NoSuchSeriesException - the no such series exception

updateKey

public void updateKey(java.lang.Number oldKey,
                      java.lang.Number newKey)

Exchanges one key in all series that contain it

Parameters:

oldKey - The old key

newKey - The new key

addSeries

public void addSeries(DataSeries series)

Description copied from class: OntologyModel

Adds a data series.

Specified by:

addSeries in class OntologyModel

Parameters:

series - the series

removeSeries

public void removeSeries(int seriesIndex)
                  throws NoSuchSeriesException

Description copied from class: OntologyModel

Removes a data series.

Specified by:

removeSeries in class OntologyModel

Parameters:

seriesIndex - the series index

Throws:

NoSuchSeriesException - the no such series exception

getSeriesCount

public int getSeriesCount()

Description copied from class: OntologyModel

Gets the number of current data series.

Specified by:

getSeriesCount in class OntologyModel

Returns:

the series count

getChartData

public jade.util.leap.List getChartData()

Description copied from class: OntologyModel

Gets the chart data.

Specified by:

getChartData in class OntologyModel

Returns:

the chart data

getSeries

public TimeSeries getSeries(int seriesIndex)
                     throws NoSuchSeriesException

Description copied from class: OntologyModel

Gets the data series.

Specified by:

getSeries in class OntologyModel

Parameters:

seriesIndex - the series index

Returns:

the series

Throws:

NoSuchSeriesException - the no such series exception

exchangeSeries

public void exchangeSeries(int seriesIndex,
                           DataSeries dataSeries)
                    throws NoSuchSeriesException

Description copied from class: OntologyModel

Exchange data series.

Specified by:

exchangeSeries in class OntologyModel

Parameters:

seriesIndex - the series index

dataSeries - the data series

Throws:

NoSuchSeriesException - the no such series exception

getSeriesData

public jade.util.leap.List getSeriesData(int seriesIndex)
                                  throws NoSuchSeriesException

Description copied from class: OntologyModel

Gets the list of value pairs for the data series with the specified index.

Specified by:

getSeriesData in class OntologyModel

Parameters:

seriesIndex - The series index

Returns:

The list of value pairs

Throws:

NoSuchSeriesException - Thrown if there is no series with the specified index

setTimeFormat

public void setTimeFormat(java.lang.String timeFormat)

Sets the time format in the settings object.

Parameters:

timeFormat - the new time format

getTimeSeriesChartRealTimeWrapper

public TimeSeriesChartRealTimeWrapper getTimeSeriesChartRealTimeWrapper()

Gets the time series chart real time wrapper.

Returns:

the time series chart real time wrapper