org.simbrain.world.dataworld

Class DataWorldComponent

java.lang.Object

org.simbrain.workspace.WorkspaceComponent

org.simbrain.world.dataworld.DataWorldComponent

public class DataWorldComponent
extends WorkspaceComponent

DataWorldComponent is a data table which other Simbrain components can use.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DataWorldComponent.ColumnAttribute Object which sets a value of one bar in a bar chart.

Method Summary

Modifier and Type	Method and Description
void	closing() Perform cleanup after closing.
static DataWorldComponent	createDataWorld(NumericTable data, java.lang.String name) Create the data world component.
DataWorldComponent.ColumnAttribute	getColumnConsumer(int i) Return the column consumer with specified index, or null if none found.
DataWorldComponent.ColumnAttribute	getColumnProducer(int i) Return the column producer with specified index, or null if none found.
AttributeType	getConsumingColumnType()
NumericTable	getDataModel() Returns the data model for this component.
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.
java.util.List<PotentialProducer>	getPotentialProducers() Return the potential producers associated with this component.
AttributeType	getProducingColumnType()
java.lang.String	getXML() Override for use with open service.
static DataWorldComponent	open(java.io.InputStream input, java.lang.String name, java.lang.String format) Recreates an instance of this class from a saved component.
void	save(java.io.OutputStream output, java.lang.String format) Used when saving a workspace.
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, getLocks, getLogger, getName, getProducerTypes, getSerializePriority, getSimpleName, getUpdateOn, getUpdateParts, getVisibleConsumerTypes, getVisibleProducerTypes, getWorkspace, getWorkspaceComponentListeners, hasChangedSinceLastSave, 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

Method Detail

createDataWorld

public static DataWorldComponent createDataWorld(NumericTable data,
                                                 java.lang.String name)

Create the data world component.

Parameters:

data - the underlying data

name - the title for this world

Returns:

the created component.

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.

getPotentialProducers

public java.util.List<PotentialProducer> getPotentialProducers()

Description copied from class: WorkspaceComponent

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

Overrides:

getPotentialProducers in class WorkspaceComponent

Returns:

the producer list.

getColumnProducer

public DataWorldComponent.ColumnAttribute getColumnProducer(int i)

Return the column producer with specified index, or null if none found.

Parameters:

i - index of setter

Returns:

the column attribute

getColumnConsumer

public DataWorldComponent.ColumnAttribute getColumnConsumer(int i)

Return the column consumer with specified index, or null if none found.

Parameters:

i - index of setter

Returns:

the column attribute

open

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

Recreates an instance of this class from a saved component.

Parameters:

input - input stream

name - name of file

format - format of file

Returns:

new component

getDataModel

public NumericTable getDataModel()

Returns the data model for this component.

Returns:

The data model for this component.

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.

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

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

update

public void update()

Description copied from class: WorkspaceComponent

Called by Workspace to update the state of the component.

Overrides:

update in class WorkspaceComponent

closing

public void closing()

Description copied from class: WorkspaceComponent

Perform cleanup after closing.

Specified by:

closing 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.

getProducingColumnType

public AttributeType getProducingColumnType()

Returns:

the producingColumnType

getConsumingColumnType

public AttributeType getConsumingColumnType()

Returns:

the consumingColumnType