org.kepler.util

Class WorkflowRun

java.lang.Object

ptolemy.kernel.util.NamedObj

org.kepler.util.WorkflowRun

All Implemented Interfaces:

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

public class WorkflowRun
extends NamedObj

A class containing workflow execution metadata.

Author:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkflowRun.RunAttribute
static class	WorkflowRun.type

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILENAME_EXTENSION
static org.apache.commons.logging.Log	log
static java.lang.String	RUN_DATE_FORMAT
static java.lang.String	TAG_TYPE_RUN
static java.lang.String	TAG_TYPE_WORKFLOW
static java.lang.String	WORKFLOWRUN_SELECTED

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
WorkflowRun()
WorkflowRun(KeplerLSID runlsid, java.lang.String referralList, java.lang.String theUser, java.lang.String workflowName, KeplerLSID wfLSID, java.util.Date start, java.lang.Long dur, java.lang.Integer execid, java.util.Map<java.lang.Integer,java.lang.String> errorMsgs, java.lang.String host_id, java.lang.String anno, java.lang.String module_dependencies, java.lang.String type, java.util.Map<NamedOntClass,java.lang.String> tagsList) Constructor.
WorkflowRun(Workspace workspace, java.lang.String string)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	_description(int detail, int indent, int bracket) Return a description of the object.
java.lang.String	getAnnotation() Get the WorkflowRun annotation.
java.lang.Long	getDuration() Get the duration in Seconds of the WorkflowRun.
java.lang.String	getElementName() Get the MoML element name.
java.util.Map<java.lang.Integer,java.lang.String>	getErrorMessages()
java.lang.Integer	getExecId() Return the execution ID.
KeplerLSID	getExecLSID()
java.lang.String	getHostId()
java.lang.String	getModuleDependencies() Get the WorkflowRun module-dependencies.
java.util.List<KeplerLSID>	getReferralList()
java.util.Date	getStartTime()
java.lang.String	getStartTimeISO8601()
java.util.Map<NamedOntClass,java.lang.String>	getTags()
java.lang.String	getTagsAsFormattedString()
java.lang.String	getType()
java.lang.String	getUser()
KeplerLSID	getWorkflowLSID() Return the LSID of the workflow that this WorkflowRun was generated from.
java.lang.String	getWorkflowName() Return the name of the workflow that this run was generated from.
java.util.Vector<SemanticType>	getWorkflowSemanticTypes()
void	resetExecId(int newExecId, Recording r) Assign new execId to a run, and entityId revision.
void	resetType(java.lang.String workflowRunType, Recording r)
void	rollRevision(KeplerLSID lsid, Recording recording) Whenever a run is changed, update revision in OM, update run's execLSID, and update workflow_exec lsid in provenance.
void	setName(java.lang.String name) Set or change the name.
java.lang.String	toString() Return the class name and the full name of the object, with syntax "className {fullName}".

Methods inherited from class ptolemy.kernel.util.NamedObj

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

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.apache.commons.logging.Log log

TAG_TYPE_WORKFLOW

public static final java.lang.String TAG_TYPE_WORKFLOW

See Also:

Constant Field Values

TAG_TYPE_RUN

public static final java.lang.String TAG_TYPE_RUN

See Also:

Constant Field Values

FILENAME_EXTENSION

public static final java.lang.String FILENAME_EXTENSION

See Also:

Constant Field Values

RUN_DATE_FORMAT

public static final java.lang.String RUN_DATE_FORMAT

See Also:

Constant Field Values

WORKFLOWRUN_SELECTED

public static java.lang.String WORKFLOWRUN_SELECTED

Constructor Detail

WorkflowRun

public WorkflowRun(Workspace workspace,
                   java.lang.String string)
            throws IllegalActionException

Throws:

IllegalActionException

WorkflowRun

public WorkflowRun()
            throws IllegalActionException

Throws:

IllegalActionException

WorkflowRun

public WorkflowRun(KeplerLSID runlsid,
                   java.lang.String referralList,
                   java.lang.String theUser,
                   java.lang.String workflowName,
                   KeplerLSID wfLSID,
                   java.util.Date start,
                   java.lang.Long dur,
                   java.lang.Integer execid,
                   java.util.Map<java.lang.Integer,java.lang.String> errorMsgs,
                   java.lang.String host_id,
                   java.lang.String anno,
                   java.lang.String module_dependencies,
                   java.lang.String type,
                   java.util.Map<NamedOntClass,java.lang.String> tagsList)
            throws java.lang.Exception

Constructor.

Parameters:

runlsid -

theUser -

workflowName -

start -

dur -

execid -

errorMsgs -

host_id -

anno -

tagsList -

wflsid -

replaceInObjectManager - - attempt to replace any preexisting version in ObjectManager, taking on preexisting version's entity id.

Throws:

java.lang.Exception

Method Detail

getExecLSID

public KeplerLSID getExecLSID()

getReferralList

public java.util.List<KeplerLSID> getReferralList()

getWorkflowLSID

public KeplerLSID getWorkflowLSID()

Return the LSID of the workflow that this WorkflowRun was generated from.

Returns:

KeplerLSID

getAnnotation

public java.lang.String getAnnotation()

Get the WorkflowRun annotation.

Returns:

getModuleDependencies

public java.lang.String getModuleDependencies()

Get the WorkflowRun module-dependencies.

Returns:

moduleDependencies

getHostId

public java.lang.String getHostId()

getType

public java.lang.String getType()

getUser

public java.lang.String getUser()

getWorkflowName

public java.lang.String getWorkflowName()

Return the name of the workflow that this run was generated from.

Returns:

String the name of the workflow that generated this run

getStartTimeISO8601

public java.lang.String getStartTimeISO8601()

getStartTime

public java.util.Date getStartTime()

getDuration

public java.lang.Long getDuration()

Get the duration in Seconds of the WorkflowRun.

Returns:

Long

getExecId

public java.lang.Integer getExecId()

Return the execution ID.

Returns:

resetExecId

public void resetExecId(int newExecId,
                        Recording r)

Assign new execId to a run, and entityId revision. *Note: This should probably only be called in the special insertHuskRun case.

resetType

public void resetType(java.lang.String workflowRunType,
                      Recording r)

getErrorMessages

public java.util.Map<java.lang.Integer,java.lang.String> getErrorMessages()

toString

public java.lang.String toString()

Description copied from class: NamedObj

Return the class name and the full name of the object, with syntax "className {fullName}".

Overrides:

toString in class NamedObj

Returns:

The class name and the full name.

rollRevision

public void rollRevision(KeplerLSID lsid,
                         Recording recording)

Whenever a run is changed, update revision in OM, update run's execLSID, and update workflow_exec lsid in provenance.

getWorkflowSemanticTypes

public java.util.Vector<SemanticType> getWorkflowSemanticTypes()

getTags

public java.util.Map<NamedOntClass,java.lang.String> getTags()

getTagsAsFormattedString

public java.lang.String getTagsAsFormattedString()

_description

protected java.lang.String _description(int detail,
                                        int indent,
                                        int bracket)
                                 throws IllegalActionException

Return a description of the object. The level of detail depends on the argument, which is an or-ing of the static final constants defined in this class (NamedObj). Lines are indented according to to the level argument using the static method _getIndentPrefix(). Zero, one or two brackets can be specified to surround the returned description. If one is specified it is the the leading bracket. This is used by derived classes that will append to the description. Those derived classes are responsible for the closing bracket. An argument other than 0, 1, or 2 is taken to be equivalent to 0. This method is read-synchronized on the workspace.

Overrides:

_description in class NamedObj

Parameters:

detail - The level of detail.

indent - The amount of indenting.

bracket - The number of surrounding brackets (0, 1, or 2).

Returns:

A description of the object.

Throws:

IllegalActionException

getElementName

public java.lang.String getElementName()

Description copied from class: NamedObj

Get the MoML element name. This defaults to "entity" but can be set to something else by subclasses.

Specified by:

getElementName in interface MoMLExportable

Overrides:

getElementName in class NamedObj

Returns:

The MoML element name for this object.

See Also:

MoMLExportable

setName

public void setName(java.lang.String name)
             throws IllegalActionException,
                    NameDuplicationException

Description copied from class: NamedObj

Set or change the name. If a null argument is given the name is set to an empty string. Increment the version of the workspace. This method is write-synchronized on the workspace.

Specified by:

setName in interface Nameable

Overrides:

setName in class NamedObj

Parameters:

name - The new name.

Throws:

IllegalActionException - If the name contains a period or if the object is a derived object and the name argument does not match the current name.

NameDuplicationException - Not thrown in this base class. May be thrown by derived classes if the container already contains an object with this name.

See Also:

NamedObj.getName(), NamedObj.getName(NamedObj)