ABLE 2.0.0 07/02/2003 10:25:01

com.ibm.able.data
Class AbleCategoricalVariable

java.lang.Object
  |
  +--com.ibm.able.data.AbleLhs
        |
        +--com.ibm.able.data.AbleVariable
              |
              +--com.ibm.able.data.AbleGenericVariable
                    |
                    +--com.ibm.able.data.AbleTypedVariable
                          |
                          +--com.ibm.able.data.AbleCategoricalVariable
All Implemented Interfaces:
AbleRd, AbleWr, java.io.Serializable
Direct Known Subclasses:
AbleCategoricalField

public class AbleCategoricalVariable
extends AbleTypedVariable
implements java.io.Serializable

This class defines the Able data categorical variable.

Categorical variables are essentially string variables, but rather than assuming any arbitrary string as the current value, a categorical variable can be assigned only 1 of N pre-defined strings, or categories.

See Also:
Serialized Form

Field Summary
protected  java.lang.String myInitialValue
          The initial String value used to reset this variable
protected  java.lang.String myValue
          The current value of the variable.
protected  java.util.Vector myValueList
          The list of possible values that this variable can assume.
 
Fields inherited from class com.ibm.able.data.AbleTypedVariable
myDataTypeClass, myDataTypeClassName, myDataTypeName, myInitialParms
 
Fields inherited from class com.ibm.able.data.AbleVariable
myBoundFlag, myChgSupport, myComment, myContext, myDataType, myGlobalFlag, myId, myName, myPrompt, myReferences, myStaticFlag, myTemplateFlag, myValueInitial
 
Constructor Summary
AbleCategoricalVariable(java.lang.Object[] theValueList)
          Create a AbleCategoricalVariable, used to initialize another categorical variable, over the specified categories.
AbleCategoricalVariable(java.lang.Object[] theValueList, java.lang.String theInitialValue)
          Create a new AbleCategoricalVariable, used to initialize another categorical variable, over the specified categories with the specified initial value.
AbleCategoricalVariable(java.lang.String theName, boolean theStaticFlag, boolean theGlobalFlag, java.util.Vector theValueList)
          Create a new AbleCategoricalVariable over the specified categories.
AbleCategoricalVariable(java.lang.String theName, java.util.Vector theValueList)
          Create a new AbleCategoricalVariable over the specified categories.
AbleCategoricalVariable(java.util.Vector theValueList)
          Create a new AbleCategoricalVariable, used to initialize another categorical variable, over the specified categories.
AbleCategoricalVariable(java.util.Vector theValueList, java.lang.String theInitialValue)
          Create a new AbleCategoricalVariable, used to initialize another categorical variable, over the specified categories with the specified initial value.
 
Method Summary
 void addValue(java.lang.String theValue)
          Add a value to the list of pre-defined values.
 java.lang.String arlDclString()
          Return a formal ARL "declaration" string that describes this data object.
 void asgnEq(AbleRd theRhs)
          Assignment: assign the current value of theRhs to this data object.
 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.
 AbleLiteral compPlus(AbleRd theRhs)
          Compute, concatenate the current value of this data object to the current value of theRhs.
 boolean getBooleanValue()
          Retrieve the value of this data object as a boolean value.
 java.lang.Class getDataTypeClass()
          Retrieve the actual class of this object's underlying data type.
 java.lang.String getDataTypeClassName()
          Retrieve the name of the class of this object's underlying data type.
 AbleFuzzySet 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(java.lang.String theValue)
          Retrieve the index of a value in the list of pre-defined values.
 java.lang.Class getLiteralClass()
          Retrieve the class of this variable's related AbleLiteral data type.
 double getNumericValue()
          Retrieve the value of this data object as a numeric value.
 java.lang.Object getRawValue()
          Retrieve the variable's current 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 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 init()
          Init the variable to its initial state.
 void removeValue(java.lang.String theValue)
          Remove a value from the list of pre-defined values.
 void reset()
          Reset the variable to its initial state.
 void setBooleanValue(boolean theNewValue)
          Set the value of this data object from a boolean value.
 void setFuzzyValue(AbleFuzzySet 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 setInitialValue(AbleRd theInitialValue)
          Set the initial value for this variable
 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.
 java.lang.String traceString(int theTraceStringFlavor)
          Retrieve a string describing (the contents of) the object.
 boolean valueExist(java.lang.String theValue)
          Determine whether a value exists in the list of pre-defined values.
 java.lang.String xmlDclString()
          Return a formal XML "declaration" string that describes this data object.
 
Methods inherited from class com.ibm.able.data.AbleTypedVariable
getDataTypeName, setRawValue
 
Methods inherited from class com.ibm.able.data.AbleGenericVariable
cmpIs, compDivide, compMinus, compMultiply, compUnaryMinus, replaceValues
 
Methods inherited from class com.ibm.able.data.AbleVariable
arlCRdString, arlInitializerString, getArlComment, getChgSupport, getComment, getContext, getDataType, getDataTypeAsString, getId, getName, getPrompt, getPromptString, getReferences, getReferent, getReferents, getTemplateString, isBound, isConstant, isGlobal, isLocal, isStatic, isTemplate, notStatic, setChgSupport, setComment, setContext, setId, setPrompt, setReferences, setStatic, setTemplate, xmlCRdString, xmlCWrString, xmlInitializerString
 
Methods inherited from class com.ibm.able.data.AbleLhs
asgnIs, asgnIs, bitwiseAND, bitwiseNOT, bitwiseOR, bitwiseShiftLeft, bitwiseShiftRight, bitwiseShiftRightZeroFill, bitwiseXOR, compModulo, Copyright, logicalAND, logicalNOT, logicalOR
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

myValue

protected java.lang.String myValue
The current value of the variable.

Initialized to AbleData.StringNull.


myValueList

protected java.util.Vector myValueList
The list of possible values that this variable can assume.

myInitialValue

protected java.lang.String myInitialValue
The initial String value used to reset this variable
Constructor Detail

AbleCategoricalVariable

public AbleCategoricalVariable(java.lang.Object[] theValueList)
                        throws AbleDataException
Create a AbleCategoricalVariable, used to initialize another categorical variable, over the specified categories.

The initial value of this variable is set to AbleData.StringNull.

Parameters:
theValueList - A list of categories (AbleStringLiteral objects), any one of which can be the current value of this variable.


AbleCategoricalVariable

public AbleCategoricalVariable(java.util.Vector theValueList)
                        throws AbleDataException
Create a new AbleCategoricalVariable, used to initialize another categorical variable, over the specified categories.

The initial value of this variable is set to AbleData.StringNull.

Parameters:
theValueList - A list of categories (String objects), any one of which can be the current value of this variable. The list is cloned.


AbleCategoricalVariable

public AbleCategoricalVariable(java.lang.Object[] theValueList,
                               java.lang.String theInitialValue)
                        throws AbleDataException
Create a new AbleCategoricalVariable, used to initialize another categorical variable, over the specified categories with the specified initial value. Note: If the initial value is not AbleData.StringNull this variable cannot be used as a goal variable for backchaining.
Parameters:
theValueList - A list of categories (AbleStringLiteral objects), any one of which can be the current value of this variable.

theInitialValue - The value which must be one of the values in theValueList

AbleCategoricalVariable

public AbleCategoricalVariable(java.util.Vector theValueList,
                               java.lang.String theInitialValue)
                        throws AbleDataException
Create a new AbleCategoricalVariable, used to initialize another categorical variable, over the specified categories with the specified initial value. Note: If the initial value is not AbleData.StringNull this variable cannot be used as a goal variable for backchaining.
Parameters:
theValueList - A list of categories (String objects), any one of which can be the current value of this variable. The list is cloned.

theInitialValue - The value which must be one of the values in theValueList

AbleCategoricalVariable

public AbleCategoricalVariable(java.lang.String theName,
                               java.util.Vector theValueList)
Create a new AbleCategoricalVariable over the specified categories.

The initial value of this variable cannot be specified and is set to AbleData.StringNull.

Parameters:
theName - The unique name of the variable.

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


AbleCategoricalVariable

public AbleCategoricalVariable(java.lang.String theName,
                               boolean theStaticFlag,
                               boolean theGlobalFlag,
                               java.util.Vector theValueList)
Create a new AbleCategoricalVariable over the specified categories.

The initial value of this variable cannot be specified and is set to AbleData.StringNull.

Parameters:
theName - The unique name of the variable.

theStaticFlag - Use true if this variable is to be marked as static, which means that it will ignore future reset requests; use false if the variable can be reset to its initial value when requested.

theGlobalFlag - Use true if this variable is to be considered global; use false if the variable is to be considered local.

theValueList - A list of categories (String 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.
Overrides:
getBooleanValue in class AbleGenericVariable
Returns:
A boolean, if the value of this object can be represented as a boolean value. If the current value is "true" true is returned; if the current value is "false" false is returned; any other current value throws an exception.
Throws:
AbleDataException - If the value of this object cannot be represented as a boolean value.

getFuzzyValue

public AbleFuzzySet getFuzzyValue()
                           throws AbleDataException
Retrieve the value of this data object as a fuzzy value.
Overrides:
getFuzzyValue in class AbleGenericVariable
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.

getGenericValue

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

getNumericValue

public double getNumericValue()
                       throws AbleDataException
Retrieve the value of this data object as a numeric value.
Overrides:
getNumericValue in class AbleGenericVariable
Returns:
A double, if the value of this object can be represented as a numeric value. If the current value can be parsed as a double, a double is returned; otherwise an exception is thrown.
Throws:
AbleDataException - If the value of this object cannot be represented as a numeric value.

getStringValue

public java.lang.String getStringValue()
                                throws AbleDataException
Retrieve the value of this data object as a string value.
Overrides:
getStringValue in class AbleGenericVariable
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 AbleLiteral getValue()
                     throws AbleDataException
Retrieve the value of this data object as a literal.
Overrides:
getValue in class AbleGenericVariable
Returns:
An AbleStringLiteral object.
Throws:
AbleDataException - If the value of this object cannot be represented as a literal.

asgnEq

public void asgnEq(AbleRd theRhs)
            throws AbleDataException
Assignment: assign the current value of theRhs to this data object.
Overrides:
asgnEq in class AbleGenericVariable
Parameters:
theRhs - The right-hand, or source, side of the assignment.

Throws:
AbleDataException - If the right-hand side cannot be converted (if necessary) and assigned to this data object.

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 equals() is used for String compares.

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

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

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

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.

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

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

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

compPlus

public AbleLiteral compPlus(AbleRd theRhs)
                     throws AbleDataException
Compute, concatenate the current value of this data object to the current value of theRhs.

"+" is used for String concatenation.

Overrides:
compPlus in class AbleGenericVariable
Parameters:
theRhs - The right-hand side of the comparison.

Returns:
The result of the concatenation operation.
Throws:
AbleDataException - If the right-hand side cannot be converted (if necessary) and compared to this data object.

setBooleanValue

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

Throws:
AbleDataException - If the value of this object cannot be represented as a boolean value.

setFuzzyValue

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

Throws:
AbleDataException - If the value of this object cannot be represented as a fuzzy value.

setGenericValue

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

Throws:
AbleDataException - If the value of this object cannot be derived from the specified Object.

setNumericValue

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

Throws:
AbleDataException - If the value of this object cannot be represented as a numeric value.

setStringValue

public void setStringValue(java.lang.String theNewValue)
                    throws AbleDataException
Set the value of this data object from a string value.
Overrides:
setStringValue in class AbleTypedVariable
Parameters:
theNewValue - A string. The variable is set to the value of the string, but only if the string is a pre-defined category of the variable; otherwise an exception is thrown.

Throws:
AbleDataException - If the value of this object cannot be represented as a string value.

setValue

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

arlDclString

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

xmlDclString

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

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 AbleGenericVariable

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 AbleGenericVariable

reset

public void reset()
           throws AbleDataException
Reset the variable to its initial state.
Overrides:
reset in class AbleTypedVariable

init

public void init()
          throws AbleDataException
Init the variable to its initial state.
Overrides:
init in class AbleTypedVariable

getDataTypeClass

public java.lang.Class getDataTypeClass()
Description copied from class: AbleLhs
Retrieve the actual class of this object's underlying data type.
Overrides:
getDataTypeClass in class AbleTypedVariable
Following copied from class: com.ibm.able.data.AbleLhs
Returns:
The class of the underlying data type.

getDataTypeClassName

public java.lang.String getDataTypeClassName()
Description copied from class: AbleLhs
Retrieve the name of the class of this object's underlying data type.
Overrides:
getDataTypeClassName in class AbleTypedVariable
Following copied from class: com.ibm.able.data.AbleLhs
Returns:
A String that is the name of the class of the underlying data type.

getLiteralClass

public java.lang.Class getLiteralClass()
Retrieve the class of this variable's related AbleLiteral data type.
Overrides:
getLiteralClass in class AbleGenericVariable
Returns:
The class of the literal data type.

setInitialValue

public void setInitialValue(AbleRd theInitialValue)
                     throws AbleDataException
Set the initial value for this variable
Overrides:
setInitialValue in class AbleVariable
Parameters:
theInitialValue - An AbleCategoricalVariable used to set the initial value

getRawValue

public java.lang.Object getRawValue()
Retrieve the variable's current 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 AbleData.StringNull.

Parameters:
theNewValueList - A list where each element is a String 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(java.lang.String 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(java.lang.String 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(java.lang.String 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 AbleData.StringNull.

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(java.lang.String 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 java.lang.String 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.

toString

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

traceString

public java.lang.String traceString(int theTraceStringFlavor)
Retrieve a string describing (the contents of) the object.
Overrides:
traceString in class AbleTypedVariable
Parameters:
theFlavor - An Able.TraceStringFlavor value.

Returns:
A String containing the current contents of the object.

ABLE 2.0.0 07/02/2003 10:25:01

(C) Copyright IBM Corporation 1999, 2003