Package org.kie.pmml.api.runtime

Interface PMMLRuntime

public interface PMMLRuntime

Method Summary

Modifier and Type	Method	Description
org.kie.api.pmml.PMML4Result	evaluate(java.lang.String modelName, PMMLRuntimeContext context)	Evaluate the model, given the context
java.util.Optional<PMMLModel>	getPMMLModel(java.lang.String fileName, java.lang.String modelName, PMMLRuntimeContext context)	Returns the model registered with the given model name.
java.util.List<PMMLModel>	getPMMLModels(PMMLRuntimeContext context)	Returns a list of all models available to this runtime

Method Detail

evaluate

org.kie.api.pmml.PMML4Result evaluate(java.lang.String modelName,
                                      PMMLRuntimeContext context)

Evaluate the model, given the context

Parameters:

modelName - the name of the model to evaluate

context - the context with all the input variables

Returns:

the result of the evaluation

getPMMLModels

java.util.List<PMMLModel> getPMMLModels(PMMLRuntimeContext context)

Returns a list of all models available to this runtime

Returns:

the list of available models. An empty list in case no model is available.

getPMMLModel

java.util.Optional<PMMLModel> getPMMLModel(java.lang.String fileName,
                                           java.lang.String modelName,
                                           PMMLRuntimeContext context)

Returns the model registered with the given model name.

Parameters:

modelName - the name of the model

Returns:

the corresponding an Optional with the PMMLModel retrieved, or an empty one if none is registered with the given name.