org.simbrain.world.textworld

Class ReaderComponent

java.lang.Object

org.simbrain.workspace.WorkspaceComponent

org.simbrain.world.textworld.ReaderComponent

public class ReaderComponent
extends WorkspaceComponent

ReaderComponent is the container for the readerworld, which adds producers.

Constructor Summary

Constructors

Constructor and Description
ReaderComponent(java.lang.String name) Creates a new frame of type TextWorld.
ReaderComponent(java.lang.String name, ReaderWorld newWorld) Construct a component from an existing world; used in deserializing.

Method Summary

Modifier and Type	Method and Description
void	closing() Perform cleanup after closing.
java.lang.Object	getObjectFromKey(java.lang.String objectKey) Finds objects based on a key.
java.util.List<PotentialProducer>	getPotentialProducers() Return the potential producers associated with this component.
ReaderWorld	getWorld()
static ReaderComponent	open(java.io.InputStream input, java.lang.String name, java.lang.String format)
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, getKeyFromObject, getLocks, getLogger, getName, getPotentialConsumers, getProducerTypes, getSerializePriority, getSimpleName, getUpdateOn, getUpdateParts, getVisibleConsumerTypes, getVisibleProducerTypes, getWorkspace, getWorkspaceComponentListeners, getXML, 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

Constructor Detail

ReaderComponent

public ReaderComponent(java.lang.String name)

Creates a new frame of type TextWorld.

Parameters:

name - name of this component

ReaderComponent

public ReaderComponent(java.lang.String name,
                       ReaderWorld newWorld)

Construct a component from an existing world; used in deserializing.

Parameters:

name - name of component

newWorld - provided world

Method Detail

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.

open

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

Parameters:

input -

name -

format -

Returns:

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.

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

getWorld

public ReaderWorld getWorld()

Returns:

the world

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