agentgui.core.charts

Class DataModel

java.lang.Object

agentgui.core.charts.DataModel

All Implemented Interfaces:

java.util.Observer

Direct Known Subclasses:

TimeSeriesDataModel, XyDataModel

public abstract class DataModel
extends java.lang.Object
implements java.util.Observer

This class manages the data models for different chart visualizations. This is an abstract super class that provides general functionality. As different chart types might require different data types and functionality there must be chart type specific implementation for every type of chart.

Field Summary

Fields

Modifier and Type	Field and Description
protected ChartModel	chartModel The JFreeChart representation of the series data.
protected ChartSettingModel	chartSettingModel The model for the chart settings
static java.awt.Color[]	DEFAULT_COLORS These colors will be used for newly added series.
static float	DEFAULT_LINE_WIDTH This line width will be used for newly added series.
protected OntologyModel	ontologyModel The ontology representation of the series data.
protected int	seriesCount The number of series in this data model.
protected TableModel	tableModel The JTable representation of the series data.

Constructor Summary

Constructors

Constructor and Description
DataModel()

Method Summary

Modifier and Type	Method and Description
void	addOrExchangeSeries(DataSeries series, int targetDataSeriesIndex) Adds or exchanges a data series from the current chart.
void	addSeries(DataSeries series) Adds a new series to the data model.
abstract DataSeries	createNewDataSeries(java.lang.String label) Creates a new data series of the correct type for the precise type of chart.
abstract ValuePair	createNewValuePair(java.lang.Number key, java.lang.Number value) Creates a new value pair for the specific type of chart.
abstract void	editDataSeriesAddData(DataSeries series, int targetDataSeriesIndex, boolean editOntology) Edits the data series by adding data.
abstract void	editDataSeriesAddOrExchangeData(DataSeries series, int targetDataSeriesIndex, boolean editOntology) Edits the data series by adding or exchanging data.
abstract void	editDataSeriesExchangeData(DataSeries series, int targetDataSeriesIndex, boolean editOntology) Edits the data series by exchanging data.
abstract void	editDataSeriesRemoveData(DataSeries series, int targetDataSeriesIndex, boolean editOntology) Edits the data series by remove data.
void	exchangeSeries(DataSeries series, int seriesIndex) Adds or exchanges a data series from the current chart.
abstract java.lang.String	getBaseStringForSeriesLabel() Returns a string that can be used for generating default series labels
ChartModel	getChartModel() Gets the chart model.
ChartSettingModel	getChartSettingModel() Returns the chart setting model.
java.lang.String	getDefaultSeriesLabel() Builds a default series label, that can be used for new series if no label is specified.
OntologyModel	getOntologyModel() Returns the ontology model.
int	getSeriesCount() Gets the series count.
TableModel	getTableModel() Gets the table model.
abstract jade.util.leap.List	getValuePairsFromSeries(DataSeries series) Gets a list containing all value pairs from the given DataSeries.
abstract java.lang.Number	getXValueFromPair(ValuePair vp) Gets the key / x value from the given value pair.
abstract java.lang.Number	getYValueFromValuePair(ValuePair vp) Gets the (y) value from the value pair.
void	removeSeries(int seriesIndex) Removes a series from the data model.
void	setChartModel(ChartModel chartModel) Sets the chart model.
void	setChartSettingModel(ChartSettingModel chartSettingModel) Sets the chart setting model.
abstract void	setKeyForPair(java.lang.Number key, ValuePair vp) Updates the key of the value pair.
abstract void	setOntologyInstanceChart(Chart ontologyChart) Sets the chart given by the data model of the ontology instance.
void	setOntologyModel(OntologyModel ontologyModel) Sets the ontology model.
void	setTableModel(TableModel tableModel) Sets the table model.
abstract 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 java.lang.Object

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

Field Detail

DEFAULT_COLORS

public static final java.awt.Color[] DEFAULT_COLORS

These colors will be used for newly added series.

DEFAULT_LINE_WIDTH

public static final float DEFAULT_LINE_WIDTH

This line width will be used for newly added series.

See Also:

Constant Field Values

ontologyModel

protected OntologyModel ontologyModel

The ontology representation of the series data.

tableModel

protected TableModel tableModel

The JTable representation of the series data.

chartModel

protected ChartModel chartModel

The JFreeChart representation of the series data.

chartSettingModel

protected ChartSettingModel chartSettingModel

The model for the chart settings

seriesCount

protected int seriesCount

The number of series in this data model.

Constructor Detail

DataModel

public DataModel()

Method Detail

setOntologyInstanceChart

public abstract void setOntologyInstanceChart(Chart ontologyChart)

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

Parameters:

ontologyChart - the new ontology instance chart

createNewDataSeries

public abstract DataSeries createNewDataSeries(java.lang.String label)

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

Parameters:

label - The new data series label

Returns:

The new data series

createNewValuePair

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

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.

Parameters:

key - The key / x value

value - The (y) value

Returns:

The value pair

getXValueFromPair

public abstract java.lang.Number getXValueFromPair(ValuePair vp)

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.

Parameters:

vp - The value pair

Returns:

The key / x value

getYValueFromValuePair

public abstract java.lang.Number getYValueFromValuePair(ValuePair vp)

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.

Parameters:

vp - The value pair

Returns:

The (y) value

setKeyForPair

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

Updates the key of the value pair.

Parameters:

key - The new key

vp - The value pair to be updated

setValueForPair

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

Updates the value of the key value pair.

Parameters:

value - The new value

vp - The value pair to be updated

getValuePairsFromSeries

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

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.

Parameters:

series - The DataSeries

Returns:

The List of ValuePairs

getDefaultSeriesLabel

public java.lang.String getDefaultSeriesLabel()

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.

Returns:

The default series label

getBaseStringForSeriesLabel

public abstract java.lang.String getBaseStringForSeriesLabel()

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

Returns:

The base string for series labels

getOntologyModel

public OntologyModel getOntologyModel()

Returns the ontology model.

Returns:

the ontologyModel

setOntologyModel

public void setOntologyModel(OntologyModel ontologyModel)

Sets the ontology model.

Parameters:

ontologyModel - the ontologyModel to set

getTableModel

public TableModel getTableModel()

Gets the table model.

Returns:

the tableModel

setTableModel

public void setTableModel(TableModel tableModel)

Sets the table model.

Parameters:

tableModel - the tableModel to set

getChartModel

public ChartModel getChartModel()

Gets the chart model.

Returns:

the chartModel

setChartModel

public void setChartModel(ChartModel chartModel)

Sets the chart model.

Parameters:

chartModel - the chartModel to set

getChartSettingModel

public ChartSettingModel getChartSettingModel()

Returns the chart setting model.

Returns:

the chart setting model

setChartSettingModel

public void setChartSettingModel(ChartSettingModel chartSettingModel)

Sets the chart setting model.

Parameters:

chartSettingModel - the new chart setting model

getSeriesCount

public int getSeriesCount()

Gets the series count.

Returns:

the seriesCount

addSeries

public void addSeries(DataSeries series)

Adds a new series to the data model.

Parameters:

series - The new series

addOrExchangeSeries

public void addOrExchangeSeries(DataSeries series,
                                int targetDataSeriesIndex)
                         throws NoSuchSeriesException

Adds or exchanges a data series from the current chart.

Parameters:

series - the series

targetDataSeriesIndex - the target data series index

Throws:

NoSuchSeriesException

exchangeSeries

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

Adds or exchanges a data series from the current chart. If the specified series does not exists, nothing will be done.

Parameters:

series - the series

seriesIndex - the target data series index

Throws:

NoSuchSeriesException

removeSeries

public void removeSeries(int seriesIndex)
                  throws NoSuchSeriesException

Removes a series from the data model.

Parameters:

seriesIndex - The index of the series to be removed

Throws:

NoSuchSeriesException - Thrown if there is no series with that index

editDataSeriesAddData

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

Edits the data series by adding data.

Parameters:

series - the series

targetDataSeriesIndex - the target data series index

editOntology - true, if the ontology has to be edited

Throws:

NoSuchSeriesException

editDataSeriesAddOrExchangeData

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

Edits the data series by adding or exchanging data.

Parameters:

series - the series

targetDataSeriesIndex - the target data series index

editOntology - true, if the ontology has to be edited

Throws:

NoSuchSeriesException

editDataSeriesExchangeData

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

Edits the data series by exchanging data.

Parameters:

series - the series

targetDataSeriesIndex - the target data series index

editOntology - true, if the ontology has to be edited

Throws:

NoSuchSeriesException

editDataSeriesRemoveData

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

Edits the data series by remove data.

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