org.jpmml.evaluator

Interface Consumer

All Superinterfaces:

Serializable

All Known Subinterfaces:

Evaluator, MiningModelConsumer

All Known Implementing Classes:

AssociationModelEvaluator, ClusteringModelEvaluator, GeneralRegressionModelEvaluator, MiningModelEvaluator, ModelEvaluator, ModelManager, NaiveBayesModelEvaluator, NearestNeighborModelEvaluator, NeuralNetworkEvaluator, RegressionModelEvaluator, RuleSetModelEvaluator, ScorecardEvaluator, SupportVectorMachineModelEvaluator, TreeModelEvaluator

public interface Consumer
extends Serializable

Method Summary

Methods

Modifier and Type	Method and Description
List<org.dmg.pmml.FieldName>	getActiveFields() Gets the independent (ie. input) fields of a Model from its MiningSchema.
org.dmg.pmml.DataField	getDataField(org.dmg.pmml.FieldName name) Gets the definition of a field from the DataDictionary.
List<org.dmg.pmml.FieldName>	getGroupFields() Gets the group fields of a Model from its MiningSchema.
org.dmg.pmml.MiningField	getMiningField(org.dmg.pmml.FieldName name) Gets the definition of a field from the MiningSchema.
org.dmg.pmml.MiningFunctionType	getMiningFunction() Gets the type of the Model.
List<org.dmg.pmml.FieldName>	getOrderFields() Gets the order fields of a Model from its MiningSchema.
org.dmg.pmml.OutputField	getOutputField(org.dmg.pmml.FieldName name) Gets the definition of a field from the Output
List<org.dmg.pmml.FieldName>	getOutputFields() Gets the output fields of a Model from its Output.
String	getSummary() Gets a short description of the Model.
org.dmg.pmml.Target	getTarget(org.dmg.pmml.FieldName name) Gets the definition of a field from the Targets.
List<org.dmg.pmml.FieldName>	getTargetFields() Gets the dependent (ie. target in supervised training) fields of a Model from its MiningSchema.

Method Detail

getSummary

String getSummary()

Gets a short description of the Model.

getMiningFunction

org.dmg.pmml.MiningFunctionType getMiningFunction()

Gets the type of the Model.

getDataField

org.dmg.pmml.DataField getDataField(org.dmg.pmml.FieldName name)

Gets the definition of a field from the DataDictionary.

getActiveFields

List<org.dmg.pmml.FieldName> getActiveFields()

Gets the independent (ie. input) fields of a Model from its MiningSchema.

getGroupFields

List<org.dmg.pmml.FieldName> getGroupFields()

Gets the group fields of a Model from its MiningSchema.

This field set is relevant for association rules model type only.

getOrderFields

List<org.dmg.pmml.FieldName> getOrderFields()

Gets the order fields of a Model from its MiningSchema.

This field set is relevant for sequences and time series model types.

getTargetFields

List<org.dmg.pmml.FieldName> getTargetFields()

Gets the dependent (ie. target in supervised training) fields of a Model from its MiningSchema.

See Also:

getTarget(FieldName)

getMiningField

org.dmg.pmml.MiningField getMiningField(org.dmg.pmml.FieldName name)

Gets the definition of a field from the MiningSchema.

Parameters:

name - The name of the field.

See Also:

getActiveFields(), getGroupFields(), getOrderFields(), getTargetFields()

getTarget

org.dmg.pmml.Target getTarget(org.dmg.pmml.FieldName name)

Gets the definition of a field from the Targets.

See Also:

getTargetFields()

getOutputFields

List<org.dmg.pmml.FieldName> getOutputFields()

Gets the output fields of a Model from its Output.

See Also:

getOutputField(FieldName)

getOutputField

org.dmg.pmml.OutputField getOutputField(org.dmg.pmml.FieldName name)

Gets the definition of a field from the Output

See Also:

getOutputFields()