com.ibm.able.beans.knn
Class AbleDecisionTree

java.lang.Object
  com.ibm.able.AbleObject
      com.ibm.able.beans.knn.AbleDecisionTree

All Implemented Interfaces:

AbleBean, AbleDataBufferManager, AbleEventListener, AbleEventListenerManager, AbleEventQueueManager, AbleEventQueueProcessor, AblePropertyChangeManager, AbleSerializable, AbleTranslateTemplateProvider, java.io.Serializable

public class AbleDecisionTree

extends AbleObject

implements AbleTranslateTemplateProvider, java.io.Serializable

See Also:

Serialized Form

Field Summary

static java.lang.String	defaultName Value assigned to name by default.
double[]	inNum The numeric input buffer.
static java.lang.String[]	MODE_NAMES Labels for the train, test and run modes for GUI use.
double[]	outNum The numeric output buffer.
static java.lang.String	PropertyDiscr
static int	PropertyDiscrId
static java.lang.String	PropertyMetric
static int	PropertyMetricId
static int	RUN Application or Run mode output is produced.
static int	TEST Test mode performance is tested (errors are computed).
static int	TRAIN Training mode training data is stored.

Fields inherited from class com.ibm.able.AbleObject

changed, chgSupport, comment, dataFlowEnabled, destBufferConnections, eventQueue, fileName, inputBuffer, listeners, logger, name, outputBuffer, parent, properties, propertyConnectionMgr, sourceBufferConnections, state, stateChgSupport, trace

Constructor Summary

AbleDecisionTree()
Default constructor.

AbleDecisionTree(java.lang.String aName)
Construct a decision tree bean with specified name.

AbleDecisionTree(java.lang.String aName, int args1, int args2)

Method Summary

void	generateTranslateTemplates(AbleFilter inFilt, AbleFilter outFilt, java.util.Vector fields) The next three methods change the default behaviour of the ABLE filters, making them appropriate for decision tree algorithm.
double	getAccuracy() Get the accuracy.
double	getCurrentActualClass() Get the current actual classes corresponding to the current test example.
double	getCurrentLearnedClass() Get the current learned classes corresponding to the current test/run example.
double[]	getCurrentTestExample() Get the current test example.
double[]	getCurrentTrainExample() Get the current training example.
double	getCurrentTrainRecord() Get the index of current training example.
int	getDecisionTreeMode() Get the current operating mode of the decision tree bean.
int	getDiscretization() Get discretization parameter.
double	getError() Get the error.
double[]	getInNum()
int	getMetric() Get metric parameter.
int	getNumAttributes() Get numAttr parameter.
int	getNumClasses() Get numClasses parameter.
long	getNumCorrectTestExamples() Get the number of correctly classified test examples.
long	getNumRecords() Get numRecords parameter.
long	getNumTestExamples() Get the number of test examples seen so far.
double[]	getOutNum()
void	init() Get ready to process - init all the bean members.
void	process() Performs the main, synchronous, standard processing function performed by this bean.
void	reset() Reset the decision tree bean.
void	resetTable()
void	setDecisionTreeMode(int mode) Set the operating mode of the decision tree bean.
void	setDecisionTreeParameters(int newAttr, int newCl, long newRec) Set the number records, number attributes and number classes for decision tree bean.
protected void	setDefaults() Set up the event queue behavior.
void	setDiscretization(int newDiscr) Set the discretization parameter.
void	setMetric(int newMetric) Set the metric parameter.

Methods inherited from class com.ibm.able.AbleObject

addAbleEventListener, addDestBufferConnection, addPropertyChangeListener, addPropertyConnection, addSourceBufferConnection, addStateChangeListener, dataChanged, firePropertyChange, flushAbleEventQueue, getAbleEventListeners, getAbleEventProcessingEnabled, getAbleEventQueueSize, getComment, getDestBufferConnections, getFileName, getInputBuffer, getInputBuffer, getInputBufferAsString, getInputBufferAsStringArray, getInputBufferContents, getLogger, getName, getOutputBuffer, getOutputBuffer, getOutputBufferAsString, getOutputBufferAsStringArray, getOutputBufferContents, getParent, getProperties, getProperty, getPropertyChangeListeners, getPropertyConnectionManager, getSleepTime, getSourceBufferConnections, getState, getTraceLogger, handleAbleEvent, hasInputBuffer, hasOutputBuffer, init, isAbleEventPostingEnabled, isAbleEventProcessingEnabled, isChanged, isConnectable, isDataFlowEnabled, isTimerEventProcessingEnabled, notifyAbleEventListeners, process, processAbleEvent, processBufferConnections, processNoEventProcessingEnabledSituation, processTimerEvent, quitAll, quitEnabledEventProcessing, removeAbleEventListener, removeAllAbleEventListeners, removeAllBufferConnections, removeAllConnections, removeAllPropertyConnections, removeDestBufferConnection, removeProperty, removePropertyChangeListener, removePropertyConnection, removeSourceBufferConnection, removeStateChangeListener, restartEnabledEventProcessing, restoreFromFile, restoreFromFile, restoreFromSerializedFile, restoreFromStream, resumeAll, resumeEnabledEventProcessing, saveToFile, saveToFile, setAbleEventProcessingEnabled, setChanged, setComment, setDataFlowEnabled, setFileName, setInputBuffer, setInputBuffer, setLogger, setName, setOutputBuffer, setOutputBuffer, setParent, setProperties, setProperty, setSleepTime, setState, setTimerEventProcessingEnabled, setTraceLogger, sourceConnectionsOK, startEnabledEventProcessing, suspendAll, suspendEnabledEventProcessing

Methods inherited from class java.lang.Object

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

Field Detail

defaultName

public static final java.lang.String defaultName

Value assigned to name by default.

PropertyMetricId

public static final int PropertyMetricId

See Also:

Constant Field Values

PropertyMetric

public static final java.lang.String PropertyMetric

See Also:

Constant Field Values

PropertyDiscrId

public static final int PropertyDiscrId

See Also:

Constant Field Values

PropertyDiscr

public static final java.lang.String PropertyDiscr

See Also:

Constant Field Values

inNum

public double[] inNum

The numeric input buffer.

outNum

public double[] outNum

The numeric output buffer.

TRAIN

public static final int TRAIN

Training mode training data is stored.

See Also:

Constant Field Values

TEST

public static final int TEST

Test mode performance is tested (errors are computed).

See Also:

Constant Field Values

RUN

public static final int RUN

Application or Run mode output is produced.

See Also:

Constant Field Values

MODE_NAMES

public static final java.lang.String[] MODE_NAMES

Labels for the train, test and run modes for GUI use.

Constructor Detail

AbleDecisionTree

public AbleDecisionTree()
                 throws AbleException

Default constructor.

AbleDecisionTree

public AbleDecisionTree(java.lang.String aName)
                 throws AbleException

Construct a decision tree bean with specified name.

Parameters:

aName - The object name

AbleDecisionTree

public AbleDecisionTree(java.lang.String aName,
                        int args1,
                        int args2)
                 throws AbleException

Method Detail

getInNum

public double[] getInNum()

getOutNum

public double[] getOutNum()

setDefaults

protected void setDefaults()
                    throws AbleException

Set up the event queue behavior. No timer processing and no asynch event processing.

Throws:

AbleException

getDecisionTreeMode

public int getDecisionTreeMode()

Get the current operating mode of the decision tree bean.

Returns:

int.

setDecisionTreeMode

public void setDecisionTreeMode(int mode)

Set the operating mode of the decision tree bean.

Parameters:

mode - The current operating mode, train/test/run.

Returns:

void.

setDecisionTreeParameters

public void setDecisionTreeParameters(int newAttr,
                                      int newCl,
                                      long newRec)

Set the number records, number attributes and number classes for decision tree bean.

Parameters:

newAttr - that defines the number of attributes.

newCl - that defines the number of classes.

newRec - that defines the number of records.

setMetric

public void setMetric(int newMetric)
               throws AbleException

Set the metric parameter.

Throws:

AbleException

getMetric

public int getMetric()

Get metric parameter.

setDiscretization

public void setDiscretization(int newDiscr)
                       throws AbleException

Set the discretization parameter.

Throws:

AbleException

getDiscretization

public int getDiscretization()

Get discretization parameter.

getNumRecords

public long getNumRecords()

Get numRecords parameter.

getNumAttributes

public int getNumAttributes()

Get numAttr parameter.

getNumClasses

public int getNumClasses()

Get numClasses parameter.

getNumTestExamples

public long getNumTestExamples()

Get the number of test examples seen so far.

getNumCorrectTestExamples

public long getNumCorrectTestExamples()

Get the number of correctly classified test examples.

getAccuracy

public double getAccuracy()

Get the accuracy.

getError

public double getError()

Get the error.

getCurrentTrainExample

public double[] getCurrentTrainExample()

Get the current training example.

getCurrentTestExample

public double[] getCurrentTestExample()

Get the current test example.

getCurrentLearnedClass

public double getCurrentLearnedClass()

Get the current learned classes corresponding to the current test/run example.

getCurrentActualClass

public double getCurrentActualClass()

Get the current actual classes corresponding to the current test example.

getCurrentTrainRecord

public double getCurrentTrainRecord()

Get the index of current training example.

init

public void init()
          throws AbleException

Get ready to process - init all the bean members.

Specified by:

init in interface AbleBean

Overrides:

init in class AbleObject

Throws:

AbleException - If an error occurs.

See Also:

AbleObject.startEnabledEventProcessing()

reset

public void reset()
           throws AbleException

Reset the decision tree bean.

Specified by:

reset in interface AbleBean

Overrides:

reset in class AbleObject

Throws:

AbleException - If an error occurs.

See Also:

AbleBean.reset()

resetTable

public void resetTable()
                throws AbleException

Throws:

AbleException

process

public void process()
             throws AbleException

Description copied from class: AbleObject

Performs the main, synchronous, standard processing function performed by this bean.

This base method implementation provides tracing only.

Specified by:

process in interface AbleBean

Overrides:

process in class AbleObject

Throws:

AbleException

See Also:

AbleObject.inputBuffer, AbleObject.outputBuffer, AbleBean.process()

generateTranslateTemplates

public void generateTranslateTemplates(AbleFilter inFilt,
                                       AbleFilter outFilt,
                                       java.util.Vector fields)
                                throws AbleException

The next three methods change the default behaviour of the ABLE filters, making them appropriate for decision tree algorithm. Thus, for discrete and categorical attributes, the possible values are converted to consecutive numbers starting from 1 till the number of values. For continuous attributes, the values are discretized, so that they take values from 1 to the number of intervals used for discretization. The class attribute is always discrete or categorical.

Specified by:

generateTranslateTemplates in interface AbleTranslateTemplateProvider

Parameters:

inFilt - The AbleFilter used to convert incoming data.

outFilt - The AbleFilter used to convert outgoing data.

fields - A vector of AbleFields from which to derive the translation template.

Returns:

An array containing two AbleFilter objectshe translation template.

Throws:

AbleException