org.jpmml.evaluator

Class InputField

java.lang.Object

org.jpmml.evaluator.ModelField

org.jpmml.evaluator.InputField

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ResidualInputField

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

Modifier and Type	Method and Description
com.google.common.collect.RangeSet<Double>	getContinuousDomain() Returns the domain of valid values for this continuous field.
org.dmg.pmml.DataType	getDataType()
List<?>	getDiscreteDomain() Returns the domain of valid values for this categorical or ordinal field.
org.dmg.pmml.Field<?>	getField()
org.dmg.pmml.MiningField	getMiningField()
org.dmg.pmml.FieldName	getName()
org.dmg.pmml.OpType	getOpType()
FieldValue	prepare(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(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.

InvalidMarkupException

UnsupportedMarkupException

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

getContinuousDomain

public com.google.common.collect.RangeSet<Double> getContinuousDomain()

Returns the domain of valid values for this continuous field. If specified, then all input values that are contained in this set shall be considered valid, and all others invalid. If not specified, then all input values shall be considered valid.

Returns:

a non-empty set, or null.

See Also:

getOpType()

getDiscreteDomain

public List<?> getDiscreteDomain()

Returns the domain of valid values for this categorical or ordinal field. If specified, then all input values that are contained in this list shall be considered valid, and all others invalid. In not specified, then all input values shall be considered valid.

List elements are all valid values in PMML representation. For example, if the data type of this field is DataType.INTEGER, then all list elements shall be Integer.

Returns:

a non-empty list, or null.

See Also:

getDataType(), getOpType(), TypeUtil.parse(DataType, String), TypeUtil.parseOrCast(DataType, Object)

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.