|
ABLE, Version 1.1b | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.able.data.AbleLhs | +--com.ibm.able.data.AbleVariable | +--com.ibm.able.data.AbleNumericVariable
This class defines the Able data numeric variable.
Field Summary | |
protected double |
myValue
|
protected double |
myValueInitial
|
Fields inherited from class com.ibm.able.data.AbleVariable |
myChgSupport,
myContext,
myDataType,
myId,
myName,
myReferences |
Constructor Summary | |
AbleNumericVariable(java.lang.Object theContext,
java.beans.PropertyChangeSupport theChgSupport,
int theId,
java.lang.String theName,
double theInitialValue)
Create a new numeric variable with the specified initial value. |
|
AbleNumericVariable(java.lang.String theName,
double theInitialValue)
Create a new numeric variable with the specified initial value. |
Method Summary | |
boolean |
cmpEq(AbleRd theRhs)
Comparison, equal to: compare the current value of this data object to the current value of theRhs. |
boolean |
cmpGt(AbleRd theRhs)
Comparison, greater than: compare the current value of this data object to the current value of theRhs. |
boolean |
cmpGtEq(AbleRd theRhs)
Comparison, greater than or equal to: compare the current value of this data object to the current value of theRhs. |
boolean |
cmpLt(AbleRd theRhs)
Comparison, less than: compare the current value of this data object to the current value of theRhs. |
boolean |
cmpLtEq(AbleRd theRhs)
Comparison, less than or equal to: compare the current value of this data object to the current value of theRhs. |
boolean |
cmpNeq(AbleRd theRhs)
Comparison, not equal to: compare the current value of this data object to the current value of theRhs. |
static java.lang.String |
Copyright()
Determine the copyright of this class. |
boolean |
getBooleanValue()
Retrieve the value of this data object as a boolean value. |
AbleLiteral |
getFuzzyValue()
Retrieve the value of this data object as a fuzzy value. |
java.lang.Object |
getGenericValue()
Retrieve the value of this data object as an Object. |
double |
getInitialValue()
Retrieve the variable's initial value. |
double |
getNumericValue()
Retrieve the value of this data object as a numeric value. |
java.lang.String |
getStringValue()
Retrieve the value of this data object as a string value. |
AbleLiteral |
getValue()
Retrieve the value of this data object as a literal. |
java.lang.String |
getValueString()
Retrieve the variable's current value as a string. |
void |
reset()
Reset the variable to its intial state. |
java.lang.String |
rlDclString()
Return a formal rule language "declaration" string that describes this data object. |
void |
setBooleanValue(boolean theNewValue)
Set the value of this data object from a boolean value. |
void |
setFuzzyValue(AbleLiteral theNewValue)
Set the value of this data object from a fuzzy value. |
void |
setGenericValue(java.lang.Object theNewValue)
Set the value of this data object from an object. |
void |
setNumericValue(double theNewValue)
Set the value of this data object from a numeric value. |
void |
setStringValue(java.lang.String theNewValue)
Set the value of this data object from a string value. |
void |
setValue(AbleLiteral theNewValue)
Set the value of this data object from a literal object. |
void |
setValueString(java.lang.String theNewValue)
Set the variable's current value from a string. |
java.lang.String |
toString()
Retrieve a string describing (the contents of) the object. |
java.lang.String |
xmlCWrString()
Return a formal XML "clause write" string that describes this data object. |
java.lang.String |
xmlDclString()
Return a formal XML "declaration" string that describes this data object. |
Methods inherited from class com.ibm.able.data.AbleVariable |
getChgSupport,
getContext,
getDataType,
getDataTypeAsString,
getId,
getName,
getReferences,
getReferent,
rlCRdString,
setChgSupport,
setContext,
setId,
setReferences,
xmlCRdString |
Methods inherited from class com.ibm.able.data.AbleLhs |
asgnEq,
asgnIs,
asgnIs,
cmpIs |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
protected double myValue
protected double myValueInitial
Constructor Detail |
public AbleNumericVariable(java.lang.Object theContext, java.beans.PropertyChangeSupport theChgSupport, int theId, java.lang.String theName, double theInitialValue)
theContext
- The context in which this variable resides. May be
an Able ruleset, for example, or null if the
variable is not part of any context.
theChgSupport
- For throwing property change events.
This may be null.
theId
- The unique Id of the variable.
theName
- The unique name of the variable.
theInitialValue
- The value to which this variable is initially set.
public AbleNumericVariable(java.lang.String theName, double theInitialValue)
theName
- The unique name of the variable.
theInitialValue
- The value to which this variable is initially set.
Method Detail |
public boolean getBooleanValue() throws AbleDataException
public AbleLiteral getFuzzyValue() throws AbleDataException
public java.lang.Object getGenericValue() throws AbleDataException
public double getNumericValue() throws AbleDataException
public java.lang.String getStringValue() throws AbleDataException
public AbleLiteral getValue() throws AbleDataException
public boolean cmpEq(AbleRd theRhs) throws AbleDataException
"==" is used for numeric and boolean compares; equals() is used for Object compares; and Collator.equals() is used for String compares.
theRhs
- The right-hand side of the comparison.
public boolean cmpGt(AbleRd theRhs) throws AbleDataException
">" is used for numeric compares; Collator.compare() is used for String compares. Use of other data types on the left-hand side causes an exception.
theRhs
- The right-hand side of the comparison.
public boolean cmpGtEq(AbleRd theRhs) throws AbleDataException
">=" is used for numeric compares; Collator.compare() is used for String compares. Use of other data types on the left-hand side causes an exception.
theRhs
- The right-hand side of the comparison.
public boolean cmpLt(AbleRd theRhs) throws AbleDataException
"<" is used for numeric compares; Collator.compare() is used for String compares. Use of other data types on the left-hand side causes an exception.
theRhs
- The right-hand side of the comparison.
public boolean cmpLtEq(AbleRd theRhs) throws AbleDataException
"<=" is used for numeric compares; Collator.compare() is used for String compares. Use of other data types on the left-hand side causes an exception.
theRhs
- The right-hand side of the comparison.
public boolean cmpNeq(AbleRd theRhs) throws AbleDataException
"!=" is used for numeric and boolean compares; ! equals() is used for Object compares; and ! Collator.equals() is used for String compares.
theRhs
- The right-hand side of the comparison.
public void setBooleanValue(boolean theNewValue) throws AbleDataException
theNewValue
- A boolean value.
If the new value is true the variable is set to
1.0;
if the new value is false the variable is set to
0.0.
public void setFuzzyValue(AbleLiteral theNewValue) throws AbleDataException
theNewValue
- A fuzzy set.
public void setGenericValue(java.lang.Object theNewValue) throws AbleDataException
theNewValue
- Any type of Object.
public void setNumericValue(double theNewValue) throws AbleDataException
theNewValue
- Any number.
public void setStringValue(java.lang.String theNewValue) throws AbleDataException
theNewValue
- A string.
The variable is set to the value of the string, but
only if the string can be parsed to a double;
otherwise an exception is thrown.
public void setValue(AbleLiteral theNewValue) throws AbleDataException
theNewValue
- An Able literal of any type. An attempt is made to
convert the literal to an appropriate type before
assigning it to this "writable" object.
public java.lang.String rlDclString()
public java.lang.String xmlDclString()
public java.lang.String xmlCWrString()
public void setValueString(java.lang.String theNewValue) throws AbleDataException
public java.lang.String getValueString()
public void reset()
public double getInitialValue()
public java.lang.String toString()
public static java.lang.String Copyright()
|
ABLE, Version 1.1b | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |