gov.nasa.arc.brahms.vm.data
Class VMArea

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.GeographyConcept
                      gov.nasa.arc.brahms.common.data.Area
                          gov.nasa.arc.brahms.vm.data.VMArea

All Implemented Interfaces:

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

public class VMArea
extends Area
implements IVMInstance

The VMArea is an Area with extensions for use in the Brahms virtual machine. An area represents a geographical location and is used to create a geographical representation for use in the model. Examples are 'NewYorkCity', 'EmpireStateBuilding', etc. Area's are instances of area definitions.

Version:

$Revision: 1.5 $ $Date: 2009/11/23 22:12:30 $ $Author: rnado $

Author:

Ron van Hoof

See Also:

Serialized Form

Field Summary

static long	EXCEPTION_TIMEOUT Constant specifying the recommended default time-out after an exception
static int	NUM_RETRIES Constant specifying the recommended default number of retries

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

VMArea()
Constructor, creates a new area for use in the virtual machine.

VMArea(java.lang.String name)
Constructor, creates a new area with the specified name for use in the virtual machine.

VMArea(java.lang.String file, int line)
Constructor, creates a new area for use in the virtual machine and for which its specification is stored in the specified file at the specified line number.

VMArea(java.lang.String name, java.lang.String file, int line)
Constructor, creates a new area with the specified name for use in the virtual machine and for which its specification is stored in the specified file at the specified line number.

Method Summary

IConceptCtx	createContext() Creates a new context for this concept for use in a virtual machine.
boolean	equals(java.lang.Object obj) Tests whether two VMArea are equal.
protected Relation	getHasSubAreaRelation() Returns the hasSubArea relation as defined by BaseAreaDef.
java.util.Enumeration	getInitialFacts(boolean includeParents) Returns the area's initial facts.
protected Relation	getIsSubAreaOfRelation() Returns the isSubAreaOf relation as defined by BaseAreaDef.

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

addSubAggregate, delete, getAggregate, getAttribute, getAttributeRecursive, getAttributes, getAttributesRecursive, getInitialFactsRecursive, getParent, getParents, getRelation, getRelationRecursive, getRelations, getRelationsRecursive, getSubAggregate, getSubAggregates, getSubAggregates, hasSubAggregates, isInstanceOf, removeSubAggregate, setAggregate, setID, setParent

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

addInitialFact, getInitialFacts, hasInitialFacts

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

addAttribute, addRelation, compareTypes, 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, 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.vm.data.IVMInstance

getContext, getFullyQualifiedName, getID, getName, isDynamic, isLocal, isSerializable, setDynamic, setSerializable

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

getSerialNumber

Field Detail

EXCEPTION_TIMEOUT

public static final long EXCEPTION_TIMEOUT

Constant specifying the recommended default time-out after an exception

See Also:

Constant Field Values

NUM_RETRIES

public static final int NUM_RETRIES

Constant specifying the recommended default number of retries

See Also:

Constant Field Values

Constructor Detail

VMArea

public VMArea()

Constructor, creates a new area for use in the virtual machine.

VMArea

public VMArea(java.lang.String name)

Constructor, creates a new area with the specified name for use in the virtual machine.

Parameters:

name - the name of the area

VMArea

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

Constructor, creates a new area for use in the virtual machine and for which its specification is stored in the specified file at the specified line number.

Parameters:

file - the file in which the area is specified

line - the line number at which the area's specification starts in the file

VMArea

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

Constructor, creates a new area with the specified name for use in the virtual machine and for which its specification is stored in the specified file at the specified line number.

Parameters:

name - the name of the area

file - the file in which the area is specified

line - the line number at which the area's specification starts in the file

Method Detail

createContext

public IConceptCtx createContext()

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

Overrides:

createContext in class Area

Returns:

IConceptCtx the concept's context

getIsSubAreaOfRelation

protected Relation getIsSubAreaOfRelation()

Returns the isSubAreaOf relation as defined by BaseAreaDef.

Returns:

Relation the isSubAreaOf relation

getHasSubAreaRelation

protected Relation getHasSubAreaRelation()

Returns the hasSubArea relation as defined by BaseAreaDef.

Returns:

Relation the hasSubArea relation

getInitialFacts

public java.util.Enumeration getInitialFacts(boolean includeParents)

Returns the area's initial facts. If the includeParents flag is false it excludes the initial facts defined for its parent classes or superclasses. If the flag is true it includes the initial facts defined for its parent classes or superclasses. This list includes the engine generated facts specifiying the area hierarchy using the isSubAreaOf and hasSubArea attributes.

Overrides:

getInitialFacts in class Area

Parameters:

includeParents - true if also the initial facts of its parent classes and superclasses are to be included, false otherwise

Returns:

Enumeration a list of all the area's initial facts

equals

public boolean equals(java.lang.Object obj)

Tests whether two VMArea are equal. The VM maintains a single instance of any VMArea with a given FQN in its static model, so the equality check can be reduced to an identity check

Overrides:

equals in class Concept

Parameters:

obj - the Object to be compared for equality

Returns:

true if the two VMAreas are equal, false otherwise