common.input

Class SequenceBuffer

java.lang.Object

org.trianacode.taskgraph.Unit

common.input.SequenceBuffer

All Implemented Interfaces:

TaskListener

public class SequenceBuffer
extends Unit
implements TaskListener

An input buffer that stores a sequence of TrianaTypes, it has a control GUI with play/fwd/rev/stop buttons and it outputs the stored datatypes in order.

Field Summary

Fields inherited from class org.trianacode.taskgraph.Unit

CLONE_ALL_OUTPUT, CLONE_MULTIPLE_OUTPUT, COPY_OUTPUT, ESSENTIAL, ESSENTIAL_IF_CONNECTED, IMMEDIATE_UPDATE, INTERNAL, LATE_INITIALIZE, NO_UPDATE, ON_TASK_INSTANTATION, ON_USER_ACCESS, OPTIONAL, PROCESS_UPDATE, TRANSIENT, TRANSIENT_ACCESSIBLE, USER_ACCESSIBLE

Constructor Summary

Constructors

Constructor and Description
SequenceBuffer()

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() Called when the unit is disposed of.
java.lang.String[]	getInputTypes() This method should return an array of the data types accepted by nodes not specified in getNodeInputTypes (e.g.
java.lang.String[]	getOutputTypes() This method should return an array of the data types output by nodes not specified in getNodeOutputTypes() (e.g.
void	init() Called when the unit is created.
void	nodeAdded(TaskNodeEvent event) Called when a data input node is added to the task.
void	nodeRemoved(TaskNodeEvent event) Called before a data input node is removed from the task.
void	parameterUpdate(java.lang.String paramname, java.lang.Object value) Called when the value of a parameter is changed, including when a parameter is removed.
void	parameterUpdated(ParameterUpdateEvent event) Called when the value of a parameter is changed, including when a parameter is removed.
void	process() The main unit algorithm.
void	reset() Called when the unit is reset.
void	taskDisposed(TaskDisposedEvent event) Called before the task is disposed
void	taskPropertyUpdate(TaskPropertyEvent event) Called when the core properties of the task change i.e.

Methods inherited from class org.trianacode.taskgraph.Unit

debug, debug, defineParameter, extractClipInState, getClipIn, getClipIn, getControlInterface, getDefaultInputNodes, getDefaultNodeRequirement, getDefaultOutputNodes, getDisplayName, getDisplayPackage, getGUIBuilderV2Info, getHelpFileLocation, getInputAtNode, getInputNodeCount, getMaximumInputNodes, getMaximumOutputNodes, getMinimumInputNodes, getMinimumOutputNodes, getNodeInputTypes, getNodeOutputTypes, getOutputNodeCount, getOutputPolicy, getPackageName, getParameter, getParameterPanelClass, getParameterPanelInstantiate, getParameterType, getParameterUpdatePolicy, getPopUpDescription, getRunnableInterface, getTask, getTaskGraphContext, getToolName, getToolPackage, getToolTable, getVersion, hideParameterPanel, isClipInName, isInputAtNode, isOutputSent, isParameter, log, log, notifyError, notifyError, output, outputAtNode, outputAtNode, parameterUpdated, putClipIn, removeClipIn, removeParameter, restoreClipInState, setDefaultInputNodes, setDefaultNodeRequirement, setDefaultOutputNodes, setDisplayName, setDisplayPackage, setGUIBuilderV2Info, setHelpFileLocation, setMaximumInputNodes, setMaximumOutputNodes, setMinimumInputNodes, setMinimumOutputNodes, setOutputPolicy, setParameter, setParameterPanelClass, setParameterPanelInstantiate, setParameterUpdatePolicy, setPopUpDescription, setRunnableInterface, setToolName, setToolPackage, setVersion, showParameterPanel, stopping

Methods inherited from class java.lang.Object

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

Constructor Detail

SequenceBuffer

public SequenceBuffer()

Method Detail

process

public void process()
             throws java.lang.Exception

Description copied from class: Unit

The main unit algorithm. This method should be implemented with the appropriate algorihtm for the unit (if no algorithm is implemented deadlock occurs).

Specified by:

process in class Unit

Throws:

java.lang.Exception

init

public void init()

Called when the unit is created. Initialises the unit's properties and parameters.

Overrides:

init in class Unit

reset

public void reset()

Called when the unit is reset.

Overrides:

reset in class Unit

dispose

public void dispose()

Called when the unit is disposed of.

Overrides:

dispose in class Unit

getInputTypes

public java.lang.String[] getInputTypes()

Description copied from class: Unit

This method should return an array of the data types accepted by nodes not specified in getNodeInputTypes (e.g. triana.types.VectorType). If no package is specified then triana.types is assumed.

Specified by:

getInputTypes in class Unit

Returns:

an array of the input types for SequenceBuffer

getOutputTypes

public java.lang.String[] getOutputTypes()

Description copied from class: Unit

This method should return an array of the data types output by nodes not specified in getNodeOutputTypes() (e.g. triana.types.VectorType). If no package is specified then triana.types is assumed.

Specified by:

getOutputTypes in class Unit

Returns:

an array of the output types for SequenceBuffer

parameterUpdate

public void parameterUpdate(java.lang.String paramname,
                   java.lang.Object value)

Called when the value of a parameter is changed, including when a parameter is removed.

Overrides:

parameterUpdate in class Unit

taskPropertyUpdate

public void taskPropertyUpdate(TaskPropertyEvent event)

Called when the core properties of the task change i.e. its name

Specified by:

taskPropertyUpdate in interface TaskListener

parameterUpdated

public void parameterUpdated(ParameterUpdateEvent event)

Called when the value of a parameter is changed, including when a parameter is removed.

Specified by:

parameterUpdated in interface TaskListener

nodeAdded

public void nodeAdded(TaskNodeEvent event)

Called when a data input node is added to the task.

Specified by:

nodeAdded in interface TaskListener

nodeRemoved

public void nodeRemoved(TaskNodeEvent event)

Called before a data input node is removed from the task.

Specified by:

nodeRemoved in interface TaskListener

taskDisposed

public void taskDisposed(TaskDisposedEvent event)

Called before the task is disposed

Specified by:

taskDisposed in interface TaskListener