org.trianacode.taskgraph.clipin

Class ClipInBucket

java.lang.Object

org.trianacode.taskgraph.clipin.ClipInBucket

All Implemented Interfaces:

java.io.Serializable

public class ClipInBucket
extends java.lang.Object
implements java.io.Serializable

Class Description Here...

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClipInBucket(Task task) Construct a bucket attached to the specified task

Method Summary

Methods

Modifier and Type	Method and Description
void	empty() Removes and finalizes all the clip-ins currently in the bucket.
ClipInBucket	extract(Node node) Extracts a copy of the clip-in bucket for attaching to the data being output from the task, finializing all the clip-ins in the extracted bucket This method is called when data is output by a unit.
ClipInStore	extractClipInStore()
java.lang.Object	getClipIn(java.lang.String name)
java.lang.String[]	getClipInNames()
Task	getTask()
void	insert(ClipInBucket insert, Node node) Inserts the clip-ins in the specified clip-in bucket into this bucket, intializing all the clip-ins in the insertion bucket.
boolean	isAttached()
boolean	isClipInName(java.lang.String name)
void	putClipIn(java.lang.String name, java.lang.Object clipin) Puts the specified clip-in into the bucket, initializing the clip-in being inserted.
java.lang.Object	removeClipIn(java.lang.String name) Removes the clip-in for the specified name from the bucket.
void	restoreClipInStore(ClipInStore store) Restores the state stored in a clip-in store

Methods inherited from class java.lang.Object

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

Constructor Detail

ClipInBucket

public ClipInBucket(Task task)

Construct a bucket attached to the specified task

Method Detail

getTask

public Task getTask()

Returns:

the task this bucket is attached to

isAttached

public boolean isAttached()

Returns:

true if this bucket is attached to a task

insert

public void insert(ClipInBucket insert,
          Node node)

Inserts the clip-ins in the specified clip-in bucket into this bucket, intializing all the clip-ins in the insertion bucket. This method is called when data is input by a unit.

Parameters:

insert - the clip-ins to be inserted into the bucket

node - the node the data arrived on

extract

public ClipInBucket extract(Node node)

Extracts a copy of the clip-in bucket for attaching to the data being output from the task, finializing all the clip-ins in the extracted bucket This method is called when data is output by a unit.

Parameters:

node - the node the data is being output from

empty

public void empty()

Removes and finalizes all the clip-ins currently in the bucket. This method is usually called after a unit has finished processing

putClipIn

public void putClipIn(java.lang.String name,
             java.lang.Object clipin)

Puts the specified clip-in into the bucket, initializing the clip-in being inserted. If there is already a clip-in for the specified name then that clip-in is finialized and removed.

removeClipIn

public java.lang.Object removeClipIn(java.lang.String name)

Removes the clip-in for the specified name from the bucket. The clip-in being removed is finalized.

Returns:

the removed clip-in (or null if unknown)

getClipIn

public java.lang.Object getClipIn(java.lang.String name)

Returns:

the clip-in with the specified name, or null if none exists. If the clip-in object is an instance of the ClipIn interface then a finalized copy is returned.

getClipInNames

public java.lang.String[] getClipInNames()

Returns:

an array of names of the clip-ins stored in this

isClipInName

public boolean isClipInName(java.lang.String name)

Returns:

true if a clip-in with the specified name exists in the bucket

extractClipInStore

public ClipInStore extractClipInStore()

Returns:

a store of the current clipin bucket state

restoreClipInStore

public void restoreClipInStore(ClipInStore store)

Restores the state stored in a clip-in store