org.kepler.ddp.actor.pattern

Class SingleInputPatternActor

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity

ptolemy.kernel.CompositeEntity

ptolemy.actor.CompositeActor

ptolemy.actor.TypedCompositeActor

org.kepler.ddp.actor.pattern.SingleInputPatternActor

All Implemented Interfaces:

java.lang.Cloneable, DDPPatternActor, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Direct Known Subclasses:

DualInputPatternActor, Map, Reduce

public class SingleInputPatternActor
extends TypedCompositeActor
implements DDPPatternActor

A DDP pattern composite actor with a single input.

Author:

Daniel Crawl

Nested Class Summary

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

CompositeEntity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_executionClassName The execution class name.
protected java.lang.String	_executionCodeType The execution code type.
Parameter	degreeOfParallelism The number of parallel instances to execute.
StringParameter	displayRedirectDir The directory where the display related actors in DDP pattern sub-workflows will save their outputs.
StringParameter	executionClass The name of the execution class.
StringParameter	executionCode The type of the execution code.
TypedIOPort	in Data input.
StringParameter	inKeyValueTypes The input key value types.
StringParameter	jars A comma-separated list of jars to use with this actor.
TypedIOPort	out Data output.
StringParameter	outKeyValueTypes The output key value types.
Parameter	printExeSummary If true, print an execution summary to the log file each time the sub-workflow executes in the Hadoop or Stratosphere job.
Parameter	runWorkflowLifecyclePerInput If true, the full lifecycle of the sub-workflow will be executed for each input.

Fields inherited from class ptolemy.actor.CompositeActor

_actorFiringListeners, _causalityInterface, _derivedPiggybacks, _initializables, _notifyingActorFiring, _piggybacks, _publishedPorts, _publisherRelations, _stopRequested, _subscribedPorts

Fields inherited from class ptolemy.kernel.CompositeEntity

_levelCrossingLinks

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

Fields inherited from interface org.kepler.ddp.actor.pattern.DDPPatternActor

_commonKeyValueTypes

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor and Description
SingleInputPatternActor(CompositeEntity container, java.lang.String name) Construct a new SingleInputPatternActor in a container with a given name.
SingleInputPatternActor(Workspace workspace) Construct a new SingleInputPatternActor for a workspace.

Method Summary

Modifier and Type	Method and Description
void	attributeChanged(Attribute attribute) React to a change in an attribute.
java.util.List<?>	deepEntityList() List the opaque entities that are directly or indirectly contained by this entity.
java.util.List<?>	entityList() List the opaque entities that are directly or indirectly contained by this entity.
int	getDegreeOfParallelism() Get the number of parallel instances to execute.
java.lang.String	getDisplayRedirectDir() Get the dir to redirect display related actors.
java.lang.String	getExecutionClassName() Get the name of the execution class.
java.lang.String	getExecutionCode() Get the execution code.
java.lang.String	getExecutionCodeType() Get the execution code type.
java.lang.String	getJars() Get a comma-separated list of jars to use with this actor.
java.util.Map<java.lang.String,java.lang.String>	getParaImplNames(java.lang.String engineName) Get a set of (kepler name, implementation name) pairs of input/output format parameters for the execution engine.
java.util.Map<java.lang.String,java.lang.String>	getParameters() Get a set of name-value pairs of input/output format parameters for the execution engine.
boolean	getPrintExeInfo() Get whether print execution summary when running workflow inside of Hadoop/Stratosphere job.
boolean	getRunWorkflowLifecyclePerInput() Check if the full lifecycle of the sub-workflow should be executed for each input.
void	preinitialize() Override the parent class to check that parameter values are correctly set.

Methods inherited from class ptolemy.actor.TypedCompositeActor

_addEntity, _addPort, _addRelation, _checkTypesFromTo, _destinationTypeConstraints, attributeTypeChanged, isBackwardTypeInferenceEnabled, newPort, newRelation, resolveTypes, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.CompositeActor

_actorFiring, _actorFiring, _finishedAddEntity, _setDirector, _transferPortParameterInputs, addActorFiringListener, addInitializable, addPiggyback, clone, connectionsChanged, createReceivers, createSchedule, fire, getCausalityInterface, getDirector, getExecutiveDirector, getManager, getPublishedPort, getPublishedPortChannel, getPublishedPorts, getSubscribedPortChannel, inferringWidths, inferWidths, initialize, inputPortList, isFireFunctional, isOpaque, isPublishedPort, isStrict, iterate, linkToPublishedPort, linkToPublishedPort, linkToPublishedPort, linkToPublishedPort, needsWidthInference, newInsideReceiver, newReceiver, notifyConnectivityChange, outputPortList, postfire, prefire, recordFiring, registerPublisherPort, registerPublisherPort, removeActorFiringListener, removeInitializable, removePiggyback, requestChange, setContainer, setDirector, setManager, stop, stopFire, terminate, unlinkToPublishedPort, unlinkToPublishedPort, unlinkToPublishedPort, unlinkToPublishedPort, unregisterPublisherPort, unregisterPublisherPort, wrapup

Methods inherited from class ptolemy.kernel.CompositeEntity

_adjustDeferrals, _containedDecorators, _deepOpaqueEntityList, _description, _exportMoMLContents, _removeEntity, _removeRelation, _validateSettables, allAtomicEntityList, allowLevelCrossingConnect, classDefinitionList, connect, connect, containedObjectsIterator, deepCompositeEntityList, deepGetEntities, deepNamedObjList, deepOpaqueEntityList, deepRelationSet, entityList, exportLinks, exportMoML, getAttribute, getEntities, getEntity, getPort, getRelation, getRelations, isAtomic, lazyAllAtomicEntityList, lazyAllCompositeEntityList, lazyAllCompositeTransparentAndOpaqueEntityList, lazyClassDefinitionList, lazyDeepEntityList, lazyEntityList, lazyRelationList, numberOfEntities, numberOfRelations, numEntities, numRelations, relationList, removeAllEntities, removeAllRelations, setClassDefinition, statistics, uniqueName

Methods inherited from class ptolemy.kernel.ComponentEntity

_checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_removePort, connectedPortList, connectedPorts, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

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

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, 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, 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 org.kepler.ddp.actor.pattern.DDPPatternActor

clone, exportMoML, getAttribute, getPort, isOpaque, portList

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

fire, isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

in

public TypedIOPort in

Data input.

out

public TypedIOPort out

Data output.

degreeOfParallelism

public Parameter degreeOfParallelism

The number of parallel instances to execute.

executionClass

public StringParameter executionClass

The name of the execution class. If not set, the sub-workflow is executed. To use a class not included with Kepler, add the class's jar to the jars parameter.

displayRedirectDir

public StringParameter displayRedirectDir

The directory where the display related actors in DDP pattern sub-workflows will save their outputs. If it is empty, the display actors will be discarded before execution. More information about display redirect can be found at display-redirect module.

inKeyValueTypes

public StringParameter inKeyValueTypes

The input key value types. This parameter should only be set when executionClass is specified.

outKeyValueTypes

public StringParameter outKeyValueTypes

The output key value types. This parameter should only be set when executionClass is specified.

jars

public StringParameter jars

A comma-separated list of jars to use with this actor. The full path to each jar must be specified.

printExeSummary

public Parameter printExeSummary

If true, print an execution summary to the log file each time the sub-workflow executes in the Hadoop or Stratosphere job. NOTE: this can severely impact performance and should only be used for debugging.

runWorkflowLifecyclePerInput

public Parameter runWorkflowLifecyclePerInput

If true, the full lifecycle of the sub-workflow will be executed for each input. By setting this to true, multiple outputs can be collected for each input. If false, a single iteration of the workflow is performed for each input and only a single output may be generated. Performance is very slow if this is set to true.

executionCode

public StringParameter executionCode

The type of the execution code.

_executionClassName

protected java.lang.String _executionClassName

The execution class name.

_executionCodeType

protected java.lang.String _executionCodeType

The execution code type.

Constructor Detail

SingleInputPatternActor

public SingleInputPatternActor(Workspace workspace)

Construct a new SingleInputPatternActor for a workspace.

SingleInputPatternActor

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

Construct a new SingleInputPatternActor in a container with a given name.

Throws:

IllegalActionException

NameDuplicationException

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

React to a change in an attribute.

Overrides:

attributeChanged in class TypedCompositeActor

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - Not thrown in this base class. Derived classes can throw this exception if type change is not allowed.

deepEntityList

public java.util.List<?> deepEntityList()

List the opaque entities that are directly or indirectly contained by this entity. During model preinitializing and resolving types, if using a class or code for execution, there will be no such entities.

Overrides:

deepEntityList in class CompositeEntity

Returns:

A list of opaque ComponentEntity objects.

See Also:

CompositeEntity.classDefinitionList(), CompositeEntity.allAtomicEntityList()

entityList

public java.util.List<?> entityList()

List the opaque entities that are directly or indirectly contained by this entity. During model preinitializing and resolving types, if using a class or code for execution, there will be no such entities.

Overrides:

entityList in class CompositeEntity

Returns:

A list of ComponentEntity objects.

See Also:

CompositeEntity.classDefinitionList()

getDegreeOfParallelism

public int getDegreeOfParallelism()
                           throws IllegalActionException

Get the number of parallel instances to execute.

Specified by:

getDegreeOfParallelism in interface DDPPatternActor

Throws:

IllegalActionException

getDisplayRedirectDir

public java.lang.String getDisplayRedirectDir()
                                       throws IllegalActionException

Get the dir to redirect display related actors.

Specified by:

getDisplayRedirectDir in interface DDPPatternActor

Throws:

IllegalActionException

getExecutionClassName

public java.lang.String getExecutionClassName()

Get the name of the execution class. If no execution class is set, i.e., for this class the sub-workflow is to be executed, returns the empty string.

Specified by:

getExecutionClassName in interface DDPPatternActor

getExecutionCodeType

public java.lang.String getExecutionCodeType()
                                      throws IllegalActionException

Get the execution code type. Returns null if not set.

Specified by:

getExecutionCodeType in interface DDPPatternActor

Throws:

IllegalActionException

getExecutionCode

public java.lang.String getExecutionCode()
                                  throws IllegalActionException

Get the execution code. Returns null if not set.

Specified by:

getExecutionCode in interface DDPPatternActor

Throws:

IllegalActionException

getJars

public java.lang.String getJars()
                         throws IllegalActionException

Get a comma-separated list of jars to use with this actor.

Specified by:

getJars in interface DDPPatternActor

Throws:

IllegalActionException

getPrintExeInfo

public boolean getPrintExeInfo()
                        throws IllegalActionException

Get whether print execution summary when running workflow inside of Hadoop/Stratosphere job.

Specified by:

getPrintExeInfo in interface DDPPatternActor

Throws:

IllegalActionException

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()
                                                               throws IllegalActionException

Get a set of name-value pairs of input/output format parameters for the execution engine.

Specified by:

getParameters in interface DDPPatternActor

Throws:

IllegalActionException

getParaImplNames

public java.util.Map<java.lang.String,java.lang.String> getParaImplNames(java.lang.String engineName)
                                                                  throws IllegalActionException

Get a set of (kepler name, implementation name) pairs of input/output format parameters for the execution engine.

Specified by:

getParaImplNames in interface DDPPatternActor

Throws:

IllegalActionException

getRunWorkflowLifecyclePerInput

public boolean getRunWorkflowLifecyclePerInput()
                                        throws IllegalActionException

Check if the full lifecycle of the sub-workflow should be executed for each input.

Throws:

IllegalActionException

preinitialize

public void preinitialize()
                   throws IllegalActionException

Override the parent class to check that parameter values are correctly set.

Specified by:

preinitialize in interface Initializable

Overrides:

preinitialize in class CompositeActor

Throws:

IllegalActionException - If there is no director, or if the director's preinitialize() method throws it, or if this actor is not opaque.