Package org.jpmml.evaluator

Class ModelEvaluatorBuilder

java.lang.Object

org.jpmml.evaluator.ModelEvaluatorBuilder

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, EvaluatorBuilder

Direct Known Subclasses:

LoadingModelEvaluatorBuilder, ServiceLoadingModelEvaluatorBuilder

public class ModelEvaluatorBuilder
extends java.lang.Object
implements EvaluatorBuilder, java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ModelEvaluatorBuilder()
	ModelEvaluatorBuilder(org.dmg.pmml.PMML pmml)	Selects the first scorable model.
	ModelEvaluatorBuilder(org.dmg.pmml.PMML pmml, java.lang.String modelName)	Selects the named model.
	ModelEvaluatorBuilder(org.dmg.pmml.PMML pmml, org.dmg.pmml.Model model)

Method Summary

Modifier and Type	Method	Description
ModelEvaluator<?>	build()
protected void	checkSchema(ModelEvaluator<?> modelEvaluator)
ModelEvaluatorBuilder	clone()
boolean	getCheckSchema()
ConfigurationBuilder	getConfigurationBuilder()
SymbolTable<java.lang.String>	getDerivedFieldGuard()
java.util.Set<org.dmg.pmml.ResultFeature>	getExtraResultFeatures()
SymbolTable<java.lang.String>	getFunctionGuard()
InputMapper	getInputMapper()
org.dmg.pmml.Model	getModel()
ModelEvaluatorFactory	getModelEvaluatorFactory()
OutputFilter	getOutputFilter()
org.dmg.pmml.PMML	getPMML()
ResultMapper	getResultMapper()
ValueFactoryFactory	getValueFactoryFactory()
ModelEvaluatorBuilder	setCheckSchema(boolean checkSchema)	Should the "data schema" of models be checked for the most common signs of insanity?
ModelEvaluatorBuilder	setDerivedFieldGuard(SymbolTable<java.lang.String> derivedFieldGuard)	Sets a guard against recursive field declarations.
ModelEvaluatorBuilder	setExtraResultFeatures(java.util.Set<org.dmg.pmml.ResultFeature> extraResultFeatures)	Sets extra functional requirements.
ModelEvaluatorBuilder	setFunctionGuard(SymbolTable<java.lang.String> functionGuard)	Sets a guard against recursive function declarations.
ModelEvaluatorBuilder	setInputMapper(InputMapper inputMapper)	Sets a mapper for translating input field names from user namespace to model namespace.
protected ModelEvaluatorBuilder	setModel(org.dmg.pmml.Model model)
ModelEvaluatorBuilder	setModelEvaluatorFactory(ModelEvaluatorFactory modelEvaluatorFactory)
ModelEvaluatorBuilder	setOutputFilter(OutputFilter outputFilter)	Sets the filter for cleaning the model schema and model evaluation results from redundant output fields.
protected ModelEvaluatorBuilder	setPMML(org.dmg.pmml.PMML pmml)
ModelEvaluatorBuilder	setResultMapper(ResultMapper resultMapper)	Sets a mapper for translating result field names from model namespace to user namespace.
ModelEvaluatorBuilder	setValueFactoryFactory(ValueFactoryFactory valueFactoryFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelEvaluatorBuilder

protected ModelEvaluatorBuilder()

ModelEvaluatorBuilder

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

Selects the first scorable model.

Throws:

org.jpmml.model.MissingElementException - If the PMML does not contain any scorable models.

ModelEvaluatorBuilder

public ModelEvaluatorBuilder(org.dmg.pmml.PMML pmml,
                             java.lang.String modelName)

Selects the named model.

Throws:

org.jpmml.model.MissingElementException - If the PMML does not contain a model with the specified model name.

See Also:

Model.getModelName()

ModelEvaluatorBuilder

public ModelEvaluatorBuilder(org.dmg.pmml.PMML pmml,
                             org.dmg.pmml.Model model)

Method Detail

clone

public ModelEvaluatorBuilder clone()

Specified by:

clone in interface EvaluatorBuilder

Overrides:

clone in class java.lang.Object

build

public ModelEvaluator<?> build()

Specified by:

build in interface EvaluatorBuilder

checkSchema

protected void checkSchema(ModelEvaluator<?> modelEvaluator)

getPMML

public org.dmg.pmml.PMML getPMML()

setPMML

protected ModelEvaluatorBuilder setPMML(org.dmg.pmml.PMML pmml)

getModel

public org.dmg.pmml.Model getModel()

setModel

protected ModelEvaluatorBuilder setModel(org.dmg.pmml.Model model)

getConfigurationBuilder

public ConfigurationBuilder getConfigurationBuilder()

getModelEvaluatorFactory

public ModelEvaluatorFactory getModelEvaluatorFactory()

setModelEvaluatorFactory

public ModelEvaluatorBuilder setModelEvaluatorFactory(ModelEvaluatorFactory modelEvaluatorFactory)

getValueFactoryFactory

public ValueFactoryFactory getValueFactoryFactory()

setValueFactoryFactory

public ModelEvaluatorBuilder setValueFactoryFactory(ValueFactoryFactory valueFactoryFactory)

getOutputFilter

public OutputFilter getOutputFilter()

setOutputFilter

public ModelEvaluatorBuilder setOutputFilter(OutputFilter outputFilter)

Sets the filter for cleaning the model schema and model evaluation results from redundant output fields.

See Also:

OutputFilters.KEEP_ALL, OutputFilters.KEEP_FINAL_RESULTS

getDerivedFieldGuard

public SymbolTable<java.lang.String> getDerivedFieldGuard()

setDerivedFieldGuard

public ModelEvaluatorBuilder setDerivedFieldGuard(SymbolTable<java.lang.String> derivedFieldGuard)

Sets a guard against recursive field declarations.

See Also:

FieldNameSet

getFunctionGuard

public SymbolTable<java.lang.String> getFunctionGuard()

setFunctionGuard

public ModelEvaluatorBuilder setFunctionGuard(SymbolTable<java.lang.String> functionGuard)

Sets a guard against recursive function declarations.

See Also:

FunctionNameStack

getExtraResultFeatures

public java.util.Set<org.dmg.pmml.ResultFeature> getExtraResultFeatures()

setExtraResultFeatures

public ModelEvaluatorBuilder setExtraResultFeatures(java.util.Set<org.dmg.pmml.ResultFeature> extraResultFeatures)

Sets extra functional requirements.

The final set of functional requirements is obtained by combining default functional requirements (as declared by the Output element of the model) with extra functional requirements.

getInputMapper

public InputMapper getInputMapper()

setInputMapper

public ModelEvaluatorBuilder setInputMapper(InputMapper inputMapper)

Sets a mapper for translating input field names from user namespace to model namespace.

See Also:

HasInputFields.getInputFields()

getResultMapper

public ResultMapper getResultMapper()

setResultMapper

public ModelEvaluatorBuilder setResultMapper(ResultMapper resultMapper)

Sets a mapper for translating result field names from model namespace to user namespace.

See Also:

HasResultFields.getTargetFields(), HasResultFields.getOutputFields()

getCheckSchema

public boolean getCheckSchema()

setCheckSchema

public ModelEvaluatorBuilder setCheckSchema(boolean checkSchema)

Should the "data schema" of models be checked for the most common signs of insanity?