org.kepler.ddp.director

Class DDPDirector

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.actor.Director

org.kepler.ddp.director.DDPDirector

All Implemented Interfaces:

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

Direct Known Subclasses:

HadoopDirector, StratosphereDirector

public class DDPDirector
extends Director

A director that converts DDP pattern actors (Map, Reduce, Cross, CoGroup, and Match) and I/O actors (DDPDataSink and DDPDataSource) into a job that is executed on a DDP engine such as Hadoop or Stratosphere.

NOTE: Only DDP pattern and I/O actors may be present in the workflow. Other actors must placed inside the composite pattern actors or in a different sub-workflow.

Author:

Daniel Crawl

Nested Class Summary

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

NamedObj.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
StringParameter	configDir DDP engine configuration directory.
static IntToken	DEFAULT_INTTOKEN The value used to signify the default degree of parallelism for the degreeOfParallelism parameter.
static java.lang.String	DEFAULT_NAME The name of the DEFAULT degree of parallelism parameter.
Parameter	degreeOfParallelism The default degree of parallelism for ddp pattern actors.
StringParameter	displayRedirectDir The directory where the display related actors in DDP pattern sub-workflows will save their outputs.
static java.lang.String	DISTRIBUTED_STRING String for serverType parameter for running DDP Engine in a distributed environment.
StringParameter	engine The execution engine.
StringParameter	includeJars A comma-separated list of jar files to include.
StringParameter	jobArguments A comma-separated list of arguments for the job.
static java.lang.String	SAME_JVM_STRING String for serverType parameter for running DDP Engine in the same JVM.
StringParameter	startServerType The type of DDP server to start (if one is not running).
Parameter	writeSubWorkflowsToFiles If true, sub-workflows are written to files in a directory.

Fields inherited from class ptolemy.actor.Director

_actorsFinishedExecution, _aspectForActor, _aspectsPresent, _defaultMicrostep, _executionAspects, _finishRequested, _initializables, _nextScheduleTime, _stopRequested, _tokenSentToCommunicationAspect, _zeroTime, localClock, startTime, stopTime

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 ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	attributeChanged(Attribute attribute) React to a change in an attribute.
java.lang.Object	clone(Workspace workspace) Clone the object into the specified workspace.
void	fire() Run the engine.
java.lang.String	getDisplayRedirectDir() Get the dir to redirect display related actors.
java.lang.String	getEngineName() Get the name of the DDP engine.
boolean	postfire() Postfire the engine.
void	preinitialize() Preinitialize the engine.
void	stop() Stop any running DDP jobs.
void	wrapup() Perform any cleanup in the engine.

Methods inherited from class ptolemy.actor.Director

_actorFinished, _consultTimeRegulators, _description, _isEmbedded, _isTopLevel, _schedule, _transferInputs, _transferOutputs, addInitializable, createSchedule, defaultDependency, delayDependency, elapsedTimeSinceStart, finish, fireAt, fireAt, fireAt, fireAtCurrentTime, fireContainerAt, fireContainerAt, getCausalityInterface, getCurrentTime, getDeadline, getEnvironmentTime, getExecutionAspect, getGlobalTime, getModelNextIterationTime, getModelStartTime, getModelStopTime, getModelTime, getNextIterationTime, getStartTime, getStopTime, getTimeResolution, implementsStrictActorSemantics, initialize, initialize, invalidateResolvedTypes, invalidateSchedule, isEmbedded, isFireFunctional, isStopRequested, isStrict, iterate, mutexLockObject, newReceiver, notifyTokenSentToCommunicationAspect, prefire, preinitialize, removeInitializable, requestInitialization, resume, resumeActor, scheduleContainedActors, setContainer, setCurrentTime, setEmbedded, setModelTime, setTimeResolution, stopFire, suggestedModalModelDirectors, supportMultirateFiring, suspend, terminate, transferInputs, transferOutputs, transferOutputs

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setName, updateContent

Methods inherited from class ptolemy.kernel.util.NamedObj

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

Methods inherited from class java.lang.Object

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

Field Detail

configDir

public StringParameter configDir

DDP engine configuration directory.

degreeOfParallelism

public Parameter degreeOfParallelism

The default degree of parallelism for ddp pattern actors. This value is used if the actor's degreeOfParallelism <= 0.

includeJars

public StringParameter includeJars

A comma-separated list of jar files to include. If the absolute path to the jar is not specified, then the jar should be located in a Kepler module.

jobArguments

public StringParameter jobArguments

A comma-separated list of arguments for the job. It is only useful when DDP actors' logics are described by java classes, not sub-workflows.

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.

writeSubWorkflowsToFiles

public Parameter writeSubWorkflowsToFiles

If true, sub-workflows are written to files in a directory. The directory path is printed to stdout when the workflow executes.

engine

public StringParameter engine

The execution engine.

startServerType

public StringParameter startServerType

The type of DDP server to start (if one is not running).

SAME_JVM_STRING

public static final java.lang.String SAME_JVM_STRING

String for serverType parameter for running DDP Engine in the same JVM.

See Also:

Constant Field Values

DISTRIBUTED_STRING

public static final java.lang.String DISTRIBUTED_STRING

String for serverType parameter for running DDP Engine in a distributed environment.

See Also:

Constant Field Values

DEFAULT_INTTOKEN

public static final IntToken DEFAULT_INTTOKEN

The value used to signify the default degree of parallelism for the degreeOfParallelism parameter.

DEFAULT_NAME

public static final java.lang.String DEFAULT_NAME

The name of the DEFAULT degree of parallelism parameter.

See Also:

Constant Field Values

Constructor Detail

DDPDirector

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

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

Throws:

IllegalActionException

NameDuplicationException

DDPDirector

public DDPDirector(Workspace workspace)
            throws IllegalActionException,
                   NameDuplicationException

Construct a new DDPBaseDirector for a workspace.

Throws:

IllegalActionException

NameDuplicationException

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

React to a change in an attribute. This overrides the base class to handles changes to local parameters.

Overrides:

attributeChanged in class Director

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If timeResolution is being changed and the model is executing (and not in preinitialize()).

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Clone the object into the specified workspace.

Overrides:

clone in class Director

Parameters:

workspace - The workspace for the cloned object.

Returns:

The new Attribute.

Throws:

java.lang.CloneNotSupportedException - Not thrown in this base class

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

fire

public void fire()
          throws IllegalActionException

Run the engine.

Specified by:

fire in interface Executable

Overrides:

fire in class Director

Throws:

IllegalActionException - If any called method of one of the associated actors throws it.

getDisplayRedirectDir

public java.lang.String getDisplayRedirectDir()
                                       throws IllegalActionException

Get the dir to redirect display related actors.

Throws:

IllegalActionException

getEngineName

public java.lang.String getEngineName()
                               throws IllegalActionException

Get the name of the DDP engine.

Throws:

IllegalActionException

postfire

public boolean postfire()
                 throws IllegalActionException

Postfire the engine.

Specified by:

postfire in interface Executable

Overrides:

postfire in class Director

Returns:

If true, engine can be fired again. If false, do not run again.

Throws:

IllegalActionException - Not thrown in this base class.

preinitialize

public void preinitialize()
                   throws IllegalActionException

Preinitialize the engine.

Specified by:

preinitialize in interface Initializable

Overrides:

preinitialize in class Director

Throws:

IllegalActionException - If the preinitialize() method of one of the associated actors throws it.

stop

public void stop()

Stop any running DDP jobs.

Specified by:

stop in interface Executable

Overrides:

stop in class Director

wrapup

public void wrapup()
            throws IllegalActionException

Perform any cleanup in the engine.

Specified by:

wrapup in interface Initializable

Overrides:

wrapup in class Director

Throws:

IllegalActionException - If the wrapup() method of one of the associated actors throws it.