|
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.AbleLiteral
This class defines an abstract base class for constant values and the operations on those values.
Constructor Summary | |
---|---|
protected |
AbleLiteral()
Create a new literal of the specified type. |
Method Summary | |
---|---|
abstract java.lang.String |
arlCRdString()
Return a formal ARL "clause read" string that describes this data object. |
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. |
java.lang.String |
getDataTypeAsString()
Retrieve the type of this data object as a human-readable string. |
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. |
int |
getReferent()
Retrieve the Id of the variable to which this data object refers, if any. |
java.util.BitSet |
getReferents()
Retrieve the Ids of the variables to which this data object refers, if any. |
abstract java.lang.String |
getStringValue()
Retrieve the value of this data object as a string value. |
java.lang.String |
getTemplateString(java.util.Vector theTemplateVars)
Return a formatted ARL text string for use by templates |
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. |
java.lang.String |
toString()
Retrieve a string describing (the contents of) the 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 "clause read" string that describes this data object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
protected AbleLiteral()
theDataType
- An AbleData.<DataType> constant.
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 int getReferent()
getReferent
in interface AbleRd
public java.util.BitSet getReferents()
getReferents
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 java.lang.String getTemplateString(java.util.Vector theTemplateVars)
getTemplateString
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 tom compute 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 java.lang.String getDataTypeAsString()
public java.lang.String toString()
toString
in class java.lang.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 |