org.jpmml.evaluator

Class ModelManager<M extends org.dmg.pmml.Model>

java.lang.Object

org.jpmml.evaluator.PMMLManager

org.jpmml.evaluator.ModelManager<M>

All Implemented Interfaces:

Serializable, Consumer

Direct Known Subclasses:

ModelEvaluator

public class ModelManager<M extends org.dmg.pmml.Model>
extends PMMLManager
implements Consumer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static EnumSet<org.dmg.pmml.FieldUsageType>	ACTIVE_TYPES
protected static EnumSet<org.dmg.pmml.FieldUsageType>	GROUP_TYPES
protected static EnumSet<org.dmg.pmml.FieldUsageType>	ORDER_TYPES
protected static EnumSet<org.dmg.pmml.FieldUsageType>	TARGET_TYPES

Constructor Summary

Constructors

Constructor and Description
ModelManager(org.dmg.pmml.PMML pmml, M model)

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.
List<org.dmg.pmml.FieldName>	getGroupFields() Gets the group fields of a Model from its MiningSchema.
org.dmg.pmml.DerivedField	getLocalDerivedField(org.dmg.pmml.FieldName name)
org.dmg.pmml.MiningField	getMiningField(org.dmg.pmml.FieldName name) Gets the definition of a field from the MiningSchema.
protected List<org.dmg.pmml.FieldName>	getMiningFields(EnumSet<org.dmg.pmml.FieldUsageType> fieldUsageTypes)
org.dmg.pmml.MiningFunctionType	getMiningFunction() Gets the type of the Model.
M	getModel()
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.

Methods inherited from class org.jpmml.evaluator.PMMLManager

getDataField, getDerivedField, getFunction, getPMML

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jpmml.evaluator.Consumer

getDataField

Field Detail

ACTIVE_TYPES

protected static final EnumSet<org.dmg.pmml.FieldUsageType> ACTIVE_TYPES

GROUP_TYPES

protected static final EnumSet<org.dmg.pmml.FieldUsageType> GROUP_TYPES

ORDER_TYPES

protected static final EnumSet<org.dmg.pmml.FieldUsageType> ORDER_TYPES

TARGET_TYPES

protected static final EnumSet<org.dmg.pmml.FieldUsageType> TARGET_TYPES

Constructor Detail

ModelManager

public ModelManager(org.dmg.pmml.PMML pmml,
            M model)

Method Detail

getSummary

public String getSummary()

Description copied from interface: Consumer

Gets a short description of the Model.

Specified by:

getSummary in interface Consumer

getMiningFunction

public org.dmg.pmml.MiningFunctionType getMiningFunction()

Description copied from interface: Consumer

Gets the type of the Model.

Specified by:

getMiningFunction in interface Consumer

getActiveFields

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

Description copied from interface: Consumer

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

Specified by:

getActiveFields in interface Consumer

getGroupFields

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

Description copied from interface: Consumer

Gets the group fields of a Model from its MiningSchema.

A model should have no more than 1 group field.

Specified by:

getGroupFields in interface Consumer

getOrderFields

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

Description copied from interface: Consumer

Gets the order fields of a Model from its MiningSchema.

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

Specified by:

getOrderFields in interface Consumer

getTargetFields

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

Description copied from interface: Consumer

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

Specified by:

getTargetFields in interface Consumer

See Also:

Consumer.getTarget(FieldName)

getTargetField

public org.dmg.pmml.FieldName getTargetField()

Description copied from interface: Consumer

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
   }
 }
 

Specified by:

getTargetField in interface Consumer

Returns:

The sole target field.

getMiningField

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

Description copied from interface: Consumer

Gets the definition of a field from the MiningSchema.

Specified by:

getMiningField in interface Consumer

Parameters:

name - The name of the field.

See Also:

Consumer.getActiveFields(), Consumer.getGroupFields(), Consumer.getTargetFields()

getMiningFields

protected List<org.dmg.pmml.FieldName> getMiningFields(EnumSet<org.dmg.pmml.FieldUsageType> fieldUsageTypes)

getLocalDerivedField

public org.dmg.pmml.DerivedField getLocalDerivedField(org.dmg.pmml.FieldName name)

getTarget

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

Description copied from interface: Consumer

Gets the definition of a field from the Targets.

Specified by:

getTarget in interface Consumer

See Also:

Consumer.getTargetFields()

getOutputFields

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

Description copied from interface: Consumer

Gets the output fields of a Model from its Output.

Specified by:

getOutputFields in interface Consumer

See Also:

Consumer.getOutputField(FieldName)

getOutputField

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

Description copied from interface: Consumer

Gets the definition of a field from the Output

Specified by:

getOutputField in interface Consumer

See Also:

Consumer.getOutputFields()

getModel

public M getModel()