WorkspaceComponent (Simbrain API)

java.lang.Object
- org.simbrain.workspace.WorkspaceComponent

Direct Known Subclasses:

BarChartComponent, ConsoleComponent, DataWorldComponent, DisplayComponent, DocViewerComponent, GameComponent, HistogramComponent, NetworkComponent, OdorWorldComponent, OscWorldComponent, PieChartComponent, ProjectionComponent, RasterPlotComponent, ReaderComponent, ScatterPlotComponent, TimeSeriesPlotComponent, VisionWorldComponent
```
public abstract class WorkspaceComponent
extends java.lang.Object
```
Represents a component in a Simbrain Workspace . Extend this class to create your own component type. Gui representations of a workspace component should extend GuiComponent.

Constructor Summary

Constructors
Constructor and Description

WorkspaceComponent(java.lang.String name)
Construct a workspace component.

Constructors
Constructor and Description
`WorkspaceComponent(java.lang.String name)` Construct a workspace component.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttributeListener(AttributeListener listener)` Adds a AttributeListener to this component.
`void`	`addConsumerType(AttributeType type)` Add a new type of consumer.
`void`	`addProducerType(AttributeType type)` Add a new type of producer.
`void`	`addWorkspaceComponentListener(WorkspaceComponentListener listener)` Adds a WorkspaceComponentListener to this component.
`void`	`close()` Closes the WorkspaceComponent.
`protected abstract void`	`closing()` Perform cleanup after closing.
`void`	`couplingAdded(Coupling<?> coupling)` Called when a coupling is attached to this component.
`void`	`couplingRemoved(Coupling<?> coupling)` Called when a coupling attached to this component is removed.
`(package private) void`	`doStopped()` Called after a global update ends.
`void`	`fireAttributeObjectRemoved(java.lang.Object object)` Fire attribute object removed event (when the base object of an attribute is removed).
`void`	`fireAttributeTypeVisibilityChanged(AttributeType type)` Fire attribute type visibility changed event.
`void`	`fireComponentToggleEvent()` Notify all workspaceComponentListeners of a component has been turned on or off.
`void`	`fireGuiToggleEvent()` Notify all workspaceComponentListeners that the gui has been turned on or off.
`void`	`firePotentialAttributesChanged()` Fire potential attributes changed event.
`void`	`fireUpdateEvent()` Notify all workspaceComponentListeners of a componentUpdated event.
`AttributeManager`	`getAttributeManager()`
`java.util.List<AttributeType>`	`getConsumerTypes()`
`java.io.File`	`getCurrentFile()`
`java.lang.String`	`getDefaultFormat()` The file extension for a component type, e.g.
`java.util.List<? extends java.lang.String>`	`getFormats()` Returns a list of the formats that this component supports.
`java.lang.String`	`getKeyFromObject(java.lang.Object object)` Returns a unique key associated with an object.
`java.util.Collection<? extends java.lang.Object>`	`getLocks()` Returns the locks for the update parts.
`org.apache.log4j.Logger`	`getLogger()`
`java.lang.String`	`getName()` Returns the name of this component.
`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.
`java.util.List<AttributeType>`	`getProducerTypes()`
`protected int`	`getSerializePriority()`
`java.lang.String`	`getSimpleName()` Retrieves a simple version of a component name from its class, e.g.
`java.lang.Boolean`	`getUpdateOn()`
`java.util.Collection<ComponentUpdatePart>`	`getUpdateParts()` Returns the collection of update parts for this component.
`java.util.List<AttributeType>`	`getVisibleConsumerTypes()` Return visible consumer types.
`java.util.List<AttributeType>`	`getVisibleProducerTypes()` Return visible producer types.
`Workspace`	`getWorkspace()` Returns the workspace associated with this component.
`java.util.Collection<WorkspaceComponentListener>`	`getWorkspaceComponentListeners()` Returns the WorkspaceComponentListeners on this component.
`java.lang.String`	`getXML()` Override for use with open service.
`boolean`	`hasChangedSinceLastSave()` Returns true if it's changed since the last save.
`java.lang.Boolean`	`isGuiOn()`
`void`	`removeAttributeListener(AttributeListener listener)` Removes an AttributeListener from this component.
`void`	`removeWorkspaceComponentListener(WorkspaceComponentListener listener)` Adds a WorkspaceComponentListener to this component.
`abstract void`	`save(java.io.OutputStream output, java.lang.String format)` Used when saving a workspace.
`void`	`setChangedSinceLastSave(boolean changedSinceLastSave)` Set to true when a component changes, set to false after a component is saved.
`void`	`setCurrentFile(java.io.File currentFile)`
`void`	`setGuiOn(java.lang.Boolean guiOn)`
`void`	`setLogger(org.apache.log4j.Logger logger)`
`void`	`setName(java.lang.String name)`
`protected void`	`setSerializePriority(int serializePriority)`
`void`	`setUpdateOn(java.lang.Boolean updateOn)`
`void`	`setWorkspace(Workspace workspace)` Sets the workspace for this component.
`protected void`	`stopped()` Called by Workspace to notify that updates have stopped.
`java.lang.String`	`toString()`
`void`	`update()` Called by Workspace to update the state of the component.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WorkspaceComponent
```
public WorkspaceComponent(java.lang.String name)
```
    Construct a workspace component.
    
    Parameters:
    
    name - The name of the component.
- Method Detail
  - save
```
public abstract void save(java.io.OutputStream output,
                          java.lang.String format)
```
    Used when saving a workspace. All changed workspace components are saved using this method.
    
    Parameters:
    
    output - the stream of data to write the data to.
    
    format - a key used to define the requested format.
  - getFormats
```
public java.util.List<? extends java.lang.String> getFormats()
```
    Returns a list of the formats that this component supports.
    The default behavior is to return an empty list. This means that there is one format.
    
    Returns:
    
    a list of the formats that this component supports.
  - close
```
public void close()
```
    Closes the WorkspaceComponent.
  - closing
```
protected abstract void closing()
```
    Perform cleanup after closing.
  - update
```
public void update()
```
    Called by Workspace to update the state of the component.
  - getPotentialConsumers
```
public java.util.List<PotentialConsumer> getPotentialConsumers()
```
    Return the potential consumers associated with this component. Subclasses should override this to make their consumers available.
    
    Returns:
    
    the consumer list.
  - getPotentialProducers
```
public java.util.List<PotentialProducer> getPotentialProducers()
```
    Return the potential producers associated with this component. Subclasses should override this to make their producers available.
    
    Returns:
    
    the producer list.
  - fireAttributeObjectRemoved
```
public void fireAttributeObjectRemoved(java.lang.Object object)
```
    Fire attribute object removed event (when the base object of an attribute is removed).
    
    Parameters:
    
    object - the object which was removed
  - firePotentialAttributesChanged
```
public void firePotentialAttributesChanged()
```
    Fire potential attributes changed event.
  - fireAttributeTypeVisibilityChanged
```
public void fireAttributeTypeVisibilityChanged(AttributeType type)
```
    Fire attribute type visibility changed event.
    
    Parameters:
    
    type - the type whose visibility changed.
  - addAttributeListener
```
public void addAttributeListener(AttributeListener listener)
```
    Adds a AttributeListener to this component.
    
    Parameters:
    
    listener - the AttributeListener to add.
  - removeAttributeListener
```
public void removeAttributeListener(AttributeListener listener)
```
    Removes an AttributeListener from this component.
    
    Parameters:
    
    listener - the AttributeListener to remove.
  - addProducerType
```
public void addProducerType(AttributeType type)
```
    Add a new type of producer.
    
    Parameters:
    
    type - type to add
  - addConsumerType
```
public void addConsumerType(AttributeType type)
```
    Add a new type of consumer.
    
    Parameters:
    
    type - type to add
  - getObjectFromKey
```
public java.lang.Object getObjectFromKey(java.lang.String objectKey)
```
    Finds objects based on a key. Used in deserializing attributes. Any class that produces attributes should override this for serialization.
    
    Parameters:
    
    objectKey - String key
    
    Returns:
    
    the corresponding object
  - getKeyFromObject
```
public java.lang.String getKeyFromObject(java.lang.Object object)
```
    Returns a unique key associated with an object. Used in serializing attributes. Any class that produces attributes should override this for serialization.
    
    Parameters:
    
    object - object which should be associated with a key
    
    Returns:
    
    the key
  - getUpdateParts
```
public java.util.Collection<ComponentUpdatePart> getUpdateParts()
```
    Returns the collection of update parts for this component.
    
    Returns:
    
    The collection of update parts for this component.
  - getLocks
```
public java.util.Collection<? extends java.lang.Object> getLocks()
```
    Returns the locks for the update parts. There should be one lock per part. These locks need to be the same ones used to lock the update of each part.
    
    Returns:
    
    The locks for the update parts.
  - stopped
```
protected void stopped()
```
    Called by Workspace to notify that updates have stopped.
  - fireUpdateEvent
```
public final void fireUpdateEvent()
```
    Notify all workspaceComponentListeners of a componentUpdated event.
  - fireGuiToggleEvent
```
public final void fireGuiToggleEvent()
```
    Notify all workspaceComponentListeners that the gui has been turned on or off.
  - fireComponentToggleEvent
```
public final void fireComponentToggleEvent()
```
    Notify all workspaceComponentListeners of a component has been turned on or off.
  - doStopped
```
final void doStopped()
```
    Called after a global update ends.
  - getWorkspaceComponentListeners
```
public java.util.Collection<WorkspaceComponentListener> getWorkspaceComponentListeners()
```
    Returns the WorkspaceComponentListeners on this component.
    
    Returns:
    
    The WorkspaceComponentListeners on this component.
  - addWorkspaceComponentListener
```
public void addWorkspaceComponentListener(WorkspaceComponentListener listener)
```
    Adds a WorkspaceComponentListener to this component.
    
    Parameters:
    
    listener - the WorkspaceComponentListener to add.
  - removeWorkspaceComponentListener
```
public void removeWorkspaceComponentListener(WorkspaceComponentListener listener)
```
    Adds a WorkspaceComponentListener to this component.
    
    Parameters:
    
    listener - the WorkspaceComponentListener to add.
  - getName
```
public java.lang.String getName()
```
    Returns the name of this component.
    
    Returns:
    
    The name of this component.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - setName
```
public void setName(java.lang.String name)
```
    Parameters:
    
    name - the name to set
  - getSimpleName
```
public java.lang.String getSimpleName()
```
    Retrieves a simple version of a component name from its class, e.g. "Network" from "org.simbrain.network.NetworkComponent"/
    
    Returns:
    
    the simple name.
  - getXML
```
public java.lang.String getXML()
```
    Override for use with open service.
    
    Returns:
    
    xml string representing stored file.
  - setWorkspace
```
public void setWorkspace(Workspace workspace)
```
    Sets the workspace for this component. Called by the workspace right after this component is created.
    
    Parameters:
    
    workspace - The workspace for this component.
  - getWorkspace
```
public Workspace getWorkspace()
```
    Returns the workspace associated with this component.
    
    Returns:
    
    The workspace associated with this component.
  - couplingRemoved
```
public void couplingRemoved(Coupling<?> coupling)
```
    Called when a coupling attached to this component is removed. This method will only be called once if this component has both the source and the target.
    
    Parameters:
    
    coupling - The coupling that has been removed.
  - couplingAdded
```
public void couplingAdded(Coupling<?> coupling)
```
    Called when a coupling is attached to this component.
    
    Parameters:
    
    coupling - The coupling that is being added
  - getDefaultFormat
```
public java.lang.String getDefaultFormat()
```
    The file extension for a component type, e.g. By default, "xml".
    
    Returns:
    
    the file extension
  - setChangedSinceLastSave
```
public void setChangedSinceLastSave(boolean changedSinceLastSave)
```
    Set to true when a component changes, set to false after a component is saved.
    
    Parameters:
    
    changedSinceLastSave - whether this component has changed since the last save.
  - hasChangedSinceLastSave
```
public boolean hasChangedSinceLastSave()
```
    Returns true if it's changed since the last save.
    
    Returns:
    
    the changedSinceLastSave
  - getCurrentFile
```
public java.io.File getCurrentFile()
```
    Returns:
    
    the currentFile
  - setCurrentFile
```
public void setCurrentFile(java.io.File currentFile)
```
    Parameters:
    
    currentFile - the currentFile to set
  - getLogger
```
public org.apache.log4j.Logger getLogger()
```
    Returns:
    
    the logger
  - setLogger
```
public void setLogger(org.apache.log4j.Logger logger)
```
    Parameters:
    
    logger - the logger to set
  - isGuiOn
```
public java.lang.Boolean isGuiOn()
```
    Returns:
    
    the guiOn
  - setGuiOn
```
public void setGuiOn(java.lang.Boolean guiOn)
```
    Parameters:
    
    guiOn - the guiOn to set
  - getUpdateOn
```
public java.lang.Boolean getUpdateOn()
```
    Returns:
    
    the updateOn
  - setUpdateOn
```
public void setUpdateOn(java.lang.Boolean updateOn)
```
    Parameters:
    
    updateOn - the updateOn to set
  - getProducerTypes
```
public java.util.List<AttributeType> getProducerTypes()
```
    Returns:
    
    the producerTypes
  - getConsumerTypes
```
public java.util.List<AttributeType> getConsumerTypes()
```
    Returns:
    
    the consumerTypes
  - getVisibleProducerTypes
```
public java.util.List<AttributeType> getVisibleProducerTypes()
```
    Return visible producer types.
    
    Returns:
    
    the visible producerTypes
  - getVisibleConsumerTypes
```
public java.util.List<AttributeType> getVisibleConsumerTypes()
```
    Return visible consumer types.
    
    Returns:
    
    the visible consumerTypes
  - getAttributeManager
```
public AttributeManager getAttributeManager()
```
    Returns:
    
    the attributeManager
  - getSerializePriority
```
protected int getSerializePriority()
```
    Returns:
    
    the serializePriority
  - setSerializePriority
```
protected void setSerializePriority(int serializePriority)
```
    Parameters:
    
    serializePriority - the serializePriority to set

Class WorkspaceComponent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkspaceComponent

Method Detail

save

getFormats

close

closing

update

getPotentialConsumers

getPotentialProducers

fireAttributeObjectRemoved

firePotentialAttributesChanged

fireAttributeTypeVisibilityChanged

addAttributeListener

removeAttributeListener

addProducerType

addConsumerType

getObjectFromKey

getKeyFromObject

getUpdateParts

getLocks

stopped

fireUpdateEvent

fireGuiToggleEvent

fireComponentToggleEvent

doStopped

getWorkspaceComponentListeners

addWorkspaceComponentListener

removeWorkspaceComponentListener

getName

toString

setName

getSimpleName

getXML

setWorkspace

getWorkspace

couplingRemoved

couplingAdded

getDefaultFormat

setChangedSinceLastSave

hasChangedSinceLastSave

getCurrentFile

setCurrentFile

getLogger

setLogger

isGuiOn

setGuiOn

getUpdateOn

setUpdateOn

getProducerTypes

getConsumerTypes

getVisibleProducerTypes

getVisibleConsumerTypes

getAttributeManager

getSerializePriority

setSerializePriority