org.kepler.ddp.actor.pattern

Class AtomicPatternActor

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

org.kepler.ddp.actor.pattern.AtomicPatternActor

All Implemented Interfaces:

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

Direct Known Subclasses:

AtomicPathActor

public class AtomicPatternActor
extends TypedAtomicActor
implements DDPPatternActor

An atomic actor for DDP patterns.

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
protected java.lang.String	_FORMAT_TYPE_CATEGORY The configuration property name for the format type.
protected java.util.List<ConfigurationProperty>	_formatProperties A list of properties of format types from the config file.
protected java.lang.String	_formatTypeStr The string value of the format type.
protected Type	_keyType The key type.
protected Type	_valueType The value type.
Parameter	degreeOfParallelism The number of parallel instances to execute.
StringParameter	formatType The name of the data format or a fully-qualified class name to parse the data.
StringParameter	jars A comma-separated list of jars to use with this actor.
StringParameter	keyValueTypes The key value types of the atomic patter actor.

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

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
AtomicPatternActor(CompositeEntity container, java.lang.String name) Construct a new AtomicPatternActor in a container with a given name.

Method Summary

Modifier and Type	Method and Description
protected void	_addFormats(java.lang.String inputOutputName) Add the formats in the configuration file as choices to formatType.
protected void	_setFormat(java.lang.String newFormatTypeStr) Set the format, and add any associated parameters.
protected void	_setTypesFromConfiguration(ConfigurationProperty formatProperty) Set the key and value types from the types in the configuration property.
protected void	_updateKeyValueTypes() Update the key and value types.
void	attributeChanged(Attribute attribute) See if the formatType parameter changed.
java.lang.Object	clone(Workspace workspace) Clone this actor into the specified workspace.
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	getFormatClassName(java.lang.String engineName) Get the name of the class that provides the format type implementation for a specific engine.
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.
void	preinitialize() Update the port types based on the format type.

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, fire, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup

Methods inherited from class ptolemy.kernel.ComponentEntity

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

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, 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, attributeDeleted, attributeList, attributeList, 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 org.kepler.ddp.actor.pattern.DDPPatternActor

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

degreeOfParallelism

public Parameter degreeOfParallelism

The number of parallel instances to execute.

formatType

public StringParameter formatType

The name of the data format or a fully-qualified class name to parse the data.

jars

public StringParameter jars

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

keyValueTypes

public StringParameter keyValueTypes

The key value types of the atomic patter actor. This parameter should only be set when a class name is specified for formatType parameter.

_keyType

protected Type _keyType

The key type.

_valueType

protected Type _valueType

The value type.

_formatTypeStr

protected java.lang.String _formatTypeStr

The string value of the format type.

_formatProperties

protected java.util.List<ConfigurationProperty> _formatProperties

A list of properties of format types from the config file.

_FORMAT_TYPE_CATEGORY

protected java.lang.String _FORMAT_TYPE_CATEGORY

The configuration property name for the format type.

Constructor Detail

AtomicPatternActor

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

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

Throws:

IllegalActionException

NameDuplicationException

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

See if the formatType parameter changed.

Overrides:

attributeChanged in class NamedObj

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the change is not acceptable to this container (not thrown in this base class).

clone

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

Clone this actor into the specified workspace.

Specified by:

clone in interface DDPPatternActor

Overrides:

clone in class TypedAtomicActor

Parameters:

workspace - The workspace for the new object.

Returns:

A new actor.

Throws:

java.lang.CloneNotSupportedException - If a derived class contains an attribute that cannot be cloned.

See Also:

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

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

Description copied from interface: DDPPatternActor

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. In this class, always 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

getFormatClassName

public java.lang.String getFormatClassName(java.lang.String engineName)
                                    throws IllegalActionException

Get the name of the class that provides the format type implementation for a specific engine.

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. In this class, returns false since printing execution information is not supported in the DDP I/O actors.

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

preinitialize

public void preinitialize()
                   throws IllegalActionException

Update the port types based on the format type.

Specified by:

preinitialize in interface Initializable

Overrides:

preinitialize in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.

_addFormats

protected void _addFormats(java.lang.String inputOutputName)

Add the formats in the configuration file as choices to formatType.

_setFormat

protected void _setFormat(java.lang.String newFormatTypeStr)
                   throws IllegalActionException

Set the format, and add any associated parameters. This method also sets the port types for the keys and values specified in the configuration.

Parameters:

newFormatTypeStr - the format name or a class name.

Throws:

IllegalActionException

_setTypesFromConfiguration

protected void _setTypesFromConfiguration(ConfigurationProperty formatProperty)
                                   throws IllegalActionException

Set the key and value types from the types in the configuration property.

Throws:

IllegalActionException

_updateKeyValueTypes

protected void _updateKeyValueTypes()

Update the key and value types. In this class, do nothing.