weka.core.pmml

Class TargetMetaInfo

java.lang.Object

weka.core.pmml.FieldMetaInfo

weka.core.pmml.TargetMetaInfo

All Implemented Interfaces:

java.io.Serializable

public class TargetMetaInfo
extends FieldMetaInfo
implements java.io.Serializable

Class to encapsulate information about a Target.

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 java.lang.String	m_castInteger cast integers (default no casting)
protected double[]	m_defaultValueOrPriorProbs default value (numeric) or prior distribution (categorical)
protected java.util.ArrayList<java.lang.String>	m_displayValues corresponding display values
protected double	m_max
protected double	m_min min and max
protected double	m_rescaleConstant re-scaling of target value (if defined)
protected double	m_rescaleFactor
protected java.util.ArrayList<java.lang.String>	m_values for categorical values.

Fields inherited from class weka.core.pmml.FieldMetaInfo

m_fieldName, m_optype

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TargetMetaInfo(org.w3c.dom.Element target) Constructor.

Method Summary

Modifier and Type	Method and Description
double	applyMinMaxRescaleCast(double prediction) Apply min and max, rescaleFactor, rescaleConstant and castInteger - in that order (where defined).
double	getDefaultValue() Get the default value (numeric target)
Attribute	getFieldAsAttribute() Return this field as an Attribute.
double	getPriorProbability(java.lang.String value) Get the prior probability for the supplied value.
java.util.ArrayList<java.lang.String>	getValues() Get the values (discrete case only) for this Target.

Methods inherited from class weka.core.pmml.FieldMetaInfo

getFieldName, getOptype

Methods inherited from class java.lang.Object

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

Field Detail

m_min

protected double m_min

min and max

m_max

protected double m_max

m_rescaleConstant

protected double m_rescaleConstant

re-scaling of target value (if defined)

m_rescaleFactor

protected double m_rescaleFactor

m_castInteger

protected java.lang.String m_castInteger

cast integers (default no casting)

m_defaultValueOrPriorProbs

protected double[] m_defaultValueOrPriorProbs

default value (numeric) or prior distribution (categorical)

m_values

protected java.util.ArrayList<java.lang.String> m_values

for categorical values. Actual values

m_displayValues

protected java.util.ArrayList<java.lang.String> m_displayValues

corresponding display values

Constructor Detail

TargetMetaInfo

protected TargetMetaInfo(org.w3c.dom.Element target)
                  throws java.lang.Exception

Constructor.

Parameters:

target - the Element encapsulating a Target

Throws:

java.lang.Exception - if there is a problem reading the Target

Method Detail

getPriorProbability

public double getPriorProbability(java.lang.String value)
                           throws java.lang.Exception

Get the prior probability for the supplied value.

Parameters:

value - the value to get the probability for

Returns:

the probability

Throws:

java.lang.Exception - if there are no TargetValues defined or if the supplied value is not in the list of TargetValues

getDefaultValue

public double getDefaultValue()
                       throws java.lang.Exception

Get the default value (numeric target)

Returns:

the default value

Throws:

java.lang.Exception - if there is no TargetValue defined

getValues

public java.util.ArrayList<java.lang.String> getValues()

Get the values (discrete case only) for this Target. Note: the list may be empty if the pmml doesn't specify any values.

Returns:

the values of this Target

applyMinMaxRescaleCast

public double applyMinMaxRescaleCast(double prediction)
                              throws java.lang.Exception

Apply min and max, rescaleFactor, rescaleConstant and castInteger - in that order (where defined).

Parameters:

prediction - the prediction to apply these modification to

Returns:

the modified prediction

Throws:

java.lang.Exception - if this target is not a continuous one

getFieldAsAttribute

public Attribute getFieldAsAttribute()

Return this field as an Attribute.

Specified by:

getFieldAsAttribute in class FieldMetaInfo

Returns:

an Attribute for this field.