org.jpmml.evaluator

Interface Consumer

All Superinterfaces:

Serializable

All Known Subinterfaces:

Evaluator

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.
org.dmg.pmml.FieldName	getTargetField() Convenience method for retrieving the sole target field.
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.

Parameters:

name - The name of the field. The name of the default target field is null.

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.

A model should have no more than 1 group field.

getOrderFields

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

Gets the order fields of a Model from its MiningSchema.

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

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)

getTargetField

org.dmg.pmml.FieldName getTargetField()

Convenience method for retrieving the sole target field.

A supervised model should, but is not required to, define a target field. An unsupervised model, by definition, does not define a target field. If the collection of target fields is empty, then the model consumer should assume that the model defines a default target field, which is represented by null. The default target field could be either "real" or "phantom". They can be distinguished from one another by looking up the definition of the field from the DataDictionary.

 Consumer consumer = ...;

 List<FieldName> targetFields = consumer.getTargetFields();
 if(targetFields.isEmpty()){
   FieldName targetField = consumer.getTargetField();

   DataField dataField = consumer.getDataField(targetField);
   if(dataField != null){
     // A "real" default target field
   } else

   {
     // A "phantom" default target field
   }
 }
 

Returns:

The sole target field.

Throws:

InvalidFeatureException - If the number of target fields is greater than one.

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(), 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()