|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.able.data.AbleLhs
This class defines the base class from which all data objects that can appear on the lefthand side of a clause must inherit. This base data object implements both the "readable" and "writable" interfaces.
Constructor Summary | |
---|---|
AbleLhs()
|
Method Summary | |
---|---|
abstract java.lang.String |
arlCRdString()
Return an ARL "clause" string that describes this data object. |
abstract java.lang.String |
arlDclString()
Return a formal rule language "declaration" string that describes this data object. |
void |
asgnEq(AbleRd theRhs)
Assignment (boolean): assign the current value of theRhs to this data object. |
void |
asgnIs(AbleRd theRhs)
Assignment (fuzzy): assign the current value of theRhs to this data object. |
void |
asgnIs(AbleRd theRhs,
double theTruthValue)
Assignment (fuzzy): assign the current value of theRhs to this data object, correlated with the specified truth value. |
AbleLiteral |
bitwiseAND(AbleRd theRhs)
Bitwise AND the current value of this data object with the current value of theRhs. |
AbleLiteral |
bitwiseNOT(AbleRd theRhs)
Bitwise NOT: complement the current value of this data object. |
AbleLiteral |
bitwiseOR(AbleRd theRhs)
Bitwise OR the current value of this data object with the current value of theRhs. |
AbleLiteral |
bitwiseShiftLeft(AbleRd theRhs)
Bitwise Shift Left the current value of this data object by the current value of theRhs. |
AbleLiteral |
bitwiseShiftRight(AbleRd theRhs)
Bitwise Shift Right the current value of this data object by the current value of theRhs. |
AbleLiteral |
bitwiseShiftRightZeroFill(AbleRd theRhs)
Bitwise Shift Right with Zero Fill the current value of this data object by the current value of theRhs. |
AbleLiteral |
bitwiseXOR(AbleRd theRhs)
Bitwise XOR: exclusive OR the current value of this data object with the current value of theRhs. |
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. |
double |
cmpIs(AbleRd theRhs)
Comparison, fuzzy 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. |
AbleLiteral |
compDivide(AbleRd theRhs)
Compute, divide the current value of this data object by the current value of theRhs. |
AbleLiteral |
compMinus(AbleRd theRhs)
Compute, subtract the current value of theRhs from the current value of this object. |
AbleLiteral |
compModulo(AbleRd theRhs)
Compute, modulo - return the remainder of a divide the current int value of this data object by the current value of theRhs. |
AbleLiteral |
compMultiply(AbleRd theRhs)
Compute, multiply the current value of this data object to the current value of theRhs. |
AbleLiteral |
compPlus(AbleRd theRhs)
Compute, add or concatenate the current value of this data object to the current value of theRhs. |
AbleLiteral |
compUnaryMinus(AbleRd theRhs)
Compute, the unary minus of the current value of this object. |
static java.lang.String |
Copyright()
Determine the copyright of this class. |
abstract boolean |
getBooleanValue()
Retrieve the value of this data object as a boolean value. |
abstract int |
getDataType()
Retrieve the data type of this data object. |
abstract java.lang.Class |
getDataTypeClass()
Retrieve the actual class of this object's underlying data type. |
abstract java.lang.String |
getDataTypeClassName()
Retrieve the name of the class of this object's underlying data type. |
abstract AbleFuzzySet |
getFuzzyValue()
Retrieve the value of this data object as a fuzzy value. |
abstract java.lang.Object |
getGenericValue()
Retrieve the value of this data object as an Object. |
abstract double |
getNumericValue()
Retrieve the value of this data object as a numeric value. |
abstract int |
getReferent()
Retrieve the Id of the variable to which this data object refers, if any. |
abstract java.lang.String |
getStringValue()
Retrieve the value of this data object as a string value. |
abstract AbleLiteral |
getValue()
Retrieve the value of this data object as a literal. |
boolean |
isConstant()
Returns true if this AbleRd object is a constant value false, if it does not. |
boolean |
logicalAND(AbleRd theRhs)
Logical AND the current value of this data object with the current value of theRhs. |
boolean |
logicalNOT(AbleRd theRhs)
Logical NOT: complement the current value of this data object. |
boolean |
logicalOR(AbleRd theRhs)
Logical OR the current value of this data object with the current value of theRhs. |
abstract void |
setBooleanValue(boolean theNewValue)
Set the value of this data object from a boolean value. |
abstract void |
setFuzzyValue(AbleFuzzySet theNewValue)
Set the value of this data object from a fuzzy value. |
abstract void |
setGenericValue(java.lang.Object theNewValue)
Set the value of this data object from an object. |
abstract void |
setNumericValue(double theNewValue)
Set the value of this data object from a numeric value. |
abstract void |
setStringValue(java.lang.String theNewValue)
Set the value of this data object from a string value. |
abstract void |
setValue(AbleLiteral theNewValue)
Set the value of this data object from a literal object. |
abstract java.lang.String |
traceString(int theTraceStringFlavor)
Retrieve a string describing (the contents of) the object. |
abstract java.lang.String |
xmlCRdString()
Return a formal XML "read clause" string that describes this data object; for example, "very, very hot". |
abstract java.lang.String |
xmlCWrString()
Return a formal XML "clause write" string that describes this data object. |
abstract java.lang.String |
xmlDclString()
Return a formal XML "declaration" string that describes this data object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.ibm.able.data.AbleRd |
---|
getReferents, getTemplateString |
Constructor Detail |
public AbleLhs()
Method Detail |
public abstract boolean getBooleanValue() throws AbleDataException
getBooleanValue
in interface AbleRd
AbleDataException
- If the value of this object cannot be represented as
a boolean value.public abstract AbleFuzzySet getFuzzyValue() throws AbleDataException
getFuzzyValue
in interface AbleRd
AbleDataException
- If the value of this object cannot be represented as
a fuzzy value.public abstract java.lang.Object getGenericValue() throws AbleDataException
getGenericValue
in interface AbleRd
AbleDataException
- If the value of this object cannot be represented as
an Object.public abstract double getNumericValue() throws AbleDataException
getNumericValue
in interface AbleRd
AbleDataException
- If the value of this object cannot be represented as
a numeric value.public abstract java.lang.String getStringValue() throws AbleDataException
getStringValue
in interface AbleRd
AbleDataException
- If the value of this object cannot be represented as
a string value.public abstract AbleLiteral getValue() throws AbleDataException
getValue
in interface AbleRd
AbleDataException
- If the value of this object cannot be represented as
a literal.public abstract int getReferent()
getReferent
in interface AbleRd
public abstract int getDataType()
getDataType
in interface AbleRd
public abstract java.lang.Class getDataTypeClass()
getDataTypeClass
in interface AbleRd
public abstract java.lang.String getDataTypeClassName()
getDataTypeClassName
in interface AbleRd
public abstract java.lang.String arlCRdString()
arlCRdString
in interface AbleRd
public abstract java.lang.String xmlCRdString()
xmlCRdString
in interface AbleRd
public abstract java.lang.String traceString(int theTraceStringFlavor)
traceString
in interface AbleRd
theFlavor
- An AbleRuleSet.TraceStringFlavor value.
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.
cmpEq
in interface AbleRd
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.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.
cmpGt
in interface AbleRd
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.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.
cmpGtEq
in interface AbleRd
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public double cmpIs(AbleRd theRhs) throws AbleDataException
Fuzzy membership is used for the compare.
cmpIs
in interface AbleRd
theRhs
- The right-hand side of the comparison.
This must be a fuzzy set.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.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.
cmpLt
in interface AbleRd
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.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.
cmpLtEq
in interface AbleRd
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.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.
cmpNeq
in interface AbleRd
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral compPlus(AbleRd theRhs) throws AbleDataException
"+" is used for numeric addtion and String concatenation.
compPlus
in interface AbleRd
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral compMinus(AbleRd theRhs) throws AbleDataException
"-" is used for numeric subtraction.
compMinus
in interface AbleRd
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral compMultiply(AbleRd theRhs) throws AbleDataException
"*" is used for numeric multiplication.
compMultiply
in interface AbleRd
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral compDivide(AbleRd theRhs) throws AbleDataException
"/" is used for numeric division.
compDivide
in interface AbleRd
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral compModulo(AbleRd theRhs) throws AbleDataException
"%" is used for computing the remainder of an integer division.
compModulo
in interface AbleRd
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral compUnaryMinus(AbleRd theRhs) throws AbleDataException
"-" is used for numeric negation.
compUnaryMinus
in interface AbleRd
theRhs
- The right-hand side of the operation (ignored).
AbleDataException
- If the value of this data object cannot be negated.public boolean logicalAND(AbleRd theRhs) throws AbleDataException
"&&" is used for boolean AND.
logicalAND
in interface AbleRd
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public boolean logicalOR(AbleRd theRhs) throws AbleDataException
"||" is used for boolean OR.
logicalOR
in interface AbleRd
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public boolean logicalNOT(AbleRd theRhs) throws AbleDataException
"!" is used for boolean NOT.
logicalNOT
in interface AbleRd
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral bitwiseAND(AbleRd theRhs) throws AbleDataException
"&" is used for bitwise AND.
bitwiseAND
in interface AbleRd
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral bitwiseOR(AbleRd theRhs) throws AbleDataException
"|" is used for bitwise OR.
bitwiseOR
in interface AbleRd
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral bitwiseXOR(AbleRd theRhs) throws AbleDataException
"^" is used for bitwise XOR.
bitwiseXOR
in interface AbleRd
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral bitwiseNOT(AbleRd theRhs) throws AbleDataException
"~" is used for bitwise NOT or complement.
bitwiseNOT
in interface AbleRd
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral bitwiseShiftLeft(AbleRd theRhs) throws AbleDataException
"&&" is used for boolean AND.
bitwiseShiftLeft
in interface AbleRd
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral bitwiseShiftRight(AbleRd theRhs) throws AbleDataException
">>" is used for bitwise shift right.
bitwiseShiftRight
in interface AbleRd
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral bitwiseShiftRightZeroFill(AbleRd theRhs) throws AbleDataException
">>" is used for bitwise shift right with zero fill.
bitwiseShiftRightZeroFill
in interface AbleRd
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public boolean isConstant()
AbleRd
isConstant
in interface AbleRd
public abstract void setBooleanValue(boolean theNewValue) throws AbleDataException
setBooleanValue
in interface AbleWr
theNewValue
- A boolean value.
AbleDataException
- If the value of this object cannot be represented as
a boolean value.public abstract void setFuzzyValue(AbleFuzzySet theNewValue) throws AbleDataException
setFuzzyValue
in interface AbleWr
theNewValue
- A fuzzy set.
AbleDataException
- If the value of this object cannot be represented as
a fuzzy value.public abstract void setGenericValue(java.lang.Object theNewValue) throws AbleDataException
setGenericValue
in interface AbleWr
theNewValue
- Any type of Object.
AbleDataException
- If the value of this object cannot be derived from
the specified Object.public abstract void setNumericValue(double theNewValue) throws AbleDataException
setNumericValue
in interface AbleWr
theNewValue
- Any number.
AbleDataException
- If the value of this object cannot be represented as
a numeric value.public abstract void setStringValue(java.lang.String theNewValue) throws AbleDataException
setStringValue
in interface AbleWr
theNewValue
- A string.
AbleDataException
- If the value of this object cannot be represented as
a string value.public abstract void setValue(AbleLiteral theNewValue) throws AbleDataException
setValue
in interface AbleWr
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.
AbleDataException
- If the value of this object cannot be determined
from the literal object.public abstract java.lang.String arlDclString()
arlDclString
in interface AbleWr
public abstract java.lang.String xmlDclString()
xmlDclString
in interface AbleWr
public abstract java.lang.String xmlCWrString()
xmlCWrString
in interface AbleWr
public void asgnEq(AbleRd theRhs) throws AbleDataException
asgnEq
in interface AbleWr
theRhs
- The right-hand, or source, side of the assignment.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and assigned to this data object.public void asgnIs(AbleRd theRhs) throws AbleDataException
asgnIs
in interface AbleWr
theRhs
- The right-hand, or source, side of the assignment.
This must be a fuzzy set.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and assigned to this data object.public void asgnIs(AbleRd theRhs, double theTruthValue) throws AbleDataException
asgnIs
in interface AbleWr
theRhs
- The right-hand, or source, side of the assignment.
This must be a fuzzy set.
theTruthValue
- the truth value with which theRhs is correlated.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and assigned to this data object.public static java.lang.String Copyright()
|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |