ABLE, Version 1.1b

com.ibm.able.data
Class AbleLiteral

java.lang.Object
  |
  +--com.ibm.able.data.AbleLiteral
Direct Known Subclasses:
AbleBooleanLiteral, AbleCallLiteral, AbleGenericLiteral, AbleNumericLiteral, AbleStringLiteral

public abstract class AbleLiteral
extends java.lang.Object
implements AbleRd, java.io.Serializable

This class defines the base Able data literal value.

Version:
$Revision: 1.3 $, $Date: 2000/08/24 12:13:34 $
See Also:
Serialized Form

Field Summary
protected  int myDataType
           
 
Constructor Summary
protected AbleLiteral(int theDataType)
          Create a new literal of the specified type.
 
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.
 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.
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.
 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  AbleLiteral 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.
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.
abstract  java.lang.String rlCRdString()
          Return a formal rule language "clause read" string that describes this data object.
 java.lang.String toString()
          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
 

Field Detail

myDataType

protected int myDataType
Constructor Detail

AbleLiteral

protected AbleLiteral(int theDataType)
Create a new literal of the specified type.
Parameters:
theDataType - An AbleData.<DataType> constant.

Method Detail

getBooleanValue

public abstract boolean getBooleanValue()
                                 throws AbleDataException
Retrieve the value of this data object as a boolean value.
Specified by:
getBooleanValue in interface AbleRd
Returns:
A boolean, if the value of this object can be represented as a boolean value.
Throws:
AbleDataException - If the value of this object cannot be represented as a boolean value.

getFuzzyValue

public abstract AbleLiteral getFuzzyValue()
                                   throws AbleDataException
Retrieve the value of this data object as a fuzzy value.
Specified by:
getFuzzyValue in interface AbleRd
Returns:
A fuzzy set, if the value of this object can be represented as a fuzzy value.
Throws:
AbleDataException - If the value of this object cannot be represented as a fuzzy value.

getGenericValue

public abstract java.lang.Object getGenericValue()
                                          throws AbleDataException
Retrieve the value of this data object as an Object.
Specified by:
getGenericValue in interface AbleRd
Returns:
A Boolean, Double, String or Object object depending on the derived class.
Throws:
AbleDataException - If the value of this object cannot be represented as an Object.

getNumericValue

public abstract double getNumericValue()
                                throws AbleDataException
Retrieve the value of this data object as a numeric value.
Specified by:
getNumericValue in interface AbleRd
Returns:
A double, if the value of this object can be represented as a numeric value.
Throws:
AbleDataException - If the value of this object cannot be represented as a numeric value.

getStringValue

public abstract java.lang.String getStringValue()
                                         throws AbleDataException
Retrieve the value of this data object as a string value.
Specified by:
getStringValue in interface AbleRd
Returns:
A String, if the value of this object can be represented as a string value.
Throws:
AbleDataException - If the value of this object cannot be represented as a string value.

getValue

public abstract AbleLiteral getValue()
                              throws AbleDataException
Retrieve the value of this data object as a literal.
Specified by:
getValue in interface AbleRd
Returns:
An AbleLiteral object.
Throws:
AbleDataException - If the value of this object cannot be represented as a literal.

getReferent

public int getReferent()
Retrieve the Id of the variable to which this data object refers, if any.
Specified by:
getReferent in interface AbleRd
Returns:
The Id of the variable to which this data object refers, or AbleData.VarIdNull if the data object is a literal and therefore refers to no variable.

getDataType

public int getDataType()
Retrieve the data type of this data object.
Specified by:
getDataType in interface AbleRd
Returns:
An AbleData.<DataType> constant.

rlCRdString

public abstract java.lang.String rlCRdString()
Return a formal rule language "clause read" string that describes this data object.
Specified by:
rlCRdString in interface AbleRd
Returns:
A String describing the data object in formal rule language.

xmlCRdString

public abstract java.lang.String xmlCRdString()
Return a formal XML "clause read" string that describes this data object.
Specified by:
xmlCRdString in interface AbleRd
Returns:
A String describing the data object in XML.

cmpEq

public boolean cmpEq(AbleRd theRhs)
              throws AbleDataException
Comparison, equal to: compare the current value of this data object to the current value of theRhs.

"==" is used for numeric and boolean compares; equals() is used for Object compares; and Collator.equals() is used for String compares.

Specified by:
cmpEq in interface AbleRd
Parameters:
theRhs - The right-hand side of the comparison.

Returns:
true, if this data object is equal to theRhs; false, otherwise.
Throws:
AbleDataException - If the right-hand side cannot be converted (if necessary) and compared to this data object.

cmpGt

public boolean cmpGt(AbleRd theRhs)
              throws AbleDataException
Comparison, greater than: compare the current value of this data object to the current value of theRhs.

">" 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.

Specified by:
cmpGt in interface AbleRd
Parameters:
theRhs - The right-hand side of the comparison.

Returns:
true, if this data object is greater than theRhs; false, otherwise.
Throws:
AbleDataException - If the right-hand side cannot be converted (if necessary) and compared to this data object.

cmpGtEq

public boolean cmpGtEq(AbleRd theRhs)
                throws AbleDataException
Comparison, greater than or equal to: compare the current value of this data object to the current value of theRhs.

">=" 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.

Specified by:
cmpGtEq in interface AbleRd
Parameters:
theRhs - The right-hand side of the comparison.

Returns:
true, if this data object is greater than or equal to theRhs; false, otherwise.
Throws:
AbleDataException - If the right-hand side cannot be converted (if necessary) and compared to this data object.

cmpIs

public double cmpIs(AbleRd theRhs)
             throws AbleDataException
Comparison, fuzzy equal to: compare the current value of this data object to the current value of theRhs.

Fuzzy membership is used for the compare.

Specified by:
cmpIs in interface AbleRd
Parameters:
theRhs - The right-hand side of the comparison. This must be a fuzzy set.

Returns:
The membership of the fuzzy variable's crisp value within the fuzzy ste.
Throws:
AbleDataException - If the right-hand side cannot be converted (if necessary) and compared to this data object.

cmpLt

public boolean cmpLt(AbleRd theRhs)
              throws AbleDataException
Comparison, less than: compare the current value of this data object to the current value of theRhs.

"<" 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.

Specified by:
cmpLt in interface AbleRd
Parameters:
theRhs - The right-hand side of the comparison.

Returns:
true, if this data object is less than theRhs; false, otherwise.
Throws:
AbleDataException - If the right-hand side cannot be converted (if necessary) and compared to this data object.

cmpLtEq

public boolean cmpLtEq(AbleRd theRhs)
                throws AbleDataException
Comparison, less than or equal to: compare the current value of this data object to the current value of theRhs.

"<=" 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.

Specified by:
cmpLtEq in interface AbleRd
Parameters:
theRhs - The right-hand side of the comparison.

Returns:
true, if this data object is less than or equal to theRhs; false, otherwise.
Throws:
AbleDataException - If the right-hand side cannot be converted (if necessary) and compared to this data object.

cmpNeq

public boolean cmpNeq(AbleRd theRhs)
               throws AbleDataException
Comparison, not equal to: compare the current value of this data object to the current value of theRhs.

"!=" is used for numeric and boolean compares; ! equals() is used for Object compares; and ! Collator.equals() is used for String compares.

Specified by:
cmpNeq in interface AbleRd
Parameters:
theRhs - The right-hand side of the comparison.

Returns:
true, if this data object is not equal to theRhs; false, otherwise.
Throws:
AbleDataException - If the right-hand side cannot be converted (if necessary) and compared to this data object.

getDataTypeAsString

public java.lang.String getDataTypeAsString()
Retrieve the type of this data object as a human-readable string.
Returns:
An AbleData.<DataType> constant turned into a formatted string.

toString

public java.lang.String toString()
Retrieve a string describing (the contents of) the object.
Returns:
A String containing the current contents of the object.
Overrides:
toString in class java.lang.Object

Copyright

public static java.lang.String Copyright()
Determine the copyright of this class.
Returns:
A String containing this class's copyright statement.

ABLE, Version 1.1b

ABLE: Produced by Joe, Don, and Jeff who say, 'Thanks for your support.'