org.kepler.provenance.manager

Class TransferComponent

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<ComponentPort>

org.kepler.provenance.manager.TransferComponent

All Implemented Interfaces:

java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class TransferComponent
extends ComponentEntity<ComponentPort>

A ComponentEntity that contains a list of provenance execution KeplerLSIDs. An instance of this class is used as the "save initiator" in KAR files.

Author:

Daniel Crawl

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
Parameter	runLSIDs A parameter that contains a set of parameters, each of which has an provenance execution KeplerLSID as the value.

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

Constructors

Constructor and Description
TransferComponent(CompositeEntity container, java.lang.String name) Create a new TransferComponent in a container with a name.
TransferComponent(java.lang.String format) Create a new TransferComponent.

Method Summary

Modifier and Type	Method and Description
void	addExecutions(java.util.List<KeplerLSID> executionLSIDs) Add KeplerLSIDs for provenance executions.
java.util.List<KeplerLSID>	getExecutionLSIDs() Get the KeplerLSIDs for provenance executions.
java.lang.String	getFormat() Get the provenance format.

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, clone, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, newPort, propagateExistence, setContainer, setName

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, connectionsChanged, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getDisplayName, getFullName, getName, getName

Field Detail

runLSIDs

public Parameter runLSIDs

A parameter that contains a set of parameters, each of which has an provenance execution KeplerLSID as the value.

Constructor Detail

TransferComponent

public TransferComponent(java.lang.String format)
                  throws IllegalActionException,
                         NameDuplicationException

Create a new TransferComponent.

Parameters:

format - The provenance format.

Throws:

IllegalActionException

NameDuplicationException

TransferComponent

public TransferComponent(CompositeEntity container,
                         java.lang.String name)
                  throws NameDuplicationException,
                         IllegalActionException

Create a new TransferComponent in a container with a name.

Throws:

NameDuplicationException

IllegalActionException

Method Detail

addExecutions

public void addExecutions(java.util.List<KeplerLSID> executionLSIDs)
                   throws IllegalActionException

Add KeplerLSIDs for provenance executions. This method removes any existing KeplerLSIDs before adding the new ones.

Throws:

IllegalActionException

getExecutionLSIDs

public java.util.List<KeplerLSID> getExecutionLSIDs()
                                             throws IllegalActionException

Get the KeplerLSIDs for provenance executions.

Throws:

IllegalActionException

getFormat

public java.lang.String getFormat()

Get the provenance format.