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

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.ConceptualConcept
                      gov.nasa.arc.brahms.common.data.ConceptualInstance
                          gov.nasa.arc.brahms.vm.data.VMConceptualInstance

All Implemented Interfaces:

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

public class VMConceptualInstance
extends ConceptualInstance
implements IVMInstance

The VMConceptualInstance is a ConceptualInstance with extensions for use in the Brahms virtual machine. A conceptual object is used to allow for a user to track things that exist as concepts in people's minds, like the concept of an order. The concepts do not exist as such but do have incarnations in the form of real artifacts, such as a fax, a form, or a database record. Through conceptual objects statistics can be generated such as touch time and cycle time and object flows can be generated through a work process.

Version:

$Revision: 1.4 $ $Date: 2009/11/23 22:12:31 $ $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

VMConceptualInstance()
Constructor, creates a new conceptual object for use in the virtual machine.

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

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

VMConceptualInstance(java.lang.String name, java.lang.String file, int line)
Constructor, creates a new conceptual object 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 VMConceptualInstances are equal.

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

addAggregate, addPart, addSubAggregate, delete, getAggregate, getAggregates, getAttributeRecursive, getAttributesRecursive, getParent, getParents, getPart, getParts, getRelationRecursive, getRelationsRecursive, getSubAggregate, getSubAggregates, hasAggregates, hasParts, hasSubAggregates, isInstanceOf, removeAggregate, removePart, removeSubAggregate, setID, setParent

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

getAttribute, getAttributes, getRelation, getRelations

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

VMConceptualInstance

public VMConceptualInstance()

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

VMConceptualInstance

public VMConceptualInstance(java.lang.String name)

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

Parameters:

name - the name of the conceptual object

VMConceptualInstance

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

Constructor, creates a new conceptual object 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 conceptual object is specified

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

VMConceptualInstance

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

Constructor, creates a new conceptual object 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 conceptual object

file - the file in which the conceptual object is specified

line - the line number at which the conceptual object'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 ConceptualInstance

Returns:

IConceptCtx the concept's context

equals

public boolean equals(java.lang.Object obj)

Tests whether two VMConceptualInstances are equal. The VM maintains a single instance of any VMConceptualInstance 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 VMConceptualInstances are equal, false otherwise