|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object gov.nasa.arc.brahms.common.rt.Value
public class Value
The value object models a value bound in a variable context. Depending on the type of the variable a specific value is defined. Each value object represents one single value, never a list of values or multiple values of different types. A list of values is maintained by the binding variable context.
VariableCtx
Field Summary |
---|
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 | |
---|---|
Value(VariableCtx var,
boolean value)
Constructor, creates a new boolean value for the specified variable contex |
|
Value(VariableCtx var,
java.lang.Boolean value)
Constructor, creates a new boolean value for the specified variable contex |
|
Value(VariableCtx var,
java.lang.Byte value)
Constructor, creates a new byte value for the specified variable context |
|
Value(VariableCtx var,
java.lang.Character value)
Constructor, creates a new char value for the specified variable context |
|
Value(VariableCtx var,
double value)
Constructor, creates a new double value for the specified variable context |
|
Value(VariableCtx var,
java.lang.Double value)
Constructor, creates a new double value for the specified variable context |
|
Value(VariableCtx var,
java.lang.Float value)
Constructor, creates a new float value for the specified variable context |
|
Value(VariableCtx var,
IConceptCtx value)
Constructor, creates a new concept value for the specified variable contex |
|
Value(VariableCtx var,
int value)
Constructor, creates a new integer value for the specified variable context |
|
Value(VariableCtx var,
java.lang.Integer value)
Constructor, creates a new integer value for the specified variable context |
|
Value(VariableCtx var,
long value)
Constructor, creates a new long value for the specified variable context |
|
Value(VariableCtx var,
java.lang.Long value)
Constructor, creates a new long value for the specified variable context |
|
Value(VariableCtx var,
java.lang.Object value)
Constructor, creates a new concept value for the specified variable context |
|
Value(VariableCtx var,
java.lang.Short value)
Constructor, creates a new short value for the specified variable context |
|
Value(VariableCtx var,
java.lang.String value,
boolean symbol)
Constructor, creates a new string or symbol value for the specified variable contex |
|
Value(VariableCtx var,
Unknown value)
Constructor, creates an unknown value for the specified variable contex |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object value)
Tests two value objects for equality |
boolean |
getBooleanValue()
Returns the boolean value |
byte |
getByteValue()
Returns the byte value |
char |
getCharValue()
Returns the char value |
IConceptCtx |
getConceptValue()
Returns the concept value |
double |
getDoubleValue()
Returns the double value |
float |
getFloatValue()
Returns the float value |
int |
getIntValue()
Returns the integer value |
java.lang.Object |
getJavaValue()
Returns the Java Object value |
long |
getLongValue()
Returns the long value |
short |
getShortValue()
Returns the short value |
java.lang.String |
getStringValue()
Returns the string value |
java.lang.String |
getSymbolValue()
Returns the symbol value |
int |
getType()
Returns the type of the value |
Unknown |
getUnknownValue()
Returns the unknown value |
java.lang.Object |
getValue()
Returns the value as an object. |
VariableCtx |
getVariable()
Returns the variable binding this value. |
void |
setType(int type)
Sets the type of the value |
void |
setValue(boolean value)
Sets the boolean value |
void |
setValue(java.lang.Boolean value)
Sets the boolean value |
void |
setValue(java.lang.Byte value)
Sets the byte value |
void |
setValue(java.lang.Character value)
Sets the char value |
void |
setValue(double value)
Sets the double value |
void |
setValue(java.lang.Double value)
Sets the double value |
void |
setValue(java.lang.Float value)
Sets the float value |
void |
setValue(IConceptCtx value)
Sets the concept value |
void |
setValue(int value)
Sets the integer value |
void |
setValue(java.lang.Integer value)
Sets the integer value |
void |
setValue(long value)
Sets the long value |
void |
setValue(java.lang.Long value)
Sets the long value |
void |
setValue(java.lang.Object value)
Sets the Java Object value |
void |
setValue(java.lang.Short value)
Sets the short value |
void |
setValue(java.lang.String value,
boolean symbol)
Sets the string or symbol value |
void |
setValue(Unknown value)
Sets the value to unknown |
void |
setVariable(VariableCtx var)
Sets the variable binding this value. |
java.lang.String |
toString()
Returns a string representation of the Value. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Value(VariableCtx var, int value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the integer value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valuepublic Value(VariableCtx var, java.lang.Integer value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the integer value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valuepublic Value(VariableCtx var, java.lang.Character value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the character value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valuepublic Value(VariableCtx var, java.lang.Byte value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the byte value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valuepublic Value(VariableCtx var, java.lang.Short value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the short value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valuepublic Value(VariableCtx var, long value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the long value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valuepublic Value(VariableCtx var, java.lang.Long value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the long value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valuepublic Value(VariableCtx var, java.lang.Float value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the float value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valuepublic Value(VariableCtx var, double value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the double value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valuepublic Value(VariableCtx var, java.lang.Double value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the double value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valuepublic Value(VariableCtx var, boolean value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the boolean value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valuepublic Value(VariableCtx var, java.lang.Boolean value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the boolean value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valuepublic Value(VariableCtx var, java.lang.String value, boolean symbol) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the string or symbol valuesymbol
- defines whether the value is a symbol, if false value is a string
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valuepublic Value(VariableCtx var, IConceptCtx value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the concept value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valuepublic Value(VariableCtx var, java.lang.Object value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the concept value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valuepublic Value(VariableCtx var, Unknown value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the variable context in which this value is boundvalue
- the unknown value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an error occurs in creating the valueMethod Detail |
---|
public final void setVariable(VariableCtx var) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
var
- the VariableCtx binding this value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if a null variable is specifiedpublic final VariableCtx getVariable() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if no variable is specifiedpublic final void setType(int type) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
type
- the value type
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an invalid type is specifiedIConstants.INT
,
IConstants.CHAR
,
IConstants.BYTE
,
IConstants.SHORT
,
IConstants.LONG
,
IConstants.FLOAT
,
IConstants.DOUBLE
,
IConstants.BOOLEAN
,
IConstants.STRING
,
IConstants.SYMBOL
,
IConstants.UDT
,
IConstants.JAVA_TYPE
,
IConstants.UNKNOWN
public final int getType() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if no type is specifiedIConstants.INT
,
IConstants.CHAR
,
IConstants.BYTE
,
IConstants.SHORT
,
IConstants.LONG
,
IConstants.FLOAT
,
IConstants.DOUBLE
,
IConstants.BOOLEAN
,
IConstants.STRING
,
IConstants.SYMBOL
,
IConstants.UDT
,
IConstants.JAVA_TYPE
,
IConstants.UNKNOWN
public final void setValue(int value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the integer value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final void setValue(java.lang.Integer value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the integer value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final void setValue(java.lang.Character value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the char value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final void setValue(java.lang.Byte value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the byte value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final void setValue(java.lang.Short value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the byte value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final void setValue(long value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the long value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final void setValue(java.lang.Long value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the long value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final void setValue(java.lang.Float value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the float value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final void setValue(double value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the double value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final void setValue(java.lang.Double value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the double value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final void setValue(boolean value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the boolean value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final void setValue(java.lang.Boolean value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the boolean value
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final void setValue(java.lang.String value, boolean symbol) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the string or symbol valuesymbol
- is value a symbol (true) or a string (false)
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final void setValue(IConceptCtx value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the concept value (ConceptCtx)
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final void setValue(java.lang.Object value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the Java Object
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final void setValue(Unknown value) throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
value
- the unknown value (Unknown)
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final int getIntValue() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if this value does not contain an integerpublic final char getCharValue() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if this value does not contain a characterpublic final byte getByteValue() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if this value does not contain a bytepublic final short getShortValue() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if this value does not contain a shortpublic final long getLongValue() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if this value does not contain a longpublic final float getFloatValue() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if this value does not contain a floatpublic final double getDoubleValue() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if this value does not contain a doublepublic final boolean getBooleanValue() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if this value does not contain a booleanpublic final java.lang.String getSymbolValue() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if this value does not contain a symbolpublic final java.lang.String getStringValue() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if this value does not contain a stringpublic final IConceptCtx getConceptValue() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if this value does not contain a conceptpublic final java.lang.Object getJavaValue() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if this value does not contain a Java Objectpublic final Unknown getUnknownValue() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if this value is not unknownpublic final java.lang.Object getValue() throws gov.nasa.arc.brahms.common.exceptions.BrahmsException
gov.nasa.arc.brahms.common.exceptions.BrahmsException
- if an internal error occurspublic final boolean equals(java.lang.Object value)
equals
in class java.lang.Object
value
- the value to be compared, can be a Value object or
one of Integer, Double, Boolean, String or IConceptCtx
public final java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |