Package org.kie.pmml.commons.model

Class KiePMMLFactoryModel

java.lang.Object

org.kie.pmml.commons.model.abstracts.AbstractKiePMMLComponent

org.kie.pmml.commons.model.KiePMMLModel

org.kie.pmml.commons.model.KiePMMLFactoryModel

All Implemented Interfaces:

Serializable, org.kie.pmml.api.models.PMMLModel, HasSourcesMap

public class KiePMMLFactoryModel
extends KiePMMLModel
implements HasSourcesMap

This is the model used to store sources for KiePMMLModelFactory classes; KiePMMLModelFactory, in turns, are used to retrieve List<KiePMMLModel>s from kjar inside PMMLAssemblerService

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.kie.pmml.commons.model.KiePMMLModel

KiePMMLModel.Builder<T extends KiePMMLModel>

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,String>	sourcesMap

Fields inherited from class org.kie.pmml.commons.model.KiePMMLModel

affinity, entityId, kiePMMLOutputFields, kiePMMLTargets, localTransformations, miningFields, miningFunction, outputFields, outputFieldsMap, pmmlMODEL, predictedDisplayValue, targetField, transformationDictionary

Fields inherited from class org.kie.pmml.commons.model.abstracts.AbstractKiePMMLComponent

extensions, id, name, parentId

Constructor Summary

Constructors

Constructor	Description
KiePMMLFactoryModel(String name, String kmodulePackageName, Map<String,String> sourcesMap)

Method Summary

Modifier and Type	Method	Description
void	addSourceMap(String key, String value)
Object	evaluate(Object knowledgeBase, Map<String,Object> requestData)
String	getKModulePackageName()	Method to retrieve the package name to be used inside kiebase/package attribute of kmodule.xml and to use for package creation inside PMMLAssemblerService By default returns the package name of the current instance To be eventually overridden.
Map<String,Object>	getOutputFieldsMap()
LinkedHashMap<String,Double>	getProbabilityResultMap()	Returns the probability map evaluated by the model
Map<String,String>	getSourcesMap()

Methods inherited from class org.kie.pmml.commons.model.KiePMMLModel

getAffinity, getEntityId, getKiePMMLOutputFields, getKiePMMLTargets, getLocalTransformations, getMiningFields, getMiningFunction, getOutputFields, getPmmlMODEL, getPredictedDisplayValue, getProbabilityMap, getTargetField, getTransformationDictionary, setAffinity, setEntityId, setKiePMMLTargets, setMiningFields, setOutputFields, setPredictedDisplayValue

Methods inherited from class org.kie.pmml.commons.model.abstracts.AbstractKiePMMLComponent

getExtensions, getId, getName, getParentId, setParentId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kie.pmml.commons.model.HasSourcesMap

getRulesSourcesMap

Methods inherited from interface org.kie.pmml.api.models.PMMLModel

getName

Field Detail

sourcesMap

protected Map<String,String> sourcesMap

Constructor Detail

KiePMMLFactoryModel

public KiePMMLFactoryModel(String name,
                           String kmodulePackageName,
                           Map<String,String> sourcesMap)

Method Detail

evaluate

public Object evaluate(Object knowledgeBase,
                       Map<String,Object> requestData)

Specified by:

evaluate in class KiePMMLModel

Parameters:

knowledgeBase - the knowledgeBase we are working on. Add as Object to avoid direct dependency. It is needed only by Drools-dependent models, so it may be ignored by others

Returns:

getOutputFieldsMap

public Map<String,Object> getOutputFieldsMap()

Overrides:

getOutputFieldsMap in class KiePMMLModel

getProbabilityResultMap

public LinkedHashMap<String,Double> getProbabilityResultMap()

Description copied from class: KiePMMLModel

Returns the probability map evaluated by the model

Specified by:

getProbabilityResultMap in class KiePMMLModel

Returns:

getSourcesMap

public Map<String,String> getSourcesMap()

Specified by:

getSourcesMap in interface HasSourcesMap

addSourceMap

public void addSourceMap(String key,
                         String value)

Specified by:

addSourceMap in interface HasSourcesMap

getKModulePackageName

public String getKModulePackageName()

Description copied from class: KiePMMLModel

Method to retrieve the package name to be used inside kiebase/package attribute of kmodule.xml and to use for package creation inside PMMLAssemblerService By default returns the package name of the current instance To be eventually overridden.

Overrides:

getKModulePackageName in class KiePMMLModel

Returns: