weka.core.pmml

Class Discretize

java.lang.Object

weka.core.pmml.Expression

weka.core.pmml.Discretize

All Implemented Interfaces:

Serializable

public class Discretize
extends Expression

Class encapsulating a Discretize Expression.

Version:

$Revision 1.0 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Discretize.DiscretizeBin Inner class to encapsulate DiscretizeBin elements

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<Discretize.DiscretizeBin>	m_bins The bins for this discretization
protected String	m_defaultValue The default value (if defined)
protected boolean	m_defaultValueDefined True if a default value has been specified
protected int	m_fieldIndex The index of the field
protected String	m_fieldName The name of the field to be discretized
protected boolean	m_mapMissingDefined True if a replacement for missing values has been specified
protected String	m_mapMissingTo The value of the missing value replacement (if defined)
protected Attribute	m_outputDef The output structure of this discretization

Fields inherited from class weka.core.pmml.Expression

m_fieldDefs, m_opType

Constructor Summary

Constructors

Constructor and Description
Discretize(Element discretize, FieldMetaInfo.Optype opType, ArrayList<Attribute> fieldDefs) Constructs a Discretize Expression

Method Summary

Modifier and Type	Method and Description
protected Attribute	getOutputDef() Return the structure of the result of applying this Expression as an Attribute.
double	getResult(double[] incoming) Get the result of evaluating the expression.
String	getResultCategorical(double[] incoming) Gets the result of evaluating the expression when the optype is categorical or ordinal as the actual String value.
void	setFieldDefs(ArrayList<Attribute> fieldDefs) Set the field definitions for this Expression to use
String	toString(String pad)

Methods inherited from class weka.core.pmml.Expression

getExpression, getExpression, getFieldDef, getFieldDefIndex, getOptype, getResultContinuous, toString

Methods inherited from class java.lang.Object

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

Field Detail

m_fieldName

protected String m_fieldName

The name of the field to be discretized

m_fieldIndex

protected int m_fieldIndex

The index of the field

m_mapMissingDefined

protected boolean m_mapMissingDefined

True if a replacement for missing values has been specified

m_mapMissingTo

protected String m_mapMissingTo

The value of the missing value replacement (if defined)

m_defaultValueDefined

protected boolean m_defaultValueDefined

True if a default value has been specified

m_defaultValue

protected String m_defaultValue

The default value (if defined)

m_bins

protected ArrayList<Discretize.DiscretizeBin> m_bins

The bins for this discretization

m_outputDef

protected Attribute m_outputDef

The output structure of this discretization

Constructor Detail

Discretize

public Discretize(Element discretize,
                  FieldMetaInfo.Optype opType,
                  ArrayList<Attribute> fieldDefs)
           throws Exception

Constructs a Discretize Expression

Parameters:

discretize - the Element containing the discretize expression

opType - the optype of this Discretize Expression

fieldDefs - the structure of the incoming fields

Throws:

Exception - if the optype is not categorical/ordinal or if there is a problem parsing this element

Method Detail

setFieldDefs

public void setFieldDefs(ArrayList<Attribute> fieldDefs)
                  throws Exception

Set the field definitions for this Expression to use

Overrides:

setFieldDefs in class Expression

Parameters:

fieldDefs - the field definitions to use

Throws:

Exception - if there is a problem setting the field definitions

getOutputDef

protected Attribute getOutputDef()

Return the structure of the result of applying this Expression as an Attribute.

Specified by:

getOutputDef in class Expression

Returns:

the structure of the result of applying this Expression as an Attribute.

getResult

public double getResult(double[] incoming)
                 throws Exception

Get the result of evaluating the expression. In the case of a continuous optype, a real number is returned; in the case of a categorical/ordinal optype, the index of the nominal value is returned as a double.

Specified by:

getResult in class Expression

Parameters:

incoming - the incoming parameter values

Returns:

the result of evaluating the expression

Throws:

Exception - if there is a problem computing the result

getResultCategorical

public String getResultCategorical(double[] incoming)
                            throws Exception

Gets the result of evaluating the expression when the optype is categorical or ordinal as the actual String value.

Specified by:

getResultCategorical in class Expression

Parameters:

incoming - the incoming parameter values

Returns:

the result of evaluating the expression

Throws:

Exception - if the optype is continuous

toString

public String toString(String pad)

Overrides:

toString in class Expression