gov.nasa.arc.brahms.common.data
Class JavaActivity

java.lang.Object
  gov.nasa.arc.brahms.common.data.BrahmsObject
      gov.nasa.arc.brahms.common.data.ModelElement
          gov.nasa.arc.brahms.common.data.NamedModelElement
              gov.nasa.arc.brahms.common.data.Activity
                  gov.nasa.arc.brahms.common.data.PrimitiveActivity
                      gov.nasa.arc.brahms.common.data.JavaActivity

All Implemented Interfaces:

gov.nasa.arc.brahms.common.IConstants, java.io.Serializable

Direct Known Subclasses:

VMJavaActivity

public class JavaActivity
extends PrimitiveActivity

A java activity is a primitive activity but is used to call an externally specified activity written in Java. The external java activity is specified in a class that either implements the IExternalActivity interface or extends the AbstractExternalActivity class.

Version:

$Revision: 1.1 $ $Date: 2007/10/10 14:12:13 $ $Author: rvhoof $

Author:

Ron van Hoof

See Also:

Serialized Form

Field Summary

Fields inherited from class gov.nasa.arc.brahms.common.data.NamedModelElement

NAME_PROPERTY

Fields inherited from interface gov.nasa.arc.brahms.common.IConstants

ABORT, ACTIVECLASS, ACTIVECONCEPT, ACTIVEINSTANCE, AGENT, ANONYMOUS, ANYAGENT, AREA, AREADEF, ASSIGNED, ATTRIBUTE, BASEAREADEF, BASECLASS, BASECONCEPTUALCLASS, BASEGROUP, BASELIBRARY, BOOLEAN, BROADCAST, BUILDING, BYTE, CCLOCK, CDATE, CHAR, CITY, CLASS, CLOCK, COLLECTALL, COMMUNICATE, COMPLETE, COMPOSITE, COMPUTER, CONCEPT, CONCEPTUALCLASS, CONCEPTUALCONCEPT, CONCEPTUALOBJECT, CONTINUE, COPY, CREATEAGENT, CREATEAREA, CREATEOBJECT, current, CURRENT, DATAFRAME, DATE, DB, DETECTABLE, DIV, DOUBLE, EMAIL, EMPTY_STRING, END, ENDACTIVITY, ENTAGENT, EQ, EXCEPTION, EXPR, FACE2FACE, FACTFRAME, FALSE, FAX, FLOAT, FOREACH, FORONE, G2, GE, GEOGRAPHYCONCEPT, GESTURE, GET, GROUP, GT, IMPASSE, INT, INVALID, JAVA, JAVA_TYPE, KNOWN_MODIFIER, KNOWNVAL_MODIFIER, LE, LOCAL, LONG, LT, MAP, MINUS, MOD, MOVE, MULT, NE, NEW, NONE, NOT_MODIFIER, NOWORK, O, OA, OBJECT, ONTOLOGY, PAGER, PARAMETER, PATH, PHONE, PLUS, PRIMITIVE, PRIVATE, PROAGENT, PROTECTED, PRSAGENT, PUBLIC, PUT, RECEIVE, RELATION, sACTIVECLASS, sACTIVECONCEPT, sACTIVEINSTANCE, sAGENT, sARCHIVE, sAREA, sAREADEF, sBOOLEAN, sBYTE, sBYTECODEEXT, sCHAR, sCLASS, sCOMPUTER, sCONCEPT, sCONCEPTUALCLASS, sCONCEPTUALCONCEPT, sCONCEPTUALOBJECT, sCOPY, sCURRENT, sDETECTABLE, sDOUBLE, sEMAIL, sEND, SEND, sFACE2FACE, sFAX, sFILEEXT, sFLOAT, sGEOGRAPHYCONCEPT, sGROUP, SHORT, SIMAGENT, sINT, sJAVA_TYPE, sLONG, sMAP, sNEW, sNONE, sNOWORK, sOBJECT, SOURCECODE, sPAGER, sPARAMETER, sPATH, sPHONE, sPRIVATE, sPROJECTEXT, sPROTECTED, sPUBLIC, sSHORT, sSTART, sSTRING, sSYMBOL, START, STRING, sUNKNOWN, sVOID, SYMBOL, TRUE, UDT, UML, UNASSIGNED, UNDEFINED, unknown, UNKNOWN, UNKNOWN_MODIFIER, V, VARIABLE, VOID, WHENEVER, WORKFRAME, WORLD, XML

Constructor Summary

JavaActivity()
Constructor, creates a new java activity.

JavaActivity(java.lang.String name)
Constructor, creates a new java activity with the specified name.

JavaActivity(java.lang.String file, int line)
Constructor, creates a new java activity that is specified in the specified file at the specified line number.

JavaActivity(java.lang.String name, java.lang.String file, int line)
Constructor, creates a new java activity with the specified name that is specified in the specified file at the specified line number.

Method Summary

static int	convertWhenSymbolToInt(java.lang.String when) Converts the when indicator represented as a symbol to an integer constant.
IActivityCtx	createContext() Creates a new context for this activity for use in a virtual machine.
java.lang.String	getJavaClass() Returns the fully qualified name of the class implementing the Java activity.
Parameter	getJavaClassParameter() Returns the parameter that specifies the name of the class implementing the Java activity.
int	getWhen() Returns when the java code is to be executed, at the start or end of the activity.
Parameter	getWhenParameter() Returns the parameter indicating when the java code is to be executed, at the start or end of the activity.
protected void	setID() Sets the unique identifier.
void	setJavaClass(java.lang.String javaClass) Sets the fully qualified name of the class implementing the Java activity.
void	setJavaClassParameter(Parameter p) Sets the parameter that specifies the name of the class implementing the Java activity.
void	setWhen(int i) Sets when the java code is to be executed, at the start or end of the activity.
void	setWhen(Parameter p) Sets the parameter indicating when the java code is to be executed, at the start or end of the activity.

Methods inherited from class gov.nasa.arc.brahms.common.data.PrimitiveActivity

addResource, addResource, addTouchedObject, addTouchedObject, getMaxDuration, getMinDuration, getRandom, getResources, getTouchedObjects, hasResources, hasTouchedObjects, setMaxDuration, setMaxDuration, setMinDuration, setMinDuration, setRandom, setRandom

Methods inherited from class gov.nasa.arc.brahms.common.data.Activity

addParameter, addReference, delete, getActivityDescriptor, getDisplayText, getFullyQualifiedName, getParameter, getParameter, getParameterCount, getParameters, getPriority, getQualifiedName, getReferences, hasParameters, removeParameter, removeReference, setActivityDescriptor, setDisplayText, setDisplayText, setOwner, setOwner, setPriority, setPriority

Methods inherited from class gov.nasa.arc.brahms.common.data.NamedModelElement

getName, getOwner, setFullyQualifiedName, setName, setOwner, toString

Methods inherited from class gov.nasa.arc.brahms.common.data.BrahmsObject

export, getFile, getID, getLine, getSerialNumber, isBCC, isDynamic, isLoaded, isResolved, setBCC, setDynamic, setFile, setID, setLine, setLoaded, setResolved, setSerialNumber

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaActivity

public JavaActivity()

Constructor, creates a new java activity.

JavaActivity

public JavaActivity(java.lang.String name)

Constructor, creates a new java activity with the specified name.

Parameters:

name - the name of the java activity

JavaActivity

public JavaActivity(java.lang.String file,
                    int line)

Constructor, creates a new java activity that is specified in the specified file at the specified line number.

Parameters:

file - the file in which the java activity is specified

line - the line number at which the specification starts in the file

JavaActivity

public JavaActivity(java.lang.String name,
                    java.lang.String file,
                    int line)

Constructor, creates a new java activity with the specified name that is specified in the specified file at the specified line number.

Parameters:

name - the name of the java activity

file - the file in which the java activity is specified

line - the line number at which the specification starts in the file

Method Detail

convertWhenSymbolToInt

public static int convertWhenSymbolToInt(java.lang.String when)

Converts the when indicator represented as a symbol to an integer constant.

Parameters:

type - the symbol representation

Returns:

int the constant value

setID

protected void setID()

Sets the unique identifier.

Overrides:

setID in class PrimitiveActivity

setJavaClassParameter

public void setJavaClassParameter(Parameter p)

Sets the parameter that specifies the name of the class implementing the Java activity.

Parameters:

p - the Parameter

getJavaClassParameter

public Parameter getJavaClassParameter()

Returns the parameter that specifies the name of the class implementing the Java activity.

Returns:

Parameter the parameter is the java class is specified by a parameter, null if the java class is not specified by a parameter but by its fully qualified name

See Also:

getJavaClass()

setJavaClass

public void setJavaClass(java.lang.String javaClass)

Sets the fully qualified name of the class implementing the Java activity.

Parameters:

javaClass - the fully qualified name of the class

getJavaClass

public java.lang.String getJavaClass()

Returns the fully qualified name of the class implementing the Java activity.

Parameters:

javaClass - the fully qualified name of the class, returns null if the class is specified through a parameter

See Also:

getJavaClassParameter()

setWhen

public void setWhen(int i)

Sets when the java code is to be executed, at the start or end of the activity.

Parameters:

i - one of JavaActivity.START or JavaActivity.END

See Also:

IConstants.START, IConstants.END

setWhen

public void setWhen(Parameter p)

Sets the parameter indicating when the java code is to be executed, at the start or end of the activity. The parameter must be of type 'symbol' and can as values have JavaActivity.sSTART or JavaActivity.sEND.

Parameters:

p - the symbol Parameter

See Also:

IConstants.sSTART, IConstants.sEND

getWhen

public int getWhen()

Returns when the java code is to be executed, at the start or end of the activity.

Returns:

int one of JavaActivity.START, JavaActivity.END or JavaActivity.PARAMETER if the when is specified through a parameter

See Also:

IConstants.START, IConstants.END, IConstants.PARAMETER

getWhenParameter

public Parameter getWhenParameter()

Returns the parameter indicating when the java code is to be executed, at the start or end of the activity. The parameter must be of type 'symbol' and can as values have JavaActivity.sSTART or JavaActivity.sEND.

Returns:

Parameter the symbol Parameter

See Also:

IConstants.sSTART, IConstants.sEND

createContext

public IActivityCtx createContext()

Creates a new context for this activity for use in a virtual machine.

Note: This method always returns a new instance and does not verify whether one is already created.

Overrides:

createContext in class PrimitiveActivity

Returns:

IActivityCtx the activity's context