org.jpmml.evaluator

Class InputField

java.lang.Object

org.jpmml.evaluator.ModelField

org.jpmml.evaluator.InputField

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

TargetReferenceField

public class InputField
extends ModelField

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InputField(org.dmg.pmml.Field field, org.dmg.pmml.MiningField miningField)

Method Summary

Methods

Modifier and Type	Method and Description
org.dmg.pmml.DataType	getDataType()
org.dmg.pmml.Field	getField()
org.dmg.pmml.MiningField	getMiningField()
org.dmg.pmml.FieldName	getName()
org.dmg.pmml.OpType	getOpType()
FieldValue	prepare(java.lang.Object value) Prepares the input value for a field.

Methods inherited from class org.jpmml.evaluator.ModelField

toString, toStringHelper

Methods inherited from class java.lang.Object

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

Constructor Detail

InputField

public InputField(org.dmg.pmml.Field field,
          org.dmg.pmml.MiningField miningField)

Method Detail

prepare

public FieldValue prepare(java.lang.Object value)

Prepares the input value for a field.

First, the value is converted from the user-supplied representation to PMML representation. After that, the value is subjected to missing value treatment, invalid value treatment and outlier treatment.

Parameters:

value - The input value in user-supplied representation. Use null to represent a missing input value.

Throws:

EvaluationException - If the input value preparation fails.

InvalidFeatureException

UnsupportedFeatureException

getName

public org.dmg.pmml.FieldName getName()

Specified by:

getName in class ModelField

getDataType

public org.dmg.pmml.DataType getDataType()

Specified by:

getDataType in class ModelField

getOpType

public org.dmg.pmml.OpType getOpType()

Specified by:

getOpType in class ModelField

getField

public org.dmg.pmml.Field getField()

Returns:

the backing Field element. For top-level models, this is always the DataField element.

getMiningField

public org.dmg.pmml.MiningField getMiningField()

Returns:

the backing MiningField element.