triana.types.clipins

Class DefaultHistoryClipIn

java.lang.Object

triana.types.clipins.DefaultHistoryClipIn

All Implemented Interfaces:

java.io.Serializable, ClipIn, HistoryClipIn

public class DefaultHistoryClipIn
extends java.lang.Object
implements HistoryClipIn

The history clip-in dynamically builds a taskgraph containing the tasks that it passes through. This taskgraph provides a history of how the data set it is attached to was generated. When run this taskgraph should reproduce the data set.

When data is generated from multiple input data sets, the histroy clip-ins from the inputs are combined to produce a single taskgraph.

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.trianacode.taskgraph.clipin.HistoryClipIn

HISTORY_CLIPIN_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultHistoryClipIn()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Clones the ClipIn to an identical one.
void	finalizeAttach(AttachInfo info) This method is called when the clip-in is removed from a task's clip-in bucket.
TaskGraph	getHistory()
void	initializeAttach(AttachInfo info) This method is called before the clip-in enters a task's clip-in bucket.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHistoryClipIn

public DefaultHistoryClipIn()

Method Detail

getHistory

public TaskGraph getHistory()

Specified by:

getHistory in interface HistoryClipIn

Returns:

the history taskgraph that has been constructed

initializeAttach

public void initializeAttach(AttachInfo info)

This method is called before the clip-in enters a task's clip-in bucket. This occurs when either the data it is attached to is input by the task, or when the unit directly adds the clip-in to its bucket.

Specified by:

initializeAttach in interface ClipIn

Parameters:

info - info about the task the clip-in is being attached to

finalizeAttach

public void finalizeAttach(AttachInfo info)

This method is called when the clip-in is removed from a task's clip-in bucket. This occurs when either the data it is attached to is output by the task, or when the unit directly remove the clip-in from its bucket.

Specified by:

finalizeAttach in interface ClipIn

Parameters:

info - info about the task the clip-in is being removed from

clone

public java.lang.Object clone()

Clones the ClipIn to an identical one. This is a copy by value, not by reference. This method must be implemented for each class in a way that depends on the contents of the ClipIn.

Specified by:

clone in interface ClipIn

Overrides:

clone in class java.lang.Object

Returns:

a copy by value of the current ClipIn