ABLE, Version 1.1b

com.ibm.able.data
Class AbleDiscreteVariable

java.lang.Object
  |
  +--com.ibm.able.data.AbleLhs
        |
        +--com.ibm.able.data.AbleVariable
              |
              +--com.ibm.able.data.AbleDiscreteVariable
Direct Known Subclasses:
AbleDiscreteField

public class AbleDiscreteVariable
extends AbleVariable
implements java.io.Serializable

This class defines the Able data discrete variable.

Discrete variables are essentially numeric variables, but rather than assuming any arbitrary number as the current value, a discrete variable can be assigned only 1 of N pre-defined numbers.

Version:
$Revision: 1.9 $, $Date: 2000/09/26 21:03:13 $
See Also:
Serialized Form

Field Summary
protected  double myMaxValue
           
protected  boolean myMaxValueKnown
           
protected  double myMinValue
           
protected  boolean myMinValueKnown
           
protected  double myValue
           
protected  double myValueInitial
           
protected  java.util.Vector myValueList
           
 
Fields inherited from class com.ibm.able.data.AbleVariable
myChgSupport, myContext, myDataType, myId, myName, myReferences
 
Constructor Summary
AbleDiscreteVariable(java.lang.Object theContext, java.beans.PropertyChangeSupport theChgSupport, int theId, java.lang.String theName)
          Create a new discrete variable.
AbleDiscreteVariable(java.lang.Object theContext, java.beans.PropertyChangeSupport theChgSupport, int theId, java.lang.String theName, java.util.Vector theValueList)
          Create a new discrete variable over the specified numbers.
AbleDiscreteVariable(java.lang.String theName, java.util.Vector theValueList)
          Create a new discrete variable over the specified numbers.
 
Method Summary
 void addValue(double theValue)
          Add a value to the list of pre-defined values.
 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.
 int getIndexOf(double theValue)
          Retrieve the index of a value in the list of pre-defined values.
 double getInitialValue()
          Retrieve the variable's initial value.
 double getMaxValue()
          Retrieve the maximum value in the list of pre-defined values.
 double getMinValue()
          Retrieve the minimum value in the list of pre-defined values.
 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.
 double getValueAt(int theIndex)
          Retrieve the value at a specific location in the list of pre-defined values.
 java.util.Vector getValueList()
          Retrieve the list of pre-defined values for this variable.
 int getValueListSize()
          Retrieve the number of pre-defined values for this variable.
 java.lang.String getValueString()
          Retrieve the variable's current value as a string.
 void removeValue(double theValue)
          Remove a value from the list of pre-defined values.
 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 setValueList(java.util.Vector theNewValueList)
          Set the list of pre-defined values, any one of which may be assigned to the current value of this variable.
 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.
 boolean valueExist(double theValue)
          Determine whether a value exists in the list of pre-defined values.
 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

myValue

protected double myValue

myValueInitial

protected double myValueInitial

myValueList

protected java.util.Vector myValueList

myMaxValueKnown

protected boolean myMaxValueKnown

myMaxValue

protected double myMaxValue

myMinValueKnown

protected boolean myMinValueKnown

myMinValue

protected double myMinValue
Constructor Detail

AbleDiscreteVariable

public AbleDiscreteVariable(java.lang.Object theContext,
                            java.beans.PropertyChangeSupport theChgSupport,
                            int theId,
                            java.lang.String theName,
                            java.util.Vector theValueList)
Create a new discrete variable over the specified numbers.

The initial value of this variable cannot be specified and is set to Double.NaN.

Parameters:
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.

theValueList - A list of numbers (Double objects), any one of which can be the current value of this variable. The list is cloned.


AbleDiscreteVariable

public AbleDiscreteVariable(java.lang.Object theContext,
                            java.beans.PropertyChangeSupport theChgSupport,
                            int theId,
                            java.lang.String theName)
Create a new discrete variable. The value list must be set in a subsequent call.

The initial value of this variable cannot be specified and is set to Double.NaN.

Parameters:
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.


AbleDiscreteVariable

public AbleDiscreteVariable(java.lang.String theName,
                            java.util.Vector theValueList)
Create a new discrete variable over the specified numbers.

The initial value of this variable cannot be specified and is set to Double.NaN.

Parameters:
theName - The unique name of the variable.

theValueList - A list of numbers (Double objects), any one of which can be the current value of this variable. The list is cloned.

Method Detail

getBooleanValue

public boolean getBooleanValue()
                        throws AbleDataException
Retrieve the value of this data object as a boolean value.
Returns:
A boolean, if the value of this object can be represented as a boolean value. If the current value is NaN, an exception is thrown; if the current value is 0.0, false is returned; any other numeric value returns true.
Throws:
AbleDataException - If the value of this object cannot be represented as a boolean value.
Overrides:
getBooleanValue in class AbleLhs

getFuzzyValue

public AbleLiteral getFuzzyValue()
                          throws AbleDataException
Retrieve the value of this data object as a fuzzy value.
Returns:
A fuzzy set, if the value of this object can be represented as a fuzzy value. This method always throws an exception.
Throws:
AbleDataException - If the value of this object cannot be represented as a fuzzy value.
Overrides:
getFuzzyValue in class AbleLhs

getGenericValue

public java.lang.Object getGenericValue()
                                 throws AbleDataException
Retrieve the value of this data object as an Object.
Returns:
A Double object.
Throws:
AbleDataException - If the value of this object cannot be represented as an Object.
Overrides:
getGenericValue in class AbleLhs

getNumericValue

public double getNumericValue()
                       throws AbleDataException
Retrieve the value of this data object as a numeric value.
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.
Overrides:
getNumericValue in class AbleLhs

getStringValue

public java.lang.String getStringValue()
                                throws AbleDataException
Retrieve the value of this data object as a string value.
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.
Overrides:
getStringValue in class AbleLhs

getValue

public AbleLiteral getValue()
                     throws AbleDataException
Retrieve the value of this data object as a literal.
Returns:
An AbleNumericLiteral object.
Throws:
AbleDataException - If the value of this object cannot be represented as a literal.
Overrides:
getValue in class AbleLhs

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.

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.
Overrides:
cmpEq in class AbleLhs

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.

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.
Overrides:
cmpGt in class AbleLhs

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.

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.
Overrides:
cmpGtEq in class AbleLhs

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.

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.
Overrides:
cmpLt in class AbleLhs

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.

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.
Overrides:
cmpLtEq in class AbleLhs

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.

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.
Overrides:
cmpNeq in class AbleLhs

setBooleanValue

public void setBooleanValue(boolean theNewValue)
                     throws AbleDataException
Set the value of this data object from a boolean value.
Parameters:
theNewValue - A boolean value. If the new value is true the variable is set to 1.0, but only if 1.0 is a valid pre-defined number for this variable; if the new value is false the variable is set to 0.0, but only if 0.0 is a valid pre-defined number; in all other cases an exception is thrown.

Throws:
AbleDataException - If the value of this object cannot be represented as a boolean value.
Overrides:
setBooleanValue in class AbleLhs

setFuzzyValue

public void setFuzzyValue(AbleLiteral theNewValue)
                   throws AbleDataException
Set the value of this data object from a fuzzy value. This method always throws an exception.
Parameters:
theNewValue - A fuzzy set.

Throws:
AbleDataException - If the value of this object cannot be represented as a fuzzy value.
Overrides:
setFuzzyValue in class AbleLhs

setGenericValue

public void setGenericValue(java.lang.Object theNewValue)
                     throws AbleDataException
Set the value of this data object from an object.
Parameters:
theNewValue - Any type of Object.

Throws:
AbleDataException - If the value of this object cannot be derived from the specified Object.
Overrides:
setGenericValue in class AbleLhs

setNumericValue

public void setNumericValue(double theNewValue)
                     throws AbleDataException
Set the value of this data object from a numeric value.
Parameters:
theNewValue - Any number. The variable is set to the new value, but only if that value is a pre-defined number of the variable; otherwise an exception is thrown.

Throws:
AbleDataException - If the value of this object cannot be represented as a numeric value.
Overrides:
setNumericValue in class AbleLhs

setStringValue

public void setStringValue(java.lang.String theNewValue)
                    throws AbleDataException
Set the value of this data object from a string value.
Parameters:
theNewValue - A string. The variable is set to the value of the string, but only if the string can be parsed to a double and that number is a pre-defined number of the variable; otherwise an exception is thrown.

Throws:
AbleDataException - If the value of this object cannot be represented as a string value.
Overrides:
setStringValue in class AbleLhs

setValue

public void setValue(AbleLiteral theNewValue)
              throws AbleDataException
Set the value of this data object from a literal object.
Parameters:
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.

Throws:
AbleDataException - If the value of this object cannot be determined from the literal object.
Overrides:
setValue in class AbleLhs

rlDclString

public java.lang.String rlDclString()
Return a formal rule language "declaration" string that describes this data object.
Returns:
A String describing the data object in formal rule language.
Overrides:
rlDclString in class AbleVariable

xmlDclString

public java.lang.String xmlDclString()
Return a formal XML "declaration" string that describes this data object.
Returns:
A String describing the data object in XML.
Overrides:
xmlDclString in class AbleVariable

xmlCWrString

public java.lang.String xmlCWrString()
Return a formal XML "clause write" string that describes this data object.
Returns:
A String describing the data object in XML.
Overrides:
xmlCWrString in class AbleVariable

setValueString

public void setValueString(java.lang.String theNewValue)
                    throws AbleDataException
Set the variable's current value from a string. Note: This method is provided for the use of a rule language parser.
Overrides:
setValueString in class AbleVariable

getValueString

public java.lang.String getValueString()
Retrieve the variable's current value as a string. Note: This method is provided for the use of a rule language parser.
Overrides:
getValueString in class AbleVariable

reset

public void reset()
Reset the variable to its intial state.
Overrides:
reset in class AbleVariable

getInitialValue

public double getInitialValue()
Retrieve the variable's initial value.

setValueList

public void setValueList(java.util.Vector theNewValueList)
Set the list of pre-defined values, any one of which may be assigned to the current value of this variable. Values not appearing in this list may not be assigned to this variable.

If the current value of this variable does not appear in the new value list, the current value is set to Double.NaN.

Parameters:
theNewValueList - A list where each element is a Double object.

The input list is cloned and saved.


getValueList

public java.util.Vector getValueList()
Retrieve the list of pre-defined values for this variable.
Returns:
A reference to the actual list and not a clone.

getValueListSize

public int getValueListSize()
Retrieve the number of pre-defined values for this variable.
Returns:
The number of values in the value list.

valueExist

public boolean valueExist(double theValue)
Determine whether a value exists in the list of pre-defined values.
Parameters:
theValue - A value whose existence in the list of pre-defined values is to be determined.

Returns:
true if the specified value exists in the list, false otherwise.

addValue

public void addValue(double theValue)
              throws AbleDataException
Add a value to the list of pre-defined values.
Parameters:
theValue - A value to add to the list of pre-defined values.

Throws:
AbleDataException - if the specified value already exists in the list.

removeValue

public void removeValue(double theValue)
                 throws AbleDataException
Remove a value from the list of pre-defined values.

If the current value of this variable corresponds to the value being removed, the current value is set to Double.NaN.

Parameters:
theValue - A value to remove from the list of pre-defined values.

Throws:
AbleDataException - if the specified value does not exist in the list.

getIndexOf

public int getIndexOf(double theValue)
               throws AbleDataException
Retrieve the index of a value in the list of pre-defined values.
Parameters:
theValue - A value whose index is to be returned.

Returns:
The index of the specified value.
Throws:
AbleDataException - if the specified value does not exist in the list.

getValueAt

public double getValueAt(int theIndex)
                  throws AbleDataException
Retrieve the value at a specific location in the list of pre-defined values.
Parameters:
theIndex - The location whose value is to be returned.

Returns:
The value at the specified location.
Throws:
AbleDataException - if the specified location is out of bounds.

getMaxValue

public double getMaxValue()
Retrieve the maximum value in the list of pre-defined values.

If the value is already known, it is simply returned. If the value is not known, it is computed, which can possibly be time consuming depending on the size of the list of pre-defined values. Any change to the list, by adding or removing elements with the provided methods, means that the value will need to be recomputed.

If the user obtains a direct reference to the list by means of the getValueList() method, and then manipulates the list directly, this method will not return the correct value.

Returns:
The maximum of all the values in the list of pre-defined values. If the list is empty or otherwise not set, Double.NaN is returned.

getMinValue

public double getMinValue()
Retrieve the minimum value in the list of pre-defined values.

If the value is already known, it is simply returned. If the value is not known, it is computed, which can possibly be time consuming depending on the size of the list of pre-defined values. Any change to the list, by adding or removing elements with the provided methods, means that the value will need to be recomputed.

If the user obtains a direct reference to the list by means of the getValueList() method, and then manipulates the list directly, this method will not return the correct value.

Returns:
The minimum of all the values in the list of pre-defined values. If the list is empty or otherwise not set, Double.NaN is returned.

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 AbleVariable

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