org.simbrain.plot.projection

Class ProjectionComponent

java.lang.Object

org.simbrain.workspace.WorkspaceComponent

org.simbrain.plot.projection.ProjectionComponent

public class ProjectionComponent
extends WorkspaceComponent

Component for a projection plot.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ProjectionComponent.Dimension Object which adds data to one dimension of a projection component.

Constructor Summary

Constructors

Constructor and Description
ProjectionComponent(ProjectionModel model, java.lang.String name) Create a projection component from an existing set of data.
ProjectionComponent(java.lang.String name) Create new Projection Component.
ProjectionComponent(java.lang.String name, int numDataSources) Initializes a JFreeChart with specific number of data sources.

Method Summary

Modifier and Type	Method and Description
void	addPoint(double[] newPoint) Add a new point to the projection dataset using an array.
protected void	addScalarDimension(int i) Add a dimension object.
void	clearData() Clear the dataset.
void	closing() Perform cleanup after closing.
void	couplingAdded(Coupling coupling) Called when a coupling is attached to this component.
void	debug() Used for debugging model.
ProjectionComponent.Dimension	getDimension(int i) Return a dimension object.
java.lang.String	getKeyFromObject(java.lang.Object object) Returns a unique key associated with an object.
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.
ProjectionModel	getProjectionModel()
Projector	getProjector() Get reference to underlying projector object.
java.lang.String	getXML() Override for use with open service.
boolean	hasChangedSinceLastSave() Returns true if it's changed since the last save.
protected void	initializeConsumers() Initialize consumers.
static ProjectionComponent	open(java.io.InputStream input, java.lang.String name, java.lang.String format) Opens a saved projection component.
void	save(java.io.OutputStream output, java.lang.String format) Used when saving a workspace.
protected void	setDimensions(int numDims) Set number of dimensions to specified amount.
void	update() Get the current state of the dimension objects, send this to the projection algorithm, and update the graphics.

Methods inherited from class org.simbrain.workspace.WorkspaceComponent

addAttributeListener, addConsumerType, addProducerType, addWorkspaceComponentListener, close, couplingRemoved, fireAttributeObjectRemoved, fireAttributeTypeVisibilityChanged, fireComponentToggleEvent, fireGuiToggleEvent, firePotentialAttributesChanged, fireUpdateEvent, getAttributeManager, getConsumerTypes, getCurrentFile, getDefaultFormat, getFormats, 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

ProjectionComponent

public ProjectionComponent(java.lang.String name)

Create new Projection Component.

Parameters:

name -

ProjectionComponent

public ProjectionComponent(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

ProjectionComponent

public ProjectionComponent(ProjectionModel model,
                           java.lang.String name)

Create a projection component from an existing set of data. Used in deserializing.

Parameters:

model - projection model

name - name of component

Method Detail

initializeConsumers

protected void initializeConsumers()

Initialize consumers.

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.

addScalarDimension

protected void addScalarDimension(int i)

Add a dimension object.

Parameters:

i - index of dimension object

setDimensions

protected void setDimensions(int numDims)

Set number of dimensions to specified amount.

Parameters:

numDims - number of dimensions.

getDimension

public ProjectionComponent.Dimension getDimension(int i)

Return a dimension object.

Parameters:

i - index of dimension object to return

Returns:

the dimension object

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

getKeyFromObject

public java.lang.String getKeyFromObject(java.lang.Object object)

Description copied from class: WorkspaceComponent

Returns a unique key associated with an object. Used in serializing attributes. Any class that produces attributes should override this for serialization.

Overrides:

getKeyFromObject in class WorkspaceComponent

Parameters:

object - object which should be associated with a key

Returns:

the key

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.

open

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

Opens a saved projection component.

Parameters:

input - stream

name - name of file

format - format

Returns:

component to be opened

save

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

Description copied from class: WorkspaceComponent

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

addPoint

public void addPoint(double[] newPoint)

Add a new point to the projection dataset using an array.

Parameters:

newPoint - the new point

update

public void update()

Get the current state of the dimension objects, send this to the projection algorithm, and update the graphics.

Overrides:

update in class WorkspaceComponent

getProjector

public Projector getProjector()

Get reference to underlying projector object.

Returns:

projector object.

clearData

public void clearData()

Clear the dataset.

debug

public void debug()

Used for debugging model.

getProjectionModel

public ProjectionModel getProjectionModel()

Returns:

the projectionModel

couplingAdded

public void couplingAdded(Coupling coupling)

Description copied from class: WorkspaceComponent

Called when a coupling is attached to this component.

Overrides:

couplingAdded in class WorkspaceComponent

Parameters:

coupling - The coupling that is being added