org.jpmml.evaluator

Class LoadingModelEvaluatorBuilder

java.lang.Object

org.jpmml.evaluator.ModelEvaluatorBuilder

org.jpmml.evaluator.LoadingModelEvaluatorBuilder

All Implemented Interfaces:

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

public class LoadingModelEvaluatorBuilder
extends ModelEvaluatorBuilder

Builds a ModelEvaluator based on a PMML XML input stream.

Init sequence

1. Create a new, or clone an existing object.
2. Perform ModelEvaluatorBuilder-level (ie. parent level) configuration work. For example, specify the mapping between model and application schemas.
3. Perform LoadingModelEvaluatorBuilder-level configuration work. For example, specify if XML meta-information should be collected and exposed.
4. Load the PMML XML input stream into an in-memory class model object.
5. Transform the in-memory class model object. For example, customize model business logic.
6. Build.

Configuration changes typically have no effect after the class model object has been loaded.

Simple example

 Evaluator evaluator = new LoadingModelEvaluatorBuilder()
   .load(new File("model.pmml"))
   .build();
 

Complex example

 LoadingModelEvaluatorBuilder evaluatorBuilder = new LoadingModelEvaluatorBuilder()
   .setOutputFilter(OutputFilters.KEEP_FINAL_RESULTS)
   .setLocatable(false);

 Evaluator firstEvaluator = evaluatorBuilder
   .load(new File("model-001.pmml"))
   .build();

 Evaluator secondEvaluator = evaluatorBuilder
   .setMutable(true)
   .load(new File("model-002.pmml"))
   .transform(pmml -> transpile(pmml))
   .build();
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LoadingModelEvaluatorBuilder()

Method Summary

Modifier and Type	Method and Description
LoadingModelEvaluatorBuilder	clone()
java.util.List<? extends org.xml.sax.XMLFilter>	getFilters()
jakarta.xml.bind.JAXBContext	getJAXBContext()
boolean	getLocatable()
boolean	getMutable()
javax.xml.validation.Schema	getSchema()
jakarta.xml.bind.ValidationEventHandler	getValidationEventHandler()
org.jpmml.model.visitors.VisitorBattery	getVisitors()
LoadingModelEvaluatorBuilder	load(java.io.File file)
LoadingModelEvaluatorBuilder	load(java.io.File file, java.lang.String modelName)
LoadingModelEvaluatorBuilder	load(java.io.InputStream is)
LoadingModelEvaluatorBuilder	load(java.io.InputStream is, java.lang.String modelName)
LoadingModelEvaluatorBuilder	setCheckSchema(boolean checkSchema) Should the "data schema" of models be checked for the most common signs of insanity?
LoadingModelEvaluatorBuilder	setDerivedFieldGuard(SymbolTable<java.lang.String> derivedFieldGuard) Sets a guard against recursive field declarations.
LoadingModelEvaluatorBuilder	setExtraResultFeatures(java.util.Set<org.dmg.pmml.ResultFeature> extraResultFeatures) Sets extra functional requirements.
LoadingModelEvaluatorBuilder	setFilters(java.util.List<? extends org.xml.sax.XMLFilter> filters)
LoadingModelEvaluatorBuilder	setFunctionGuard(SymbolTable<java.lang.String> functionGuard) Sets a guard against recursive function declarations.
LoadingModelEvaluatorBuilder	setInputMapper(InputMapper inputMapper) Sets a mapper for translating input field names from user namespace to model namespace.
LoadingModelEvaluatorBuilder	setJAXBContext(jakarta.xml.bind.JAXBContext jaxbContext)
LoadingModelEvaluatorBuilder	setLocatable(boolean locatable) Should PMML class model objects collect and keep SAX Locator (meta-)information?
protected LoadingModelEvaluatorBuilder	setModel(org.dmg.pmml.Model model)
LoadingModelEvaluatorBuilder	setModelEvaluatorFactory(ModelEvaluatorFactory modelEvaluatorFactory)
LoadingModelEvaluatorBuilder	setMutable(boolean mutable) Should polymorphic PMML class model objects use types that favour mutability over memory efficiency?
LoadingModelEvaluatorBuilder	setOutputFilter(OutputFilter outputFilter) Sets the filter for cleaning the model schema and model evaluation results from redundant output fields.
protected LoadingModelEvaluatorBuilder	setPMML(org.dmg.pmml.PMML pmml)
LoadingModelEvaluatorBuilder	setResultMapper(ResultMapper resultMapper) Sets a mapper for translating result field names from model namespace to user namespace.
LoadingModelEvaluatorBuilder	setSchema(javax.xml.validation.Schema schema)
LoadingModelEvaluatorBuilder	setValidationEventHandler(jakarta.xml.bind.ValidationEventHandler validationEventHandler)
LoadingModelEvaluatorBuilder	setValueFactoryFactory(ValueFactoryFactory valueFactoryFactory)
LoadingModelEvaluatorBuilder	setVisitors(org.jpmml.model.visitors.VisitorBattery visitors)
<E extends java.lang.Exception> LoadingModelEvaluatorBuilder	transform(PMMLTransformer<E> transformer)

Methods inherited from class org.jpmml.evaluator.ModelEvaluatorBuilder

build, checkSchema, getCheckSchema, getConfigurationBuilder, getDerivedFieldGuard, getExtraResultFeatures, getFunctionGuard, getInputMapper, getModel, getModelEvaluatorFactory, getOutputFilter, getPMML, getResultMapper, getValueFactoryFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadingModelEvaluatorBuilder

public LoadingModelEvaluatorBuilder()

Method Detail

load

public LoadingModelEvaluatorBuilder load(java.io.File file)
                                  throws java.io.IOException,
                                         javax.xml.parsers.ParserConfigurationException,
                                         org.xml.sax.SAXException,
                                         jakarta.xml.bind.JAXBException

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

jakarta.xml.bind.JAXBException

load

public LoadingModelEvaluatorBuilder load(java.io.File file,
                                         java.lang.String modelName)
                                  throws java.io.IOException,
                                         javax.xml.parsers.ParserConfigurationException,
                                         org.xml.sax.SAXException,
                                         jakarta.xml.bind.JAXBException

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

jakarta.xml.bind.JAXBException

load

public LoadingModelEvaluatorBuilder load(java.io.InputStream is)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         org.xml.sax.SAXException,
                                         jakarta.xml.bind.JAXBException

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

jakarta.xml.bind.JAXBException

load

public LoadingModelEvaluatorBuilder load(java.io.InputStream is,
                                         java.lang.String modelName)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         org.xml.sax.SAXException,
                                         jakarta.xml.bind.JAXBException

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

jakarta.xml.bind.JAXBException

transform

public <E extends java.lang.Exception> LoadingModelEvaluatorBuilder transform(PMMLTransformer<E> transformer)
                                                                       throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

clone

public LoadingModelEvaluatorBuilder clone()

Specified by:

clone in interface EvaluatorBuilder

Overrides:

clone in class ModelEvaluatorBuilder

setPMML

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

Overrides:

setPMML in class ModelEvaluatorBuilder

setModel

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

Overrides:

setModel in class ModelEvaluatorBuilder

setModelEvaluatorFactory

public LoadingModelEvaluatorBuilder setModelEvaluatorFactory(ModelEvaluatorFactory modelEvaluatorFactory)

Overrides:

setModelEvaluatorFactory in class ModelEvaluatorBuilder

setValueFactoryFactory

public LoadingModelEvaluatorBuilder setValueFactoryFactory(ValueFactoryFactory valueFactoryFactory)

Overrides:

setValueFactoryFactory in class ModelEvaluatorBuilder

setOutputFilter

public LoadingModelEvaluatorBuilder setOutputFilter(OutputFilter outputFilter)

Description copied from class: ModelEvaluatorBuilder

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

Overrides:

setOutputFilter in class ModelEvaluatorBuilder

See Also:

OutputFilters.KEEP_ALL, OutputFilters.KEEP_FINAL_RESULTS

setDerivedFieldGuard

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

Description copied from class: ModelEvaluatorBuilder

Sets a guard against recursive field declarations.

Overrides:

setDerivedFieldGuard in class ModelEvaluatorBuilder

See Also:

FieldNameSet

setFunctionGuard

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

Description copied from class: ModelEvaluatorBuilder

Sets a guard against recursive function declarations.

Overrides:

setFunctionGuard in class ModelEvaluatorBuilder

See Also:

FunctionNameStack

setExtraResultFeatures

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

Description copied from class: ModelEvaluatorBuilder

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.

Overrides:

setExtraResultFeatures in class ModelEvaluatorBuilder

setInputMapper

public LoadingModelEvaluatorBuilder setInputMapper(InputMapper inputMapper)

Description copied from class: ModelEvaluatorBuilder

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

Overrides:

setInputMapper in class ModelEvaluatorBuilder

See Also:

HasInputFields.getInputFields()

setResultMapper

public LoadingModelEvaluatorBuilder setResultMapper(ResultMapper resultMapper)

Description copied from class: ModelEvaluatorBuilder

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

Overrides:

setResultMapper in class ModelEvaluatorBuilder

See Also:

HasResultFields.getTargetFields(), HasResultFields.getOutputFields()

setCheckSchema

public LoadingModelEvaluatorBuilder setCheckSchema(boolean checkSchema)

Description copied from class: ModelEvaluatorBuilder

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

Overrides:

setCheckSchema in class ModelEvaluatorBuilder

getJAXBContext

public jakarta.xml.bind.JAXBContext getJAXBContext()

setJAXBContext

public LoadingModelEvaluatorBuilder setJAXBContext(jakarta.xml.bind.JAXBContext jaxbContext)

See Also:

JAXBUtil.getObjectFactoryClasses()

getSchema

public javax.xml.validation.Schema getSchema()

setSchema

public LoadingModelEvaluatorBuilder setSchema(javax.xml.validation.Schema schema)

See Also:

Unmarshaller.setSchema(Schema)

getValidationEventHandler

public jakarta.xml.bind.ValidationEventHandler getValidationEventHandler()

setValidationEventHandler

public LoadingModelEvaluatorBuilder setValidationEventHandler(jakarta.xml.bind.ValidationEventHandler validationEventHandler)

See Also:

Unmarshaller.setEventHandler(ValidationEventHandler)

getFilters

public java.util.List<? extends org.xml.sax.XMLFilter> getFilters()

setFilters

public LoadingModelEvaluatorBuilder setFilters(java.util.List<? extends org.xml.sax.XMLFilter> filters)

getLocatable

public boolean getLocatable()

setLocatable

public LoadingModelEvaluatorBuilder setLocatable(boolean locatable)

Should PMML class model objects collect and keep SAX Locator (meta-)information?

getMutable

public boolean getMutable()

setMutable

public LoadingModelEvaluatorBuilder setMutable(boolean mutable)

Should polymorphic PMML class model objects use types that favour mutability over memory efficiency?

getVisitors

public org.jpmml.model.visitors.VisitorBattery getVisitors()

setVisitors

public LoadingModelEvaluatorBuilder setVisitors(org.jpmml.model.visitors.VisitorBattery visitors)