org.jpmml.evaluator

Class OutputField

java.lang.Object

org.jpmml.evaluator.ModelField

org.jpmml.evaluator.ResultField

org.jpmml.evaluator.OutputField

All Implemented Interfaces:

java.io.Serializable

public class OutputField
extends ResultField

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OutputField(OutputField outputField)
OutputField(org.dmg.pmml.OutputField outputField)
OutputField(org.dmg.pmml.OutputField outputField, int depth)

Method Summary

Methods

Modifier and Type	Method and Description
org.dmg.pmml.DataType	getDataType()
int	getDepth() Returns the nesting depth relative to the "host" Evaluator instance.
org.dmg.pmml.FieldName	getName()
org.dmg.pmml.OpType	getOpType()
org.dmg.pmml.OutputField	getOutputField()
boolean	isFinalResult() Returns the "finality" (as decided by the PMML producer) of this output field.
protected com.google.common.base.Objects.ToStringHelper	toStringHelper()

Methods inherited from class org.jpmml.evaluator.ModelField

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputField

public OutputField(OutputField outputField)

OutputField

public OutputField(org.dmg.pmml.OutputField outputField)

OutputField

public OutputField(org.dmg.pmml.OutputField outputField,
           int depth)

Method Detail

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

Returns:

the data type, or null.

See Also:

OutputUtil.getDataType(org.dmg.pmml.OutputField, ModelEvaluator)

getOpType

public org.dmg.pmml.OpType getOpType()

Specified by:

getOpType in class ModelField

Returns:

the operational type, or null.

isFinalResult

public boolean isFinalResult()

Returns the "finality" (as decided by the PMML producer) of this output field. Final values are suitable for displaying to the end user. Non-final values correspond to intermediate states of the prediction (eg. value transformations, value transfers between models) and are not suitable for displaying to the end user.

Typically, final values are always available in the result data record, whereas non-final values may or may not be available depending on the "evaluation path" of a particular argument data record.

Filtering output fields based on their "finality":

 List<OutputField> outputFields = evaluator.getOutputFields();
 for(OutputField outputField : outputFields){
   boolean finalResult = outputField.isFinalResult();

   if(!finalResult){
     continue;
   }
 }
 

toStringHelper

protected com.google.common.base.Objects.ToStringHelper toStringHelper()

Overrides:

toStringHelper in class ModelField

getOutputField

public org.dmg.pmml.OutputField getOutputField()

Returns:

the backing OutputField element.

getDepth

public int getDepth()

Returns the nesting depth relative to the "host" Evaluator instance.

Filtering output fields based on their origin:

 List<OutputField> outputFields = evaluator.getOutputFields();
 for(OutputField outputField : outputFields){
   int depth = outputField.getDepth();

   if(depth == 0){
     // Defined by the top-level model
   } else

   if(depth > 0){
     // Defined by one of the nested models
   }
 }
 

Returns:

the nesting depth.