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

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.Concept
                  gov.nasa.arc.brahms.common.data.ActiveConcept
                      gov.nasa.arc.brahms.common.data.ActiveClass

All Implemented Interfaces:

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

Direct Known Subclasses:

Group, ObjectClass

public class ActiveClass
extends ActiveConcept
implements IConceptClass

Version:

$Revision: 1.3 $ $Date: 2009/11/23 19:05:06 $ $Author: rnado $

Author:

Ron van Hoof

See Also:

Serialized Form

Field Summary

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

ATTRIBUTES_PROPERTY, RELATIONS_PROPERTY

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

ActiveClass()

ActiveClass(java.lang.String file, int line)

ActiveClass(java.lang.String name, java.lang.String file, int line)

Method Summary

boolean	addMember(ActiveInstance concept)
boolean	addSubClass(ActiveClass concept)
boolean	addSuperClass(ActiveClass concept)
void	delete() Deletes this element from the model and removes all references to this element in other model elements.
protected java.util.LinkedList<Activity>	getActivitiesRecursive(boolean includeThis) Returns the active concepts' activities including the activities inherited from its parent class and their parent super classes.
protected java.util.LinkedList<Activity>	getActivitiesRecursive(java.lang.String name, boolean includeThis) Searches for all activities with the specified name through the concept hierarchy breadth first.
protected Activity	getActivityByDescriptorRecursive(java.lang.String descriptor, boolean includeThis) Searches for the activity with the specified descriptor through the concept hierarchy breadth first.
protected Attribute	getAttributeRecursive(java.lang.String name, boolean includeThis) Searches for the attribute with the specified name through the concept hierarchy breadth first.
protected java.util.LinkedList<Attribute>	getAttributesRecursive(boolean includeThis) Returns the active concepts' attributes including the attributes inherited from its parent class and their parent super classes.
protected java.util.LinkedList	getInitialBeliefsRecursive(boolean includeThis) Returns the active concepts' initial beliefs including the initial beliefs of its parent class and their parent super classes.
protected java.util.LinkedList<InitialStatement>	getInitialFactsRecursive(boolean includeThis) Returns the active concepts' initial facts including the initial facts of its parent class and their parent super classes.
ActiveInstance	getMember(java.lang.String name)
java.util.Enumeration	getMembers()
java.util.List<ActiveInstance>	getMembers(boolean includeSubClasses) Returns a list of all the members of this class.
void	getMembersRecursive(java.util.HashMap<java.lang.String,ActiveInstance> members, boolean includeSubClasses, java.util.HashMap<java.lang.String,ActiveClass> classes) Returns a list of all the members of this class.
protected Relation	getRelationRecursive(java.lang.String name, boolean includeThis) Searches for the relation with the specified name through the concept hierarchy breadth first.
protected java.util.LinkedList<Relation>	getRelationsRecursive(boolean includeThis) Returns the active concepts' relations including the relations inherited from its parent class and their parent super classes.
ActiveClass	getSubClass(java.lang.String name)
java.util.Enumeration	getSubClasses()
ActiveClass	getSuperClass(java.lang.String name)
java.util.Enumeration	getSuperClasses()
java.util.LinkedList<ActiveClass>	getSuperClasses(boolean includeParents) Returns all superclasses for this concept, if includeParents is true it will include all superclasses, direct and indirect, breadth first.
protected java.util.LinkedList<Thoughtframe>	getThoughtframesRecursive(boolean includeThis, boolean includeComposites) Returns the active concepts' thoughtframes including the thoughtframes of its parent class and their parent super classes.
protected java.util.LinkedList<Workframe>	getWorkframesRecursive(boolean includeThis, boolean includeComposites) Returns the active concepts' workframes including the workframes of its parent class and their parent super classes.
boolean	hasMembers()
boolean	hasSubClasses()
boolean	hasSuperClasses()
boolean	isMember(ActiveInstance concept) Returns whether the given concept is a member of this class.
boolean	isSubClassOf(Concept concept) Checks whether this active class is a sub class of the specified concept.
protected boolean	isSubClassOf(Concept concept, java.util.Hashtable checked) Checks recursively whether this active class is a sub class of the specified concept, checking the concept hierarchy.
boolean	removeMember(java.lang.String name)
boolean	removeSubClass(java.lang.String name)
boolean	removeSuperClass(java.lang.String name)

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

addActivity, addInitialBelief, addInitialFact, addThoughtframe, addWorkframe, getActivities, getActivities, getActivities, getActivities, getActivityByDescriptor, getActivityByDescriptor, getAttribute, getAttributes, getCost, getInitialBeliefs, getInitialBeliefs, getInitialFacts, getInitialFacts, getLocalActivityByDescriptor, getRelation, getRelations, getThoughtframe, getThoughtframes, getThoughtframes, getThoughtframes, getTimeUnit, getWorkframe, getWorkframes, getWorkframes, getWorkframes, hasActivities, hasInitialBeliefs, hasInitialFacts, hasThoughtframes, hasWorkframes, removeActivity, removeThoughtframe, removeWorkframe, setCost, setTimeUnit

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

addAttribute, addRelation, compareTypes, createContext, equals, getAttribute, getAttributes, getContext, getFullyQualifiedName, getIcon, getModel, getName, getPackage, getRelation, getRelations, getType, hasAttributes, hasRelations, isLocal, isSerializable, removeAttribute, removeRelation, setContext, setIcon, setLocal, setModel, setPackage, setSerializable, toString

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

getDisplayText, getOwner, setDisplayText, setFullyQualifiedName, setName, setOwner

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.nasa.arc.brahms.common.data.Type

getSerialNumber

Constructor Detail

ActiveClass

public ActiveClass()

ActiveClass

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

ActiveClass

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

Method Detail

addSuperClass

public boolean addSuperClass(ActiveClass concept)

removeSuperClass

public boolean removeSuperClass(java.lang.String name)

getSuperClass

public ActiveClass getSuperClass(java.lang.String name)
                          throws java.util.NoSuchElementException

Throws:

java.util.NoSuchElementException

hasSuperClasses

public boolean hasSuperClasses()

getSuperClasses

public java.util.Enumeration getSuperClasses()

getSuperClasses

public java.util.LinkedList<ActiveClass> getSuperClasses(boolean includeParents)

Returns all superclasses for this concept, if includeParents is true it will include all superclasses, direct and indirect, breadth first.

Parameters:

includeParents - true if also indirect superclasses are to be included in the list, false if only th direct superclasses are to be returned

Returns:

LinkedList the list of superclasses.

addSubClass

public boolean addSubClass(ActiveClass concept)

removeSubClass

public boolean removeSubClass(java.lang.String name)

getSubClass

public ActiveClass getSubClass(java.lang.String name)
                        throws java.util.NoSuchElementException

Throws:

java.util.NoSuchElementException

hasSubClasses

public boolean hasSubClasses()

getSubClasses

public java.util.Enumeration getSubClasses()

addMember

public boolean addMember(ActiveInstance concept)

removeMember

public boolean removeMember(java.lang.String name)

getMember

public ActiveInstance getMember(java.lang.String name)
                         throws java.util.NoSuchElementException

Throws:

java.util.NoSuchElementException

hasMembers

public boolean hasMembers()

getMembers

public java.util.Enumeration getMembers()

getMembers

public java.util.List<ActiveInstance> getMembers(boolean includeSubClasses)

Returns a list of all the members of this class. If includeSubClasses is true it will also include all of the members of the subclasses.

Parameters:

includeSubClasses - true to include members of subclasses, false for only the direct members

Returns:

List the list of members, empty list if none found

getMembersRecursive

public void getMembersRecursive(java.util.HashMap<java.lang.String,ActiveInstance> members,
                                boolean includeSubClasses,
                                java.util.HashMap<java.lang.String,ActiveClass> classes)

Returns a list of all the members of this class. If includeSubClasses is true it will also include all of the members of the subclasses.

Parameters:

members - the map to which to add the members

includeSubClasses - true to include members of subclasses, false for only the direct members

classes - the map with classes for which members were already retrieved

isMember

public boolean isMember(ActiveInstance concept)

Returns whether the given concept is a member of this class.

Parameters:

concept - the concept to be tested for membership

Returns:

boolean true if the given concept is a member, false otherwise

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 ActiveConcept

getAttributeRecursive

protected Attribute getAttributeRecursive(java.lang.String name,
                                          boolean includeThis)

Searches for the attribute with the specified name through the concept hierarchy breadth first. If the attribute with the specified name is found it is returned, otherwise null is returned.

Specified by:

getAttributeRecursive in class ActiveConcept

Parameters:

name - the name of the attribute to be found

includeThis - flag indicating whether to search for the attribute in this concept or only to search in the parents

Returns:

Attribute the attribute if it was found, null otherwise

getAttributesRecursive

protected java.util.LinkedList<Attribute> getAttributesRecursive(boolean includeThis)

Returns the active concepts' attributes including the attributes inherited from its parent class and their parent super classes. The attributes are retrieved recursively breadth first.

Note:When processing this list in other methods and an attribute with the same name occurs more then once, then only the last occurrence is to be used by the active concept. The list contains the attibutes starting with the attributes highest in the class hierarchy.

Specified by:

getAttributesRecursive in class ActiveConcept

Parameters:

includeThis - flag indicating whether to include the attibutes for this concept or only to return the parent attributes

Returns:

LinkedList the active concept's (parent) attributes

getRelationRecursive

protected Relation getRelationRecursive(java.lang.String name,
                                        boolean includeThis)

Searches for the relation with the specified name through the concept hierarchy breadth first. If the relation with the specified name is found it is returned, otherwise null is returned.

Specified by:

getRelationRecursive in class ActiveConcept

Parameters:

name - the name of the relation to be found

includeThis - flag indicating whether to search for the relation in this concept or only to search in the parents

Returns:

Relation the relation if it was found, null otherwise

getRelationsRecursive

protected java.util.LinkedList<Relation> getRelationsRecursive(boolean includeThis)

Returns the active concepts' relations including the relations inherited from its parent class and their parent super classes. The relations are retrieved recursively breadth first.

Note:When processing this list in other methods and an relation with the same name occurs more then once, then only the last occurrence is to be used by the active concept. The list contains the relations starting with the relations highest in the class hierarchy.

Specified by:

getRelationsRecursive in class ActiveConcept

Parameters:

includeThis - flag indicating whether to include the relations for this concept or only to return the parent relations

Returns:

LinkedList the active concept's (parent) relations

getInitialBeliefsRecursive

protected java.util.LinkedList getInitialBeliefsRecursive(boolean includeThis)

Returns the active concepts' initial beliefs including the initial beliefs of its parent class and their parent super classes. The initial beliefs are retrieved recursively breadth first.

Note:The list contains the initial beliefs starting with the initial beliefs highest in the class hierarchy.

Specified by:

getInitialBeliefsRecursive in class ActiveConcept

Parameters:

includeThis - flag indicating whether to include the initial beliefs for this concept or only to return the parent initial beliefs

Returns:

LinkedList the active concept's (parent) initial beliefs

getInitialFactsRecursive

protected java.util.LinkedList<InitialStatement> getInitialFactsRecursive(boolean includeThis)

Returns the active concepts' initial facts including the initial facts of its parent class and their parent super classes. The initial facts are retrieved recursively breadth first.

Note:The list contains the initial facts starting with the initial facts highest in the class hierarchy.

Specified by:

getInitialFactsRecursive in class ActiveConcept

Parameters:

includeThis - flag indicating whether to include the initial facts for this concept or only to return the parent initial facts

Returns:

LinkedList the active concept's (parent) initial facts

getActivitiesRecursive

protected java.util.LinkedList<Activity> getActivitiesRecursive(java.lang.String name,
                                                                boolean includeThis)

Searches for all activities with the specified name through the concept hierarchy breadth first. Makes sure that all signatures are unique and that if multiple activities with the same signature exist in the hierarchy that the most specific activity is returned in the list.

Specified by:

getActivitiesRecursive in class ActiveConcept

Parameters:

name - the name of the activity to be found

includeThis - flag indicating whether to search for the activity in this concept or only to search in the parents

Returns:

LinkedList the activities if any were found, null otherwise

getActivityByDescriptorRecursive

protected Activity getActivityByDescriptorRecursive(java.lang.String descriptor,
                                                    boolean includeThis)

Searches for the activity with the specified descriptor through the concept hierarchy breadth first. If the activity with the specified descriptor is found it is returned, otherwise null is returned.

Specified by:

getActivityByDescriptorRecursive in class ActiveConcept

Parameters:

descriptor - the descriptor of the activity to be found

includeThis - flag indicating whether to search for the activity in this concept or only to search in the parents

Returns:

Activity the activity if it was found, null otherwise

getActivitiesRecursive

protected java.util.LinkedList<Activity> getActivitiesRecursive(boolean includeThis)

Returns the active concepts' activities including the activities inherited from its parent class and their parent super classes. The activities are retrieved recursively breadth first.

Note:When processing this list in other methods and an activity with the same name occurs more then once, then only the last occurrence is to be used by the active concept. The list contains the activities starting with the activities highest in the class hierarchy.

Specified by:

getActivitiesRecursive in class ActiveConcept

Parameters:

includeThis - flag indicating whether to include the activities for this concept or only to return the parent activities

Returns:

LinkedList the active concept's (parent) activities

getWorkframesRecursive

protected java.util.LinkedList<Workframe> getWorkframesRecursive(boolean includeThis,
                                                                 boolean includeComposites)

Returns the active concepts' workframes including the workframes of its parent class and their parent super classes. The workframes are retrieved recursively breadth first.

Note:When processing this list in other methods and a workframe with the same name occurs more then once, then only the last occurrence is to be used by the active concept. The list contains the frames starting with the frames highest in the class hierarchy.

Specified by:

getWorkframesRecursive in class ActiveConcept

Parameters:

includeThis - flag indicating whether to include the frames for this concept or only to return the parent frames

includeComposites - true if also the workframes specified in composite activities are to be returned.

Returns:

LinkedList the active concept's (parent) workframes

getThoughtframesRecursive

protected java.util.LinkedList<Thoughtframe> getThoughtframesRecursive(boolean includeThis,
                                                                       boolean includeComposites)

Returns the active concepts' thoughtframes including the thoughtframes of its parent class and their parent super classes. The thoughtframes are retrieved recursively breadth first.

Note:When processing this list in other methods and a thoughtframe with the same name occurs more then once, then only the last occurrence is to be used by the active concept. The list contains the frames starting with the frames highest in the class hierarchy.

Specified by:

getThoughtframesRecursive in class ActiveConcept

Parameters:

includeThis - flag indicating whether to include the frames for this concept or only to return the parent frames

includeComposites - true if also the thoughtframes specified in composite activities are to be returned.

Returns:

LinkedList the active concept's (parent) thoughtframes

isSubClassOf

public boolean isSubClassOf(Concept concept)

Checks whether this active class is a sub class of the specified concept.

Parameters:

concept - the concept to be checked to see if it is a parent of this active class.

Returns:

true if this active class is a sub class of the concept, false otherwise

isSubClassOf

protected boolean isSubClassOf(Concept concept,
                               java.util.Hashtable checked)

Checks recursively whether this active class is a sub class of the specified concept, checking the concept hierarchy.

Parameters:

concept - the concept to be checked to see if it is a parent of this active class.

checked - the table with parents already checked in the hierarchy to prevent circular loops

Returns:

true if this active class is a sub class of the concept, false otherwise