org.simbrain.plot.timeseries

Class TimeSeriesPlotComponent

java.lang.Object

org.simbrain.workspace.WorkspaceComponent

org.simbrain.plot.timeseries.TimeSeriesPlotComponent

public class TimeSeriesPlotComponent
extends WorkspaceComponent

Represents time series data.

Constructor Summary

Constructors

Constructor and Description
TimeSeriesPlotComponent(java.lang.String name) Create new time series plot component.
TimeSeriesPlotComponent(java.lang.String name, int numDataSources) Initializes a JFreeChart with specific number of data sources.
TimeSeriesPlotComponent(java.lang.String name, TimeSeriesModel model) Creates a new time series component from a specified model.

Method Summary

Modifier and Type	Method and Description
void	closing() Perform cleanup after closing.
TimeSeriesModel	getModel()
java.lang.Object	getObjectFromKey(java.lang.String objectKey) Finds objects based on a key.
java.util.List<PotentialConsumer>	getPotentialConsumers() Return the potential consumers associated with this component.
java.lang.String	getXML() Override for use with open service.
boolean	hasChangedSinceLastSave() Returns true if it's changed since the last save.
static TimeSeriesPlotComponent	open(java.io.InputStream input, java.lang.String name, java.lang.String format) Opens a saved time series plot.
void	save(java.io.OutputStream output, java.lang.String format) Used when saving a workspace.
void	setValue(double value, java.lang.Integer index) Set the value of a specified data source (one curve in the time series plot).
void	update() Called by Workspace to update the state of the component.

Methods inherited from class org.simbrain.workspace.WorkspaceComponent

addAttributeListener, addConsumerType, addProducerType, addWorkspaceComponentListener, close, couplingAdded, couplingRemoved, fireAttributeObjectRemoved, fireAttributeTypeVisibilityChanged, fireComponentToggleEvent, fireGuiToggleEvent, firePotentialAttributesChanged, fireUpdateEvent, getAttributeManager, getConsumerTypes, getCurrentFile, getDefaultFormat, getFormats, getKeyFromObject, getLocks, getLogger, getName, getPotentialProducers, getProducerTypes, getSerializePriority, getSimpleName, getUpdateOn, getUpdateParts, getVisibleConsumerTypes, getVisibleProducerTypes, getWorkspace, getWorkspaceComponentListeners, isGuiOn, removeAttributeListener, removeWorkspaceComponentListener, setChangedSinceLastSave, setCurrentFile, setGuiOn, setLogger, setName, setSerializePriority, setUpdateOn, setWorkspace, stopped, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeSeriesPlotComponent

public TimeSeriesPlotComponent(java.lang.String name)

Create new time series plot component.

Parameters:

name - name

TimeSeriesPlotComponent

public TimeSeriesPlotComponent(java.lang.String name,
                               TimeSeriesModel model)

Creates a new time series component from a specified model. Used in deserializing.

Parameters:

name - chart name

model - chart model

TimeSeriesPlotComponent

public TimeSeriesPlotComponent(java.lang.String name,
                               int numDataSources)

Initializes a JFreeChart with specific number of data sources.

Parameters:

name - name of component

numDataSources - number of data sources to initialize plot with

Method Detail

getPotentialConsumers

public java.util.List<PotentialConsumer> getPotentialConsumers()

Description copied from class: WorkspaceComponent

Return the potential consumers associated with this component. Subclasses should override this to make their consumers available.

Overrides:

getPotentialConsumers in class WorkspaceComponent

Returns:

the consumer list.

getModel

public TimeSeriesModel getModel()

Returns:

the model.

getObjectFromKey

public java.lang.Object getObjectFromKey(java.lang.String objectKey)

Description copied from class: WorkspaceComponent

Finds objects based on a key. Used in deserializing attributes. Any class that produces attributes should override this for serialization.

Overrides:

getObjectFromKey in class WorkspaceComponent

Parameters:

objectKey - String key

Returns:

the corresponding object

open

public static TimeSeriesPlotComponent open(java.io.InputStream input,
                                           java.lang.String name,
                                           java.lang.String format)

Opens a saved time series plot.

Parameters:

input - stream

name - name of file

format - format

Returns:

bar chart component to be opened

save

public void save(java.io.OutputStream output,
                 java.lang.String format)

Used when saving a workspace. All changed workspace components are saved using this method.

Specified by:

save in class WorkspaceComponent

Parameters:

output - the stream of data to write the data to.

format - a key used to define the requested format.

hasChangedSinceLastSave

public boolean hasChangedSinceLastSave()

Description copied from class: WorkspaceComponent

Returns true if it's changed since the last save.

Overrides:

hasChangedSinceLastSave in class WorkspaceComponent

Returns:

the changedSinceLastSave

closing

public void closing()

Description copied from class: WorkspaceComponent

Perform cleanup after closing.

Specified by:

closing in class WorkspaceComponent

update

public void update()

Description copied from class: WorkspaceComponent

Called by Workspace to update the state of the component.

Overrides:

update in class WorkspaceComponent

getXML

public java.lang.String getXML()

Description copied from class: WorkspaceComponent

Override for use with open service.

Overrides:

getXML in class WorkspaceComponent

Returns:

xml string representing stored file.

setValue

public void setValue(double value,
                     java.lang.Integer index)

Set the value of a specified data source (one curve in the time series plot). This is the main method for updating the data in a time series chart.

Parameters:

value - the current "y-axis" value for the time series

index - which time series curve to set.