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
Init sequenceModelEvaluatorbased on a PMML XML input stream.- Create a new, or clone an existing object.
- Perform
ModelEvaluatorBuilder-level (ie. parent level) configuration work. For example, specify the mapping between model and application schemas. - Perform
LoadingModelEvaluatorBuilder-level configuration work. For example, specify if XML meta-information should be collected and exposed. - Load the PMML XML input stream into an in-memory class model object.
- Transform the in-memory class model object. For example, customize model business logic.
- Build.
Configuration changes typically have no effect after the class model object has been loaded.
Simple example
Complex exampleEvaluator evaluator = new LoadingModelEvaluatorBuilder() .load(new File("model.pmml")) .build();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 Description LoadingModelEvaluatorBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LoadingModelEvaluatorBuilderclone()java.util.List<? extends org.xml.sax.XMLFilter>getFilters()jakarta.xml.bind.JAXBContextgetJAXBContext()booleangetLocatable()booleangetMutable()javax.xml.validation.SchemagetSchema()jakarta.xml.bind.ValidationEventHandlergetValidationEventHandler()org.jpmml.model.visitors.VisitorBatterygetVisitors()LoadingModelEvaluatorBuilderload(java.io.File file)LoadingModelEvaluatorBuilderload(java.io.File file, java.lang.String modelName)LoadingModelEvaluatorBuilderload(java.io.InputStream is)LoadingModelEvaluatorBuilderload(java.io.InputStream is, java.lang.String modelName)LoadingModelEvaluatorBuildersetCheckSchema(boolean checkSchema)Should the "data schema" of models be checked for the most common signs of insanity?LoadingModelEvaluatorBuildersetDerivedFieldGuard(SymbolTable<java.lang.String> derivedFieldGuard)Sets a guard against recursive field declarations.LoadingModelEvaluatorBuildersetExtraResultFeatures(java.util.Set<org.dmg.pmml.ResultFeature> extraResultFeatures)Sets extra functional requirements.LoadingModelEvaluatorBuildersetFilters(java.util.List<? extends org.xml.sax.XMLFilter> filters)LoadingModelEvaluatorBuildersetFunctionGuard(SymbolTable<java.lang.String> functionGuard)Sets a guard against recursive function declarations.LoadingModelEvaluatorBuildersetInputMapper(InputMapper inputMapper)Sets a mapper for translating input field names from user namespace to model namespace.LoadingModelEvaluatorBuildersetJAXBContext(jakarta.xml.bind.JAXBContext jaxbContext)LoadingModelEvaluatorBuildersetLocatable(boolean locatable)Should PMML class model objects collect and keep SAX Locator (meta-)information?protected LoadingModelEvaluatorBuildersetModel(org.dmg.pmml.Model model)LoadingModelEvaluatorBuildersetModelEvaluatorFactory(ModelEvaluatorFactory modelEvaluatorFactory)LoadingModelEvaluatorBuildersetMutable(boolean mutable)Should polymorphic PMML class model objects use types that favour mutability over memory efficiency?LoadingModelEvaluatorBuildersetOutputFilter(OutputFilter outputFilter)Sets the filter for cleaning the model schema and model evaluation results from redundant output fields.protected LoadingModelEvaluatorBuildersetPMML(org.dmg.pmml.PMML pmml)LoadingModelEvaluatorBuildersetResultMapper(ResultMapper resultMapper)Sets a mapper for translating result field names from model namespace to user namespace.LoadingModelEvaluatorBuildersetSchema(javax.xml.validation.Schema schema)LoadingModelEvaluatorBuildersetValidationEventHandler(jakarta.xml.bind.ValidationEventHandler validationEventHandler)LoadingModelEvaluatorBuildersetValueFactoryFactory(ValueFactoryFactory valueFactoryFactory)LoadingModelEvaluatorBuildersetVisitors(org.jpmml.model.visitors.VisitorBattery visitors)<E extends java.lang.Exception>
LoadingModelEvaluatorBuildertransform(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
-
-
-
-
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.IOExceptionjavax.xml.parsers.ParserConfigurationExceptionorg.xml.sax.SAXExceptionjakarta.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.IOExceptionjavax.xml.parsers.ParserConfigurationExceptionorg.xml.sax.SAXExceptionjakarta.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.ParserConfigurationExceptionorg.xml.sax.SAXExceptionjakarta.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.ParserConfigurationExceptionorg.xml.sax.SAXExceptionjakarta.xml.bind.JAXBException
-
transform
public <E extends java.lang.Exception> LoadingModelEvaluatorBuilder transform(PMMLTransformer<E> transformer) throws E
- Throws:
E extends java.lang.Exception
-
clone
public LoadingModelEvaluatorBuilder clone()
- Specified by:
clonein interfaceEvaluatorBuilder- Overrides:
clonein classModelEvaluatorBuilder
-
setPMML
protected LoadingModelEvaluatorBuilder setPMML(org.dmg.pmml.PMML pmml)
- Overrides:
setPMMLin classModelEvaluatorBuilder
-
setModel
protected LoadingModelEvaluatorBuilder setModel(org.dmg.pmml.Model model)
- Overrides:
setModelin classModelEvaluatorBuilder
-
setModelEvaluatorFactory
public LoadingModelEvaluatorBuilder setModelEvaluatorFactory(ModelEvaluatorFactory modelEvaluatorFactory)
- Overrides:
setModelEvaluatorFactoryin classModelEvaluatorBuilder
-
setValueFactoryFactory
public LoadingModelEvaluatorBuilder setValueFactoryFactory(ValueFactoryFactory valueFactoryFactory)
- Overrides:
setValueFactoryFactoryin classModelEvaluatorBuilder
-
setOutputFilter
public LoadingModelEvaluatorBuilder setOutputFilter(OutputFilter outputFilter)
Description copied from class:ModelEvaluatorBuilderSets the filter for cleaning the model schema and model evaluation results from redundant output fields.
- Overrides:
setOutputFilterin classModelEvaluatorBuilder- See Also:
OutputFilters.KEEP_ALL,OutputFilters.KEEP_FINAL_RESULTS
-
setDerivedFieldGuard
public LoadingModelEvaluatorBuilder setDerivedFieldGuard(SymbolTable<java.lang.String> derivedFieldGuard)
Description copied from class:ModelEvaluatorBuilderSets a guard against recursive field declarations.
- Overrides:
setDerivedFieldGuardin classModelEvaluatorBuilder- See Also:
FieldNameSet
-
setFunctionGuard
public LoadingModelEvaluatorBuilder setFunctionGuard(SymbolTable<java.lang.String> functionGuard)
Description copied from class:ModelEvaluatorBuilderSets a guard against recursive function declarations.
- Overrides:
setFunctionGuardin classModelEvaluatorBuilder- See Also:
FunctionNameStack
-
setExtraResultFeatures
public LoadingModelEvaluatorBuilder setExtraResultFeatures(java.util.Set<org.dmg.pmml.ResultFeature> extraResultFeatures)
Description copied from class:ModelEvaluatorBuilderSets extra functional requirements.
The final set of functional requirements is obtained by combining default functional requirements (as declared by theOutputelement of the model) with extra functional requirements.- Overrides:
setExtraResultFeaturesin classModelEvaluatorBuilder
-
setInputMapper
public LoadingModelEvaluatorBuilder setInputMapper(InputMapper inputMapper)
Description copied from class:ModelEvaluatorBuilderSets a mapper for translating input field names from user namespace to model namespace.
- Overrides:
setInputMapperin classModelEvaluatorBuilder- See Also:
HasInputFields.getInputFields()
-
setResultMapper
public LoadingModelEvaluatorBuilder setResultMapper(ResultMapper resultMapper)
Description copied from class:ModelEvaluatorBuilderSets a mapper for translating result field names from model namespace to user namespace.
- Overrides:
setResultMapperin classModelEvaluatorBuilder- See Also:
HasResultFields.getTargetFields(),HasResultFields.getOutputFields()
-
setCheckSchema
public LoadingModelEvaluatorBuilder setCheckSchema(boolean checkSchema)
Description copied from class:ModelEvaluatorBuilderShould the "data schema" of models be checked for the most common signs of insanity?
- Overrides:
setCheckSchemain classModelEvaluatorBuilder
-
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)
-
-