Package org.kie.pmml.commons.model

Class KiePMMLModel

java.lang.Object

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

org.kie.pmml.commons.model.KiePMMLModel

All Implemented Interfaces:

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

Direct Known Subclasses:

KiePMMLFactoryModel

public abstract class KiePMMLModel
extends AbstractKiePMMLComponent
implements org.kie.pmml.api.models.PMMLModel

KIE representation of PMML model

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KiePMMLModel.Builder<T extends KiePMMLModel>

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	affinity
protected Object	entityId
protected List<KiePMMLOutputField>	kiePMMLOutputFields
protected List<KiePMMLTarget>	kiePMMLTargets
protected KiePMMLLocalTransformations	localTransformations
protected List<org.kie.pmml.api.models.MiningField>	miningFields
protected org.kie.pmml.api.enums.MINING_FUNCTION	miningFunction
protected List<org.kie.pmml.api.models.OutputField>	outputFields
protected Map<String,Object>	outputFieldsMap
protected org.kie.pmml.api.enums.PMML_MODEL	pmmlMODEL
protected Object	predictedDisplayValue
protected String	targetField
protected KiePMMLTransformationDictionary	transformationDictionary

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

extensions, id, name, parentId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KiePMMLModel(String name, List<KiePMMLExtension> extensions)

Method Summary

Modifier and Type	Method	Description
abstract Object	evaluate(Object knowledgeBase, Map<String,Object> requestData)
Object	getAffinity()
Object	getEntityId()
List<KiePMMLOutputField>	getKiePMMLOutputFields()
List<KiePMMLTarget>	getKiePMMLTargets()
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.
KiePMMLLocalTransformations	getLocalTransformations()
List<org.kie.pmml.api.models.MiningField>	getMiningFields()
org.kie.pmml.api.enums.MINING_FUNCTION	getMiningFunction()
List<org.kie.pmml.api.models.OutputField>	getOutputFields()
Map<String,Object>	getOutputFieldsMap()
org.kie.pmml.api.enums.PMML_MODEL	getPmmlMODEL()
Object	getPredictedDisplayValue()
Map<String,Double>	getProbabilityMap()
protected abstract LinkedHashMap<String,Double>	getProbabilityResultMap()	Returns the probability map evaluated by the model
String	getTargetField()
KiePMMLTransformationDictionary	getTransformationDictionary()
protected void	setAffinity(Object affinity)
protected void	setEntityId(Object entityId)
void	setKiePMMLTargets(List<KiePMMLTarget> kiePMMLTargets)
void	setMiningFields(List<org.kie.pmml.api.models.MiningField> miningFields)
void	setOutputFields(List<org.kie.pmml.api.models.OutputField> outputFields)
protected void	setPredictedDisplayValue(Object predictedDisplayValue)

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.api.models.PMMLModel

getName

Field Detail

pmmlMODEL

protected org.kie.pmml.api.enums.PMML_MODEL pmmlMODEL

miningFunction

protected org.kie.pmml.api.enums.MINING_FUNCTION miningFunction

targetField

protected String targetField

outputFieldsMap

protected Map<String,Object> outputFieldsMap

miningFields

protected List<org.kie.pmml.api.models.MiningField> miningFields

outputFields

protected List<org.kie.pmml.api.models.OutputField> outputFields

kiePMMLOutputFields

protected List<KiePMMLOutputField> kiePMMLOutputFields

kiePMMLTargets

protected List<KiePMMLTarget> kiePMMLTargets

transformationDictionary

protected KiePMMLTransformationDictionary transformationDictionary

localTransformations

protected KiePMMLLocalTransformations localTransformations

predictedDisplayValue

protected Object predictedDisplayValue

entityId

protected Object entityId

affinity

protected Object affinity

Constructor Detail

KiePMMLModel

protected KiePMMLModel(String name,
                       List<KiePMMLExtension> extensions)

Method Detail

getPmmlMODEL

public org.kie.pmml.api.enums.PMML_MODEL getPmmlMODEL()

getMiningFunction

public org.kie.pmml.api.enums.MINING_FUNCTION getMiningFunction()

getTargetField

public String getTargetField()

getOutputFieldsMap

public Map<String,Object> getOutputFieldsMap()

getKModulePackageName

public 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.

Returns:

getMiningFields

public List<org.kie.pmml.api.models.MiningField> getMiningFields()

Specified by:

getMiningFields in interface org.kie.pmml.api.models.PMMLModel

setMiningFields

public void setMiningFields(List<org.kie.pmml.api.models.MiningField> miningFields)

getOutputFields

public List<org.kie.pmml.api.models.OutputField> getOutputFields()

Specified by:

getOutputFields in interface org.kie.pmml.api.models.PMMLModel

setOutputFields

public void setOutputFields(List<org.kie.pmml.api.models.OutputField> outputFields)

getKiePMMLTargets

public List<KiePMMLTarget> getKiePMMLTargets()

setKiePMMLTargets

public void setKiePMMLTargets(List<KiePMMLTarget> kiePMMLTargets)

getKiePMMLOutputFields

public List<KiePMMLOutputField> getKiePMMLOutputFields()

getTransformationDictionary

public KiePMMLTransformationDictionary getTransformationDictionary()

getLocalTransformations

public KiePMMLLocalTransformations getLocalTransformations()

getProbabilityMap

public Map<String,Double> getProbabilityMap()

getPredictedDisplayValue

public Object getPredictedDisplayValue()

setPredictedDisplayValue

protected void setPredictedDisplayValue(Object predictedDisplayValue)

getEntityId

public Object getEntityId()

setEntityId

protected void setEntityId(Object entityId)

getAffinity

public Object getAffinity()

setAffinity

protected void setAffinity(Object affinity)

evaluate

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

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

requestData -

Returns:

getProbabilityResultMap

protected abstract LinkedHashMap<String,Double> getProbabilityResultMap()

Returns the probability map evaluated by the model

Returns: