org.kepler.ddp.actor.pattern

Interface DDPPatternActor

All Superinterfaces:

Actor, Executable, Initializable, Nameable

All Known Implementing Classes:

AtomicPathActor, AtomicPatternActor, CoGroup, Cross, DDPDataSink, DDPDataSource, DualInputPatternActor, Map, Match, Reduce, SingleInputPatternActor

public interface DDPPatternActor
extends Actor

An interface for all DDP pattern actors.

Author:

Daniel Crawl

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	_commonKeyValueTypes Some common key value types for inputs and outputs.

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone(Workspace workspace) Clone the actor into a workspace.
void	exportMoML(java.io.Writer writer) Write a MoML description of this object using the specified Writer.
Attribute	getAttribute(java.lang.String string) Get the attribute with the given name.
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.
Port	getPort(java.lang.String string) Get the port with the given name.
boolean	getPrintExeInfo() Get whether print execution summary when running workflow inside of Hadoop/Stratosphere job.
boolean	isOpaque() Returns true if the actor is atomic, or is composite and contains a director.
java.util.List	portList() Get a list of ports.

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, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

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

Field Detail

_commonKeyValueTypes

static final java.lang.String[] _commonKeyValueTypes

Some common key value types for inputs and outputs.

Method Detail

portList

java.util.List portList()

Get a list of ports.

isOpaque

boolean isOpaque()

Returns true if the actor is atomic, or is composite and contains a director.

getPort

Port getPort(java.lang.String string)

Get the port with the given name.

exportMoML

void exportMoML(java.io.Writer writer)
         throws java.io.IOException

Write a MoML description of this object using the specified Writer.

Throws:

java.io.IOException

clone

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

Clone the actor into a workspace.

Throws:

java.lang.CloneNotSupportedException

getAttribute

Attribute getAttribute(java.lang.String string)

Get the attribute with the given name.

getDegreeOfParallelism

int getDegreeOfParallelism()
                    throws IllegalActionException

Get the number of parallel instances to execute.

Throws:

IllegalActionException

getDisplayRedirectDir

java.lang.String getDisplayRedirectDir()
                                throws IllegalActionException

Get the dir to redirect display related actors.

Throws:

IllegalActionException

getParameters

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.

Throws:

IllegalActionException

getParaImplNames

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.

Throws:

IllegalActionException

getExecutionClassName

java.lang.String getExecutionClassName()
                                throws IllegalActionException

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

Throws:

IllegalActionException

getJars

java.lang.String getJars()
                  throws IllegalActionException

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

Throws:

IllegalActionException

getPrintExeInfo

boolean getPrintExeInfo()
                 throws IllegalActionException

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

Throws:

IllegalActionException

getExecutionCodeType

java.lang.String getExecutionCodeType()
                               throws IllegalActionException

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

Throws:

IllegalActionException

getExecutionCode

java.lang.String getExecutionCode()
                           throws IllegalActionException

Get the execution code. Returns null if not set.

Throws:

IllegalActionException