agentgui.core.charts.timeseriesChart

Class TimeSeriesDataModel

java.lang.Object

agentgui.core.charts.DataModel

agentgui.core.charts.timeseriesChart.TimeSeriesDataModel

All Implemented Interfaces:

java.util.Observer

public class TimeSeriesDataModel
extends DataModel

Container class managing the data models for the different time series representations.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CHART_TITLE This title will be used for the chart if none is specified
static java.lang.String	DEFAULT_SERIES_LABEL This label with appended seriesCount+1 will be used for newly added series
static java.lang.String	DEFAULT_X_AXIS_LABEL This x axis label will be used for the chart if none is specified
static java.lang.String	DEFAULT_Y_AXIS_LABEL This y axis label will be used for the chart if none is specified

Fields inherited from class agentgui.core.charts.DataModel

chartModel, chartSettingModel, DEFAULT_COLORS, DEFAULT_LINE_WIDTH, ontologyModel, seriesCount, tableModel

Constructor Summary

Constructors

Constructor and Description
TimeSeriesDataModel() Instantiates a new TimeSeriesDataModel.

Method Summary

Modifier and Type	Method and Description
void	addValuePairToSeries(long timeStamp, float value, int seriesIndex, boolean editOntology) Edits the series by adding a value pair.
TimeSeries	createNewDataSeries(java.lang.String label) Creates a new data series of the correct type for the precise type of chart.
ValuePair	createNewValuePair(java.lang.Number key, java.lang.Number value) Creates a new value pair for the specific type of chart.
void	editDataSeriesAddData(DataSeries series, int targetDataSeriesIndex, boolean editOntology) Edits the data series by adding data.
void	editDataSeriesAddOrExchangeData(DataSeries series, int targetDataSeriesIndex, boolean editOntology) Edits the data series by adding or exchanging data.
void	editDataSeriesExchangeData(DataSeries series, int targetDataSeriesIndex, boolean editOntology) Edits the data series by exchanging data.
void	editDataSeriesRemoveData(DataSeries series, int targetDataSeriesIndex, boolean editOntology) Edits the data series by remove data.
java.lang.String	getBaseStringForSeriesLabel() Returns a string that can be used for generating default series labels
java.lang.String	getDefaultSeriesLabel() Builds a default series label, that can be used for new series if no label is specified.
java.lang.String	getDefaultTimeFormat() Returns the default time format.
TimeSeriesLengthRestriction	getLengthRestriction() Gets the length restriction.
java.lang.String	getTimeFormat()
TimeSeriesChartModel	getTimeSeriesChartModel() Returns the current time series chart model.
TimeSeriesOntologyModel	getTimeSeriesOntologyModel() Returns the current time series ontology model.
TimeSeriesTableModel	getTimeSeriesTableModel() Returns the current time series table model.
jade.util.leap.List	getValuePairsFromSeries(DataSeries series) Gets a list containing all value pairs from the given DataSeries.
java.lang.Number	getXValueFromPair(ValuePair vp) Gets the key / x value from the given value pair.
java.lang.Number	getYValueFromValuePair(ValuePair vp) Gets the (y) value from the value pair.
boolean	isRealTime() Checks if this is a real time series.
void	removeValuePairsFromAllSeries(java.lang.Number key) Removes the value pair with the given time stamp from every series that contains one.
void	setDefaultTimeFormat(java.lang.String defaultTimeFormat) Sets the default time format.
void	setKeyForPair(java.lang.Number key, ValuePair vp) Updates the key of the value pair.
void	setOntologyInstanceChart(Chart ontologyChart) Sets the chart given by the data model of the ontology instance.
void	setRealTime(boolean realTime) Configures if this is a real time series.
void	setTimeFormat(java.lang.String timeFormat)
void	setValueForPair(java.lang.Number value, ValuePair vp) Updates the value of the key value pair.
void	update(java.util.Observable o, java.lang.Object arg)

Methods inherited from class agentgui.core.charts.DataModel

addOrExchangeSeries, addSeries, exchangeSeries, getChartModel, getChartSettingModel, getOntologyModel, getSeriesCount, getTableModel, removeSeries, setChartModel, setChartSettingModel, setOntologyModel, setTableModel

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SERIES_LABEL

public static final java.lang.String DEFAULT_SERIES_LABEL

This label with appended seriesCount+1 will be used for newly added series

See Also:

Constant Field Values

DEFAULT_CHART_TITLE

public static final java.lang.String DEFAULT_CHART_TITLE

This title will be used for the chart if none is specified

See Also:

Constant Field Values

DEFAULT_X_AXIS_LABEL

public static final java.lang.String DEFAULT_X_AXIS_LABEL

This x axis label will be used for the chart if none is specified

See Also:

Constant Field Values

DEFAULT_Y_AXIS_LABEL

public static final java.lang.String DEFAULT_Y_AXIS_LABEL

This y axis label will be used for the chart if none is specified

See Also:

Constant Field Values

Constructor Detail

TimeSeriesDataModel

public TimeSeriesDataModel()

Instantiates a new TimeSeriesDataModel.

Method Detail

setOntologyInstanceChart

public void setOntologyInstanceChart(Chart ontologyChart)

Description copied from class: DataModel

Sets the chart given by the data model of the ontology instance.

Specified by:

setOntologyInstanceChart in class DataModel

Parameters:

ontologyChart - the new ontology instance chart

getTimeSeriesOntologyModel

public TimeSeriesOntologyModel getTimeSeriesOntologyModel()

Returns the current time series ontology model.

Returns:

the ontologyModel

getTimeSeriesChartModel

public TimeSeriesChartModel getTimeSeriesChartModel()

Returns the current time series chart model.

Returns:

the chartModel

getTimeSeriesTableModel

public TimeSeriesTableModel getTimeSeriesTableModel()

Returns the current time series table model.

Returns:

the time series table model

setDefaultTimeFormat

public void setDefaultTimeFormat(java.lang.String defaultTimeFormat)

Sets the default time format.

Parameters:

defaultTimeFormat - the new default time format

getDefaultTimeFormat

public java.lang.String getDefaultTimeFormat()

Returns the default time format.

Returns:

the default time format

getTimeFormat

public java.lang.String getTimeFormat()

Returns:

the timeFormat

setTimeFormat

public void setTimeFormat(java.lang.String timeFormat)

Parameters:

timeFormat - the timeFormat to set

isRealTime

public boolean isRealTime()

Checks if this is a real time series.

Returns:

true, if is real time series

setRealTime

public void setRealTime(boolean realTime)

Configures if this is a real time series.

Parameters:

realTime - the new real time series

getLengthRestriction

public TimeSeriesLengthRestriction getLengthRestriction()

Gets the length restriction.

Returns:

the length restriction

createNewDataSeries

public TimeSeries createNewDataSeries(java.lang.String label)

Description copied from class: DataModel

Creates a new data series of the correct type for the precise type of chart.

Specified by:

createNewDataSeries in class DataModel

Parameters:

label - The new data series label

Returns:

The new data series

createNewValuePair

public ValuePair createNewValuePair(java.lang.Number key,
                                    java.lang.Number value)

Description copied from class: DataModel

Creates a new value pair for the specific type of chart. Allows value pair creation in super class methods without knowing the exact class of the value pair.

Specified by:

createNewValuePair in class DataModel

Parameters:

key - The key / x value

value - The (y) value

Returns:

The value pair

getXValueFromPair

public java.lang.Number getXValueFromPair(ValuePair vp)

Description copied from class: DataModel

Gets the key / x value from the given value pair. Allows accessing the key / x value from superclass methods without knowing the exact class of value pair and key / x value.

Specified by:

getXValueFromPair in class DataModel

Parameters:

vp - The value pair

Returns:

The key / x value

getYValueFromValuePair

public java.lang.Number getYValueFromValuePair(ValuePair vp)

Description copied from class: DataModel

Gets the (y) value from the value pair. Allows accessing the (y) value from superclass methods without knowing the exact class of value pair and (y) value.

Specified by:

getYValueFromValuePair in class DataModel

Parameters:

vp - The value pair

Returns:

The (y) value

getValuePairsFromSeries

public jade.util.leap.List getValuePairsFromSeries(DataSeries series)

Description copied from class: DataModel

Gets a list containing all value pairs from the given DataSeries. Allows accessing the value pairs from superclass methods without knowing the precise class of the series.

Specified by:

getValuePairsFromSeries in class DataModel

Parameters:

series - The DataSeries

Returns:

The List of ValuePairs

setKeyForPair

public void setKeyForPair(java.lang.Number key,
                          ValuePair vp)

Description copied from class: DataModel

Updates the key of the value pair.

Specified by:

setKeyForPair in class DataModel

Parameters:

key - The new key

vp - The value pair to be updated

setValueForPair

public void setValueForPair(java.lang.Number value,
                            ValuePair vp)

Description copied from class: DataModel

Updates the value of the key value pair.

Specified by:

setValueForPair in class DataModel

Parameters:

value - The new value

vp - The value pair to be updated

removeValuePairsFromAllSeries

public void removeValuePairsFromAllSeries(java.lang.Number key)

Removes the value pair with the given time stamp from every series that contains one.

Parameters:

key - The time stamp

getDefaultSeriesLabel

public java.lang.String getDefaultSeriesLabel()

Description copied from class: DataModel

Builds a default series label, that can be used for new series if no label is specified. The label is built from a chart-type specific base string and a numerical suffix based on the current number of series. If a series with the resulting label already exists, the suffix will be incremented.

Overrides:

getDefaultSeriesLabel in class DataModel

Returns:

The default series label

editDataSeriesAddData

public void editDataSeriesAddData(DataSeries series,
                                  int targetDataSeriesIndex,
                                  boolean editOntology)
                           throws NoSuchSeriesException

Description copied from class: DataModel

Edits the data series by adding data.

Specified by:

editDataSeriesAddData in class DataModel

Parameters:

series - the series

targetDataSeriesIndex - the target data series index

editOntology - true, if the ontology has to be edited

Throws:

NoSuchSeriesException

editDataSeriesAddOrExchangeData

public void editDataSeriesAddOrExchangeData(DataSeries series,
                                            int targetDataSeriesIndex,
                                            boolean editOntology)
                                     throws NoSuchSeriesException

Description copied from class: DataModel

Edits the data series by adding or exchanging data.

Specified by:

editDataSeriesAddOrExchangeData in class DataModel

Parameters:

series - the series

targetDataSeriesIndex - the target data series index

editOntology - true, if the ontology has to be edited

Throws:

NoSuchSeriesException

editDataSeriesExchangeData

public void editDataSeriesExchangeData(DataSeries series,
                                       int targetDataSeriesIndex,
                                       boolean editOntology)
                                throws NoSuchSeriesException

Description copied from class: DataModel

Edits the data series by exchanging data.

Specified by:

editDataSeriesExchangeData in class DataModel

Parameters:

series - the series

targetDataSeriesIndex - the target data series index

editOntology - true, if the ontology has to be edited

Throws:

NoSuchSeriesException

editDataSeriesRemoveData

public void editDataSeriesRemoveData(DataSeries series,
                                     int targetDataSeriesIndex,
                                     boolean editOntology)
                              throws NoSuchSeriesException

Description copied from class: DataModel

Edits the data series by remove data.

Specified by:

editDataSeriesRemoveData in class DataModel

Parameters:

series - the series

targetDataSeriesIndex - the target data series index

editOntology - true, if the ontology has to be edited

Throws:

NoSuchSeriesException - the no such series exception

update

public void update(java.util.Observable o,
                   java.lang.Object arg)

Specified by:

update in interface java.util.Observer

Overrides:

update in class DataModel

getBaseStringForSeriesLabel

public java.lang.String getBaseStringForSeriesLabel()

Description copied from class: DataModel

Returns a string that can be used for generating default series labels

Specified by:

getBaseStringForSeriesLabel in class DataModel

Returns:

The base string for series labels

addValuePairToSeries

public void addValuePairToSeries(long timeStamp,
                                 float value,
                                 int seriesIndex,
                                 boolean editOntology)
                          throws NoSuchSeriesException

Edits the series by adding a value pair.

Parameters:

timeStamp - the time stamp

value - the value

seriesIndex - the series index

editOntology - if false, only chart and table model will be modified

Throws:

NoSuchSeriesException - the no such series exception