weka.core.pmml

Class MiningFieldMetaInfo

java.lang.Object

weka.core.pmml.FieldMetaInfo

weka.core.pmml.MiningFieldMetaInfo

All Implemented Interfaces:

java.io.Serializable

public class MiningFieldMetaInfo
extends FieldMetaInfo
implements java.io.Serializable

Class encapsulating information about a MiningField.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class weka.core.pmml.FieldMetaInfo

FieldMetaInfo.Interval, FieldMetaInfo.Optype, FieldMetaInfo.Value

Field Summary

Fields

Modifier and Type	Field and Description
protected double	m_highValue outlier high value
protected double	m_importance importance (if defined)
protected int	m_index the index of the field in the mining schema Instances
protected double	m_lowValue outlier low value
protected java.lang.String	m_missingValueReplacementNominal actual missing value replacements (if specified)
protected double	m_missingValueReplacementNumeric
protected weka.core.pmml.MiningFieldMetaInfo.Missing	m_missingValueTreatmentMethod missing values treatment method
protected FieldMetaInfo.Optype	m_optypeOverride optype overrides (override data dictionary type - NOT SUPPORTED AT PRESENT)
protected weka.core.pmml.MiningFieldMetaInfo.Outlier	m_outlierTreatmentMethod outlier treatmemnt method

Fields inherited from class weka.core.pmml.FieldMetaInfo

m_fieldName, m_optype

Constructor Summary

Constructors

Constructor and Description
MiningFieldMetaInfo(org.w3c.dom.Element field) Constructs a new MiningFieldMetaInfo object.

Method Summary

Modifier and Type	Method and Description
double	applyMissingValueTreatment(double value) Apply the missing value treatment method for this field.
double	applyOutlierTreatment(double value) Apply the outlier treatment method for this field.
Attribute	getFieldAsAttribute() Return this mining field as an Attribute.
weka.core.pmml.MiningFieldMetaInfo.Missing	getMissingValueTreatmentMethod() Get the missing value treatment method for this field.
java.lang.String	getName() Get the name of this field.
weka.core.pmml.MiningFieldMetaInfo.Outlier	getOutlierTreatmentMethod() Get the outlier treatment method used for this field.
weka.core.pmml.MiningFieldMetaInfo.Usage	getUsageType() Get the usage type of this field.
void	setIndex(int index) Set the index of this field in the mining schema Instances
protected void	setMiningSchemaInstances(Instances miningSchemaI) Set the Instances that represent the mining schema.
java.lang.String	toString() Return a textual representation of this MiningField.

Methods inherited from class weka.core.pmml.FieldMetaInfo

getFieldName, getOptype

Methods inherited from class java.lang.Object

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

Field Detail

m_outlierTreatmentMethod

protected weka.core.pmml.MiningFieldMetaInfo.Outlier m_outlierTreatmentMethod

outlier treatmemnt method

m_lowValue

protected double m_lowValue

outlier low value

m_highValue

protected double m_highValue

outlier high value

m_missingValueTreatmentMethod

protected weka.core.pmml.MiningFieldMetaInfo.Missing m_missingValueTreatmentMethod

missing values treatment method

m_missingValueReplacementNominal

protected java.lang.String m_missingValueReplacementNominal

actual missing value replacements (if specified)

m_missingValueReplacementNumeric

protected double m_missingValueReplacementNumeric

m_optypeOverride

protected FieldMetaInfo.Optype m_optypeOverride

optype overrides (override data dictionary type - NOT SUPPORTED AT PRESENT)

m_index

protected int m_index

the index of the field in the mining schema Instances

m_importance

protected double m_importance

importance (if defined)

Constructor Detail

MiningFieldMetaInfo

public MiningFieldMetaInfo(org.w3c.dom.Element field)
                    throws java.lang.Exception

Constructs a new MiningFieldMetaInfo object.

Parameters:

field - the Element that contains the field information

Throws:

java.lang.Exception - if there is a problem during construction

Method Detail

setMiningSchemaInstances

protected void setMiningSchemaInstances(Instances miningSchemaI)

Set the Instances that represent the mining schema. Needed so that the toString() method for this class can output attribute names and values.

Parameters:

miningSchemaI - the mining schema as an Instances object

getUsageType

public weka.core.pmml.MiningFieldMetaInfo.Usage getUsageType()

Get the usage type of this field.

Returns:

the usage type of this field

toString

public java.lang.String toString()

Return a textual representation of this MiningField.

Overrides:

toString in class java.lang.Object

Returns:

a String describing this mining field

setIndex

public void setIndex(int index)

Set the index of this field in the mining schema Instances

Parameters:

index - the index of the attribute in the mining schema Instances that this field represents

getName

public java.lang.String getName()

Get the name of this field.

Returns:

the name of this field

getOutlierTreatmentMethod

public weka.core.pmml.MiningFieldMetaInfo.Outlier getOutlierTreatmentMethod()

Get the outlier treatment method used for this field.

Returns:

the outlier treatment method

getMissingValueTreatmentMethod

public weka.core.pmml.MiningFieldMetaInfo.Missing getMissingValueTreatmentMethod()

Get the missing value treatment method for this field.

Returns:

the missing value treatment method

applyMissingValueTreatment

public double applyMissingValueTreatment(double value)
                                  throws java.lang.Exception

Apply the missing value treatment method for this field.

Parameters:

value - the incoming value to apply the treatment to

Returns:

the value after applying the missing value treatment (if any)

Throws:

java.lang.Exception - if there is a problem

applyOutlierTreatment

public double applyOutlierTreatment(double value)
                             throws java.lang.Exception

Apply the outlier treatment method for this field.

Parameters:

value - the incoming value to apply the treatment to

Returns:

the value after applying the treatment (if any)

Throws:

java.lang.Exception - if there is a problem

getFieldAsAttribute

public Attribute getFieldAsAttribute()

Return this mining field as an Attribute.

Specified by:

getFieldAsAttribute in class FieldMetaInfo

Returns:

an Attribute for this field.