ABLE, Version 1.1b

com.ibm.able.data
Class AbleData

java.lang.Object
  |
  +--com.ibm.able.data.AbleData

public class AbleData
extends java.lang.Object
implements java.io.Serializable

This class contains constants for the IBM Agent Building and Learning Environment (ABLE) Data package.

Version:
$Revision: 1.10 $, $Date: 2000/09/11 19:38:35 $
See Also:
Serialized Form

Field Summary
static int AsgnEq
          Operator; Assignment (=).
static int AsgnIs
          Operator; Fuzzy assignment (Is).
static int BooleanLiteral
          Data type; the data object represents a boolean literal.
static int BooleanVariable
          Data type; the data object represents a boolean variable.
static int CallLiteral
          Data type; the data object represents an object that can be called, such as a sensor or effector; this is a type of literal.
static int CategoricalVariable
          Data type; the data object represents a categorical variable.
static int CmpEq
          Operator; Compare equal to (=).
static int CmpGt
          Operator; Compare greater than (>).
static int CmpGtEq
          Operator; Compare greater than or equal to (>=).
static int CmpIs
          Operator; Compare fuzzy equal to (Is).
static int CmpLt
          Operator; Compare less than (<).
static int CmpLtEq
          Operator; Compare less than or equal to (<=).
static int CmpNeq
          Operator; Compare not equal to (!= or <>).
static java.text.Collator Collator
          A collator for comparing string data types.
static int ContinuousVariable
          Data type; the data object represents a continuous variable.
static int DataTypeUnknown
          Data type; the data object represents an unknown data type.
static int DiscreteVariable
          Data type; the data object represents a discrete variable.
static AbleBooleanLiteral False
          A convenience boolean literal with a value of false.
static int FuzzySet
          Data type; the data object represents a fuzzy set.
static int GenericLiteral
          Data type; the data object represents a generic literal; that is, one whose current value is an Object.
static int GenericVariable
          Data type; the data object represents a generic variable.
static int IgnoreUsage
          Field Usage type; the field is to be ignored
static int InputUsage
          Field Usage type; the field is used as an input field.
static int NumericLiteral
          Data type; the data object represents a numeric literal.
static int NumericVariable
          Data type; the data object represents a numeric variable.
static int OperatorUnknown
          Operator; an unknown operator.
static int OutputUsage
          Field Usage type; the field is used as an output or target field.
static java.lang.String Pr_BooleanValue
           
static int Pr_BooleanValueId
          Property; Current value of a boolean variable.
static java.lang.String Pr_CategoricalStringList
           
static int Pr_CategoricalStringListId
          Property; Categorical variable's list of categories.
static java.lang.String Pr_CategoricalValue
           
static int Pr_CategoricalValueId
          Property; Current value of a categorical variable.
static java.lang.String Pr_ContinuousValue
           
static int Pr_ContinuousValueId
          Property; Current value of a continuous variable.
static java.lang.String Pr_DiscreteNumberList
           
static int Pr_DiscreteNumberListId
          Property; Discrete variable's list of discrete numbers.
static java.lang.String Pr_DiscreteValue
           
static int Pr_DiscreteValueId
          Property; Current value of a discrete variable.
static java.lang.String Pr_GenericValue
           
static int Pr_GenericValueId
          Property; Current value of a generic variable.
static java.lang.String Pr_NumericValue
           
static int Pr_NumericValueId
          Property; Current value of a numeric variable.
static java.lang.String Pr_StringValue
           
static int Pr_StringValueId
          Property; Current value of a string variable.
static java.lang.String Pr_Unrecognised
           
static int Pr_UnrecognisedId
          Property; Property ID or name unknown.
static int StringLiteral
          Data type; the data object represents a string literal.
static java.lang.String StringNull
          The initial value of a string variable unless explicitly initialized to a particular value.
static int StringVariable
          Data type; the data object represents a string variable.
static AbleBooleanLiteral True
          A convenience boolean literal with a value of true.
static int ValueTypeBoolean
          Value type; the data string represents a boolean value, either "true" or "false".
static int ValueTypeCallName
          Value type; the data string represents the name of a sensor or an effector.
static int ValueTypeName
          Value type; the data string represents the name of a variable.
static int ValueTypeNumber
          Value type; the data string represents a literal number.
static int ValueTypeSetName
          Value type; the data string represents the name of a fuzzy set.
static int ValueTypeUnknown
          Value type; the data string represents a unknown value.
static int VarIdInitial
          The ID of the first created variable.
static int VarIdNull
          A "null" variable ID.
 
Method Summary
static java.lang.String Copyright()
          Determine the copyright of this class.
static java.lang.String DataType(int theDataType)
          Given an AbleData.<DataType> constant, convert the value to a human-readable string; the use of this method is primarily for debugging.
static int DataType(java.lang.String theDataType)
          Given a string describing an Able data type, convert the string to an AbleData.<DataType> constant.
static java.lang.String DataTypeDebug(int theDataType)
          Given an AbleData.<DataType> constant, convert the value to a human-readable string; the use of this method is primarily for debugging.
static java.lang.String Operator(int theOperator)
          Given an AbleData.<Operator> constant, convert the value to a human-readable string; the use of this method is primarily for debugging.
static java.lang.String OperatorRl(int theOperator)
          Given an AbleData.<Operator> constant, convert the value to a form suitable for inclusion in a formal Able rule language clause.
static java.lang.String OperatorXml(int theOperator)
          Given an AbleData.<Operator> constant, convert the value to a form suitable for inclusion in a formal Able XML clause.
static java.lang.String Property(int thePropertyId)
          Given a property ID, return a property name in debug form.
static int PropertyId(java.lang.String thePropertyName)
          Given a property name, such as the value for Pr_BooleanValue, return that property's integer ID.
static java.lang.String PropertyName(int thePropertyId)
          Given a property ID, return a property name.
static int UsageType(java.lang.String theUsageType)
          Given a string describing an Able field usage type, convert the string to an AbleData.<UsageType> constant.
static java.lang.String UsageTypeString(int theUsageType)
          Given an AbleData.<UsageType> constant, convert the value to a human-readable string;
static java.lang.String ValueType(int theValueType)
          Given an AbleData.<ValueType> constant, convert the value to a human-readable string; the use of this method is primarily for debugging.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DataTypeUnknown

public static final int DataTypeUnknown
Data type; the data object represents an unknown data type. Data objects created with a zero-argument constructor are given this data type until the data object is initialized.

BooleanLiteral

public static final int BooleanLiteral
Data type; the data object represents a boolean literal.

CallLiteral

public static final int CallLiteral
Data type; the data object represents an object that can be called, such as a sensor or effector; this is a type of literal.

GenericLiteral

public static final int GenericLiteral
Data type; the data object represents a generic literal; that is, one whose current value is an Object.

NumericLiteral

public static final int NumericLiteral
Data type; the data object represents a numeric literal.

StringLiteral

public static final int StringLiteral
Data type; the data object represents a string literal.

FuzzySet

public static final int FuzzySet
Data type; the data object represents a fuzzy set.

BooleanVariable

public static final int BooleanVariable
Data type; the data object represents a boolean variable.

CategoricalVariable

public static final int CategoricalVariable
Data type; the data object represents a categorical variable.

ContinuousVariable

public static final int ContinuousVariable
Data type; the data object represents a continuous variable.

DiscreteVariable

public static final int DiscreteVariable
Data type; the data object represents a discrete variable.

GenericVariable

public static final int GenericVariable
Data type; the data object represents a generic variable.

NumericVariable

public static final int NumericVariable
Data type; the data object represents a numeric variable.

StringVariable

public static final int StringVariable
Data type; the data object represents a string variable.

OperatorUnknown

public static final int OperatorUnknown
Operator; an unknown operator.

AsgnEq

public static final int AsgnEq
Operator; Assignment (=).

AsgnIs

public static final int AsgnIs
Operator; Fuzzy assignment (Is).

CmpEq

public static final int CmpEq
Operator; Compare equal to (=).

CmpGt

public static final int CmpGt
Operator; Compare greater than (>).

CmpGtEq

public static final int CmpGtEq
Operator; Compare greater than or equal to (>=).

CmpIs

public static final int CmpIs
Operator; Compare fuzzy equal to (Is).

CmpLt

public static final int CmpLt
Operator; Compare less than (<).

CmpLtEq

public static final int CmpLtEq
Operator; Compare less than or equal to (<=).

CmpNeq

public static final int CmpNeq
Operator; Compare not equal to (!= or <>).

InputUsage

public static final int InputUsage
Field Usage type; the field is used as an input field.

OutputUsage

public static final int OutputUsage
Field Usage type; the field is used as an output or target field.

IgnoreUsage

public static final int IgnoreUsage
Field Usage type; the field is to be ignored

ValueTypeUnknown

public static final int ValueTypeUnknown
Value type; the data string represents a unknown value.

ValueTypeBoolean

public static final int ValueTypeBoolean
Value type; the data string represents a boolean value, either "true" or "false".

ValueTypeName

public static final int ValueTypeName
Value type; the data string represents the name of a variable.

ValueTypeNumber

public static final int ValueTypeNumber
Value type; the data string represents a literal number.

ValueTypeSetName

public static final int ValueTypeSetName
Value type; the data string represents the name of a fuzzy set.

ValueTypeCallName

public static final int ValueTypeCallName
Value type; the data string represents the name of a sensor or an effector.

Pr_BooleanValueId

public static final int Pr_BooleanValueId
Property; Current value of a boolean variable.

Pr_BooleanValue

public static final java.lang.String Pr_BooleanValue

Pr_CategoricalValueId

public static final int Pr_CategoricalValueId
Property; Current value of a categorical variable.

Pr_CategoricalValue

public static final java.lang.String Pr_CategoricalValue

Pr_CategoricalStringListId

public static final int Pr_CategoricalStringListId
Property; Categorical variable's list of categories.

Pr_CategoricalStringList

public static final java.lang.String Pr_CategoricalStringList

Pr_ContinuousValueId

public static final int Pr_ContinuousValueId
Property; Current value of a continuous variable.

Pr_ContinuousValue

public static final java.lang.String Pr_ContinuousValue

Pr_DiscreteValueId

public static final int Pr_DiscreteValueId
Property; Current value of a discrete variable.

Pr_DiscreteValue

public static final java.lang.String Pr_DiscreteValue

Pr_DiscreteNumberListId

public static final int Pr_DiscreteNumberListId
Property; Discrete variable's list of discrete numbers.

Pr_DiscreteNumberList

public static final java.lang.String Pr_DiscreteNumberList

Pr_GenericValueId

public static final int Pr_GenericValueId
Property; Current value of a generic variable.

Pr_GenericValue

public static final java.lang.String Pr_GenericValue

Pr_NumericValueId

public static final int Pr_NumericValueId
Property; Current value of a numeric variable.

Pr_NumericValue

public static final java.lang.String Pr_NumericValue

Pr_StringValueId

public static final int Pr_StringValueId
Property; Current value of a string variable.

Pr_StringValue

public static final java.lang.String Pr_StringValue

Pr_UnrecognisedId

public static final int Pr_UnrecognisedId
Property; Property ID or name unknown.

Pr_Unrecognised

public static final java.lang.String Pr_Unrecognised

StringNull

public static final java.lang.String StringNull
The initial value of a string variable unless explicitly initialized to a particular value.

VarIdInitial

public static final int VarIdInitial
The ID of the first created variable.

VarIdNull

public static final int VarIdNull
A "null" variable ID.

True

public static final AbleBooleanLiteral True
A convenience boolean literal with a value of true.

False

public static final AbleBooleanLiteral False
A convenience boolean literal with a value of false.

Collator

public static final java.text.Collator Collator
A collator for comparing string data types.
Method Detail

DataType

public static final java.lang.String DataType(int theDataType)
Given an AbleData.<DataType> constant, convert the value to a human-readable string; the use of this method is primarily for debugging.
Parameters:
theDataType - An AbleData.<DataType> constant.

Returns:
A string of the form "n:AbleData.constantName" where "n" is the input constant and "constantName" is a description of "n".

DataType

public static final int DataType(java.lang.String theDataType)
Given a string describing an Able data type, convert the string to an AbleData.<DataType> constant. For example, when given ".AbleData.BooleanVariable", return 11. This works for all known Able data types. For variables only, a shorthand input may also be used; for example, "boolean", "categorical", "continuous", and so on.
Parameters:
theDataType - A string describing an Able data type.

Returns:
An AbleData.<DataType> constant.

DataTypeDebug

public static final java.lang.String DataTypeDebug(int theDataType)
Given an AbleData.<DataType> constant, convert the value to a human-readable string; the use of this method is primarily for debugging.
Parameters:
theDataType - An AbleData.<DataType> constant.

Returns:
A string of the form "n:AbleData.constantName" where "n" is the input constant and "constantName" is a description of "n".

UsageTypeString

public static final java.lang.String UsageTypeString(int theUsageType)
Given an AbleData.<UsageType> constant, convert the value to a human-readable string;
Parameters:
theUsageType - An AbleData.<UsageType> constant.

Returns:
A string of the form "Input", "Output", "Ignore", or "Unknown" if the specified usage type does not match any defined usage type.

UsageType

public static final int UsageType(java.lang.String theUsageType)
Given a string describing an Able field usage type, convert the string to an AbleData.<UsageType> constant. For example, when given ".Input", return 0.
Parameters:
theUsageType - A string describing an Able field usage type.

Returns:
An AbleData.<UsageType> constant, or -1 if the string doesn't match any defined usage type.

Operator

public static java.lang.String Operator(int theOperator)
Given an AbleData.<Operator> constant, convert the value to a human-readable string; the use of this method is primarily for debugging.
Parameters:
theOperator - An AbleData.<Operator> constant.

Returns:
A string of the form "n:AbleData.constantName" where "n" is the input constant and "constantName" is a description of "n".

OperatorRl

public static java.lang.String OperatorRl(int theOperator)
Given an AbleData.<Operator> constant, convert the value to a form suitable for inclusion in a formal Able rule language clause.
Parameters:
theOperator - An AbleData.<Operator> constant.

Returns:
A string that is the rule language form of the operator; for example, given CmpGt, ">" is returned.

OperatorXml

public static java.lang.String OperatorXml(int theOperator)
Given an AbleData.<Operator> constant, convert the value to a form suitable for inclusion in a formal Able XML clause.
Parameters:
theOperator - An AbleData.<Operator> constant.

Returns:
A string that is the rule language form of the operator; for example, given CmpGt, "isGreaterThan" is returned.

ValueType

public static final java.lang.String ValueType(int theValueType)
Given an AbleData.<ValueType> constant, convert the value to a human-readable string; the use of this method is primarily for debugging.
Parameters:
theValueType - An AbleData.<ValueType> constant.

Returns:
A string of the form "n:AbleData.constantName" where "n" is the input constant and "constantName" is a description of "n".

PropertyId

public static final int PropertyId(java.lang.String thePropertyName)
Given a property name, such as the value for Pr_BooleanValue, return that property's integer ID.
Parameters:
thePropertyName - An AbleData.Pr_<propertyName> constant.

Returns:
An integer index of the named property, which can be used in a listener's SWITCH statement.

PropertyName

public static final java.lang.String PropertyName(int thePropertyId)
Given a property ID, return a property name.
Parameters:
thePropertyId - An AbleData.Pr_<propertyName>Id constant.

Returns:
A string containing the actual property name or "Unrecognised" if the ID is unknown.

Property

public static final java.lang.String Property(int thePropertyId)
Given a property ID, return a property name in debug form.
Parameters:
thePropertyId - An AbleData.Pr_<propertyName>Id constant.

Returns:
A string of the form "n:AbleData.<name>" where "n" is the given ID, and "<name>" is the property name associated with the ID, or "Unrecognised" if the ID is unknown.

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