Package org.jpmml.evaluator

Class TargetField

java.lang.Object

org.jpmml.evaluator.ModelField

org.jpmml.evaluator.ResultField

org.jpmml.evaluator.TargetField

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SyntheticTargetField

public class TargetField
extends ResultField

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TargetField(org.dmg.pmml.DataField dataField, org.dmg.pmml.MiningField miningField, org.dmg.pmml.Target target)

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.Object>	getCategories()	Returns the range of categories for this categorical or ordinal field.
org.dmg.pmml.DataField	getField()
java.lang.String	getFieldName()	The name of this model field in PMML space.
org.dmg.pmml.MiningField	getMiningField()
org.dmg.pmml.OpType	getOpType()
org.dmg.pmml.Target	getTarget()
boolean	isSynthetic()

Methods inherited from class org.jpmml.evaluator.ModelField

getDataType, getDisplayName, getName, toString, toStringHelper

Methods inherited from class java.lang.Object

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

Constructor Detail

TargetField

public TargetField(org.dmg.pmml.DataField dataField,
                   org.dmg.pmml.MiningField miningField,
                   org.dmg.pmml.Target target)

Method Detail

getFieldName

public java.lang.String getFieldName()

Description copied from class: ModelField

The name of this model field in PMML space.

Overrides:

getFieldName in class ModelField

Returns:

The name, or null (in the form of the constant Evaluator.DEFAULT_TARGET_NAME) if this is a synthetic target field.

See Also:

isSynthetic()

getOpType

public org.dmg.pmml.OpType getOpType()

Overrides:

getOpType in class ModelField

getCategories

public java.util.List<java.lang.Object> getCategories()

Returns the range of categories for this categorical or ordinal field.

Returns:

A non-empty list, or null.

See Also:

getOpType(), CategoricalResultFeature, CategoricalResultFeature.getCategories()

isSynthetic

public boolean isSynthetic()

getField

public org.dmg.pmml.DataField getField()

Overrides:

getField in class ModelField

Returns:

The backing DataField element.

getMiningField

public org.dmg.pmml.MiningField getMiningField()

Returns:

The backing MiningField element, or null if this a synthetic target field.

See Also:

isSynthetic()

getTarget

public org.dmg.pmml.Target getTarget()

Returns:

The backing Target element, or null.