org.simbrain.plot.histogram

Class HistogramComponent

java.lang.Object

org.simbrain.workspace.WorkspaceComponent

org.simbrain.plot.histogram.HistogramComponent

public class HistogramComponent
extends WorkspaceComponent

The Component representation of a histogram. Contains attributes that allow other components to couple to this one.

Constructor Summary

Constructors

Constructor and Description
HistogramComponent(java.lang.String name) Create new Histogram Component.
HistogramComponent(java.lang.String name, HistogramModel model) Create new Histogram Component from a specified model.

Method Summary

Modifier and Type	Method and Description
void	closing() Perform cleanup after closing.
HistogramModel	getModel() Returns model.
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 HistogramComponent	open(java.io.InputStream input, java.lang.String name, java.lang.String format) Opens a saved bar chart.
void	save(java.io.OutputStream output, java.lang.String format) Used when saving a workspace.

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, update

Methods inherited from class java.lang.Object

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

Constructor Detail

HistogramComponent

public HistogramComponent(java.lang.String name)

Create new Histogram Component.

Parameters:

name - chart name

HistogramComponent

public HistogramComponent(java.lang.String name,
                          HistogramModel model)

Create new Histogram Component from a specified model. Used in deserializing.

Parameters:

name - chart name

model - chart model

Method Detail

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

getModel

public HistogramModel getModel()

Returns model.

Returns:

the model.

open

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

Opens a saved bar chart.

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)

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

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.

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.