org.jpmml.evaluator.association

Class AssociationModelEvaluator

java.lang.Object

org.jpmml.evaluator.ModelEvaluator<org.dmg.pmml.association.AssociationModel>

org.jpmml.evaluator.association.AssociationModelEvaluator

All Implemented Interfaces:

Serializable, Evaluator, HasActiveFields, HasEntityRegistry<org.dmg.pmml.association.AssociationRule>, HasGroupFields, HasInputFields, HasModel<org.dmg.pmml.association.AssociationModel>, HasPMML, HasResultFields

public class AssociationModelEvaluator
extends ModelEvaluator<org.dmg.pmml.association.AssociationModel>
implements HasGroupFields, HasEntityRegistry<org.dmg.pmml.association.AssociationRule>

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.jpmml.evaluator.Evaluator

DEFAULT_TARGET_NAME

Constructor Summary

Constructors

Constructor and Description
AssociationModelEvaluator(org.dmg.pmml.PMML pmml)
AssociationModelEvaluator(org.dmg.pmml.PMML pmml, org.dmg.pmml.association.AssociationModel associationModel)

Method Summary

Modifier and Type	Method and Description
protected List<TargetField>	createTargetFields()
Map<org.dmg.pmml.FieldName,?>	evaluate(ModelEvaluationContext context)
com.google.common.collect.BiMap<String,org.dmg.pmml.association.AssociationRule>	getEntityRegistry()
List<InputField>	getGroupFields() Gets the group fields of a Model from its MiningSchema.
String	getSummary() Gets a short description of the Model.
org.dmg.pmml.Target	getTarget(org.dmg.pmml.FieldName name)
org.dmg.pmml.FieldName	getTargetFieldName()

Methods inherited from class org.jpmml.evaluator.ModelEvaluator

configure, createInputFields, createInputFields, createMiningSchemaException, createOutputFields, ensureScorableModel, ensureValueFactory, evaluate, getActiveFields, getConfiguration, getDataField, getDataField, getDefineFunction, getDerivedField, getInputFields, getLocalDerivedField, getMathContext, getMiningField, getMiningFunction, getModel, getOutputField, getOutputFields, getPMML, getTargetField, getTargetFields, getValue, getValue, getValueFactory, isPrimitive, resolveDerivedField, resolveField, verify

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.HasActiveFields

getActiveFields

Constructor Detail

AssociationModelEvaluator

public AssociationModelEvaluator(org.dmg.pmml.PMML pmml)

AssociationModelEvaluator

public AssociationModelEvaluator(org.dmg.pmml.PMML pmml,
                                 org.dmg.pmml.association.AssociationModel associationModel)

Method Detail

getSummary

public String getSummary()

Description copied from interface: Evaluator

Gets a short description of the Model.

Specified by:

getSummary in interface Evaluator

getGroupFields

public List<InputField> getGroupFields()

Description copied from interface: HasGroupFields

Gets the group fields of a Model from its MiningSchema.

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

Specified by:

getGroupFields in interface HasGroupFields

getTarget

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

Overrides:

getTarget in class ModelEvaluator<org.dmg.pmml.association.AssociationModel>

Returns:

null Always.

getTargetFieldName

public org.dmg.pmml.FieldName getTargetFieldName()

Overrides:

getTargetFieldName in class ModelEvaluator<org.dmg.pmml.association.AssociationModel>

getEntityRegistry

public com.google.common.collect.BiMap<String,org.dmg.pmml.association.AssociationRule> getEntityRegistry()

Specified by:

getEntityRegistry in interface HasEntityRegistry<org.dmg.pmml.association.AssociationRule>

Returns:

A bidirectional map between Entity identifiers and Entity instances.

createTargetFields

protected List<TargetField> createTargetFields()

Overrides:

createTargetFields in class ModelEvaluator<org.dmg.pmml.association.AssociationModel>

evaluate

public Map<org.dmg.pmml.FieldName,?> evaluate(ModelEvaluationContext context)

Specified by:

evaluate in class ModelEvaluator<org.dmg.pmml.association.AssociationModel>