com.ibm.able.data
Class AbleContinuousField

java.lang.Object
  com.ibm.able.data.AbleLhs
      com.ibm.able.data.AbleVariable
          com.ibm.able.data.AbleContinuousVariable
              com.ibm.able.data.AbleContinuousField

All Implemented Interfaces:

AbleField, AbleRd, AbleWr, java.io.Serializable

public class AbleContinuousField

extends AbleContinuousVariable

implements AbleField

Continuous fields are numeric fields with an infinite set of possible values.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.able.data.AbleContinuousVariable

myDiscourseHi, myDiscourseLo, myInitialValue, myValue

Fields inherited from class com.ibm.able.data.AbleVariable

myBoundFlag, myChgSupport, myComment, myContext, myDataType, myGlobalFlag, myId, myName, myPrompt, myReferences, myStaticFlag, myTemplateFlag, myValueInitial

Constructor Summary

AbleContinuousField(AbleFieldDefinition def)
Construct a Continuous field.

AbleContinuousField(java.lang.String name, int usageType, int column)
Construct a Continuous field.

Method Summary

void	computeStatistics(java.lang.Object inValue) Add another value to the field.
int	getColumn() Get the column index position of this field in a record.
java.lang.String	getDataTypeString() Get the data type of this field as a string - "continuous" for example.
AbleTranslateTemplate	getInputTranslateTemplate() Provide an input translate template for this field.
java.util.Map	getMap() Get the Map of all unique values that are possible for this field.
double	getMax() Return the maximum value computed for this field.
double	getMean() Return the mean value computed for this field.
double	getMin() Return the minimum value computed for this field.
int	getNormalizedSize() Return the expanded size, continuous fields always take 1 unit.
double	getNumericValue(java.lang.Object inValue) Return the numeric value for the String provided.
AbleTranslateTemplate	getOutputTranslateTemplate() Provide an output translate template for this field.
int	getUsage() Get the usage type of this field - "input" for example.
java.lang.String	getUsageString() Get the usage type of this field as a string - "input" for example.
void	setColumn(int col) Set the index position in the record, based on field definition order.
void	setMax(double Max) Set the maximum value for this field.
void	setMin(double Min) Set the minimum value for this field.
void	setUsage(java.lang.String usage) Set the usage type of this from a string - "input" for example.

Methods inherited from class com.ibm.able.data.AbleContinuousVariable

arlDclString, armlDclString, asgnEq, chkRange, cmpEq, cmpGt, cmpGtEq, cmpLt, cmpLtEq, cmpNeq, compDivide, compMinus, compMultiply, compPlus, compUnaryMinus, createInitializer, createInitializer, getBooleanValue, getDataTypeClass, getDataTypeClassName, getDataTypeName, getDiscourseHi, getDiscourseLo, getFuzzyValue, getGenericValue, getLiteralClass, getNumericValue, getStringValue, getValue, getValueString, init, reset, setBooleanValue, setDiscourseHi, setDiscourseLo, setFuzzyValue, setGenericValue, setInitialValue, setNumericValue, setStringValue, setValue, setValueString, toString, traceString, withinUniverseOfDiscourse, xmlDclString

Methods inherited from class com.ibm.able.data.AbleVariable

arlCRdString, arlInitializerString, armlCRdString, armlInitializerString, 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, cmpIs, compModulo, logicalAND, logicalNOT, logicalOR

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.able.data.AbleField

getName, getStringValue

Constructor Detail

AbleContinuousField

public AbleContinuousField(AbleFieldDefinition def)

Construct a Continuous field. Must call setColumn to set the position in the record.

Parameters:

def - An AbleFieldDefinition which provides the name and usage for this field.

AbleContinuousField

public AbleContinuousField(java.lang.String name,
                           int usageType,
                           int column)

Construct a Continuous field.

Parameters:

name - The field name.

usageType - The usage type, one of AbleData.InputUsage, AbleData.OutputUsage, or AbleData.IgnoreUsage.

column - The position in the record, 0 if to be set later.

Method Detail

setMin

public void setMin(double Min)

Set the minimum value for this field.

setMax

public void setMax(double Max)

Set the maximum value for this field.

getMin

public double getMin()

Return the minimum value computed for this field.

getMax

public double getMax()

Return the maximum value computed for this field.

getMean

public double getMean()

Return the mean value computed for this field.

computeStatistics

public void computeStatistics(java.lang.Object inValue)

Add another value to the field. This is used to maintain the field minimum, maximum, and mean values.

Specified by:

computeStatistics in interface AbleField

getNumericValue

public double getNumericValue(java.lang.Object inValue)

Return the numeric value for the String provided.

Specified by:

getNumericValue in interface AbleField

getInputTranslateTemplate

public AbleTranslateTemplate getInputTranslateTemplate()

Provide an input translate template for this field.

if the field usage is input, scale from 0.0 to 1.0 using the mean as the midpoint of the scale.

if the field usage is output, scale from 0.1 to 0.9 using the mean as the midpoint of the scale.

if the field usage is ignore, then ignore it.

Specified by:

getInputTranslateTemplate in interface AbleField

Returns:

the fully configured AbleTranslateTemplate.

getOutputTranslateTemplate

public AbleTranslateTemplate getOutputTranslateTemplate()

Provide an output translate template for this field.

Specified by:

getOutputTranslateTemplate in interface AbleField

Returns:

the fully configured AbleTranslateTemplate if usage is output, and null otherwise.

getNormalizedSize

public int getNormalizedSize()

Return the expanded size, continuous fields always take 1 unit.

Specified by:

getNormalizedSize in interface AbleField

setColumn

public void setColumn(int col)

Description copied from interface: AbleField

Set the index position in the record, based on field definition order.

Specified by:

setColumn in interface AbleField

getColumn

public int getColumn()

Description copied from interface: AbleField

Get the column index position of this field in a record.

Specified by:

getColumn in interface AbleField

getDataTypeString

public java.lang.String getDataTypeString()

Description copied from interface: AbleField

Get the data type of this field as a string - "continuous" for example. Data types are listed in AbleData.DataType(int).

Specified by:

getDataTypeString in interface AbleField

getUsageString

public java.lang.String getUsageString()

Description copied from interface: AbleField

Get the usage type of this field as a string - "input" for example. Usage types are listed in AbleData.UsageType(java.lang.String).

Specified by:

getUsageString in interface AbleField

getUsage

public int getUsage()

Description copied from interface: AbleField

Get the usage type of this field - "input" for example. Usage types are listed in AbleData.UsageType(java.lang.String).

Specified by:

getUsage in interface AbleField

setUsage

public void setUsage(java.lang.String usage)

Description copied from interface: AbleField

Set the usage type of this from a string - "input" for example. Usage types are listed in AbleData.UsageType(java.lang.String).

Specified by:

setUsage in interface AbleField

getMap

public java.util.Map getMap()

Description copied from interface: AbleField

Get the Map of all unique values that are possible for this field. The Map's key should be a string representation of an integer, and the object should be the value itself. Fields which do not have a unique number of values should return null.

Specified by:

getMap in interface AbleField