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

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.CompositeActivity

All Implemented Interfaces:

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

Direct Known Subclasses:

VMCompositeActivity

public class CompositeActivity
extends Activity

A composite activity is an activity that has to be decomposed into more specific workframes. Unlike primitive activities no duration is specified for this activity. The duration of this type of activity depends on the workframes that will be worked on as part of the activity. Composite activities allow us to build a hierarchy of workframes.

Version:

$Revision: 1.1 $ $Date: 2007/10/10 14:12:10 $ $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

CompositeActivity()
Constructor, creates a new composite activity.

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

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

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

Method Summary

boolean	addActivity(Activity act)
boolean	addDetectable(Detectable det)
boolean	addThoughtframe(Thoughtframe frm)
boolean	addWorkframe(Workframe frm)
IActivityCtx	createContext() Creates a new context for this activity for use in a virtual machine.
void	delete() Deletes this element from the model and removes all references to this element in other model elements.
java.util.Enumeration	getActivities()
java.util.LinkedList<Activity>	getActivities(java.lang.String name) Returns the activities with the specified name.
Activity	getActivityByDescriptor(java.lang.String descriptor) Returns the activity with the specified descriptor.
Activity	getActivityByDescriptor(java.lang.String descriptor, boolean includeParents, ActiveInstance agent) Returns the activity with the specified descriptor.
Detectable	getDetectable(java.lang.String name)
java.util.Enumeration	getDetectables()
int	getEndCondition()
Thoughtframe	getThoughtframe(java.lang.String name)
java.util.Enumeration	getThoughtframes() Returns the composite activity's thoughtframes excluding the thoughtframes specified in its composite activities.
java.util.Enumeration	getThoughtframes(boolean includeComposites) Returns the composite activity's thoughtframes.
Workframe	getWorkframe(java.lang.String name)
java.util.Enumeration	getWorkframes() Returns the composite activity's workframes excluding the workframes specified in its composite activities.
java.util.Enumeration	getWorkframes(boolean includeComposites) Returns the composite activity's workframes.
boolean	hasActivities()
boolean	hasDetectables()
boolean	hasThoughtframes()
boolean	hasWorkframes()
boolean	removeActivity(Activity act)
boolean	removeDetectable(java.lang.String name)
boolean	removeThoughtframe(java.lang.String name)
boolean	removeWorkframe(java.lang.String name)
void	setEndCondition(int i)
protected void	setID() Sets the unique identifier.

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

addParameter, addReference, convertWhenSymbolToInt, 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

CompositeActivity

public CompositeActivity()

Constructor, creates a new composite activity.

CompositeActivity

public CompositeActivity(java.lang.String name)

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

Parameters:

name - the name of the composite activity

CompositeActivity

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

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

Parameters:

file - the file in which the composite activity is specified

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

CompositeActivity

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

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

Parameters:

name - the name of the composite activity

file - the file in which the composite activity is specified

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

Method Detail

setID

protected void setID()

Sets the unique identifier.

Overrides:

setID in class BrahmsObject

setEndCondition

public void setEndCondition(int i)

getEndCondition

public int getEndCondition()

addDetectable

public boolean addDetectable(Detectable det)

removeDetectable

public boolean removeDetectable(java.lang.String name)

getDetectable

public Detectable getDetectable(java.lang.String name)
                         throws java.util.NoSuchElementException

Throws:

java.util.NoSuchElementException

hasDetectables

public boolean hasDetectables()

getDetectables

public java.util.Enumeration getDetectables()

addActivity

public boolean addActivity(Activity act)

removeActivity

public boolean removeActivity(Activity act)

getActivities

public java.util.LinkedList<Activity> getActivities(java.lang.String name)
                                             throws java.util.NoSuchElementException

Returns the activities with the specified name. If no activities with the specified name are declared for this ActiveConcept then a NoSuchElementException is thrown. This method does not search for the activities in the concept hierarchy.

Parameters:

name - the name of the requested activity

Returns:

LinkedList the requested activities

Throws:

java.util.NoSuchElementException - if no activities with the specified name are declared for this ActiveConcept, not considering that they could be declared in one of its parents.

getActivityByDescriptor

public Activity getActivityByDescriptor(java.lang.String descriptor)
                                 throws java.util.NoSuchElementException

Returns the activity with the specified descriptor. If no activity with the specified descriptor is declared for this CompositeActivity then a NoSuchElementException is thrown.

Parameters:

descriptor - the descriptor of the requested activity

Returns:

Activity the requested activity

Throws:

java.util.NoSuchElementException - if no activity with the specified descriptor is declared for this CompositeActivity, not considering that it could be declard in one of its parents.

getActivityByDescriptor

public Activity getActivityByDescriptor(java.lang.String descriptor,
                                        boolean includeParents,
                                        ActiveInstance agent)
                                 throws java.util.NoSuchElementException

Returns the activity with the specified descriptor. If no activity with the specified descriptor is declared for this CompositeActivity then a NoSuchElementException is thrown.

Parameters:

descriptor - the descriptor of the requested activity

includeParents - true to also search for the activity in the composite activity hierarchy and concept hierarchy.

agent - the ActiveInstance that will perform the activity

Returns:

Activity the requested activity

Throws:

java.util.NoSuchElementException - if no activity with the specified descriptor is declared for this CompositeActivity, not considering that it could be declard in one of its parents.

hasActivities

public boolean hasActivities()

getActivities

public java.util.Enumeration getActivities()

addWorkframe

public boolean addWorkframe(Workframe frm)

removeWorkframe

public boolean removeWorkframe(java.lang.String name)

getWorkframe

public Workframe getWorkframe(java.lang.String name)
                       throws java.util.NoSuchElementException

Throws:

java.util.NoSuchElementException

hasWorkframes

public boolean hasWorkframes()

getWorkframes

public java.util.Enumeration getWorkframes()

Returns the composite activity's workframes excluding the workframes specified in its composite activities.

Returns:

Enumeration a list of all the composite activity's workframes

getWorkframes

public java.util.Enumeration getWorkframes(boolean includeComposites)

Returns the composite activity's workframes. Depending on the includeComposites flag also the workframes specified in the composite activities for this composite activity are returned (includeComposites is true).

Returns:

Enumeration a list of all the composite activity's workframes

addThoughtframe

public boolean addThoughtframe(Thoughtframe frm)

removeThoughtframe

public boolean removeThoughtframe(java.lang.String name)

getThoughtframe

public Thoughtframe getThoughtframe(java.lang.String name)
                             throws java.util.NoSuchElementException

Throws:

java.util.NoSuchElementException

hasThoughtframes

public boolean hasThoughtframes()

getThoughtframes

public java.util.Enumeration getThoughtframes()

Returns the composite activity's thoughtframes excluding the thoughtframes specified in its composite activities.

Returns:

Enumeration a list of all the composite activity's thoughtframes

getThoughtframes

public java.util.Enumeration getThoughtframes(boolean includeComposites)

Returns the composite activity's thoughtframes. Depending on the includeComposites flag also the thoughtframes specified in the composite activities for this composite activity are returned (includeComposites is true).

Returns:

Enumeration a list of all the composite activity's thoughtframes

delete

public void delete()

Deletes this element from the model and removes all references to this element in other model elements.

Overrides:

delete in class Activity

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 Activity

Returns:

IActivityCtx the activity's context