Package org.jpmml.evaluator

Class ModelEvaluatorBuilder

java.lang.Object

org.jpmml.evaluator.ModelEvaluatorBuilder

All Implemented Interfaces:

Serializable, Cloneable, EvaluatorBuilder

Direct Known Subclasses:

LoadingModelEvaluatorBuilder, ServiceLoadingModelEvaluatorBuilder

public class ModelEvaluatorBuilder
extends Object
implements EvaluatorBuilder, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ModelEvaluatorBuilder(org.dmg.pmml.PMML pmml)	Selects the first scorable model.
ModelEvaluatorBuilder(org.dmg.pmml.PMML pmml, 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()
ModelEvaluatorBuilder	clone()
boolean	getCheckSchema()
ConfigurationBuilder	getConfigurationBuilder()
SymbolTable<String>	getDerivedFieldGuard()
Set<org.dmg.pmml.ResultFeature>	getExtraResultFeatures()
SymbolTable<String>	getFunctionGuard()
org.dmg.pmml.Model	getModel()
ModelEvaluatorFactory	getModelEvaluatorFactory()
OutputFilter	getOutputFilter()
org.dmg.pmml.PMML	getPMML()
ValueFactoryFactory	getValueFactoryFactory()
ModelEvaluatorBuilder	setCheckSchema(boolean checkSchema)	Should the "data schema" of models be checked for the most common signs of insanity?
ModelEvaluatorBuilder	setDerivedFieldGuard(SymbolTable<String> derivedFieldGuard)	Sets a guard against recursive field declarations.
ModelEvaluatorBuilder	setExtraResultFeatures(Set<org.dmg.pmml.ResultFeature> extraResultFeatures)	Sets extra functional requirements.
ModelEvaluatorBuilder	setFunctionGuard(SymbolTable<String> functionGuard)	Sets a guard against recursive function declarations.
ModelEvaluatorBuilder	setModelEvaluatorFactory(ModelEvaluatorFactory modelEvaluatorFactory)
ModelEvaluatorBuilder	setOutputFilter(OutputFilter outputFilter)	Sets the filter for cleaning the model schema and model evaluation results from redundant output fields.
ModelEvaluatorBuilder	setValueFactoryFactory(ValueFactoryFactory valueFactoryFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

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

build

public ModelEvaluator<?> build()

Specified by:

build in interface EvaluatorBuilder

getPMML

public org.dmg.pmml.PMML getPMML()

getModel

public org.dmg.pmml.Model getModel()

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<String> getDerivedFieldGuard()

setDerivedFieldGuard

public ModelEvaluatorBuilder setDerivedFieldGuard(SymbolTable<String> derivedFieldGuard)

Sets a guard against recursive field declarations.

See Also:

FieldNameSet

getFunctionGuard

public SymbolTable<String> getFunctionGuard()

setFunctionGuard

public ModelEvaluatorBuilder setFunctionGuard(SymbolTable<String> functionGuard)

Sets a guard against recursive function declarations.

See Also:

FunctionNameStack

getExtraResultFeatures

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

setExtraResultFeatures

public ModelEvaluatorBuilder setExtraResultFeatures(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.

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?