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, KiePMMLModelWithSources

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 List<KiePMMLMiningField>	kiePMMLMiningFields
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 org.kie.pmml.api.enums.PMML_MODEL	pmmlMODEL
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, org.kie.pmml.api.runtime.PMMLContext context)
List<KiePMMLMiningField>	getKiePMMLMiningFields()
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()
org.kie.pmml.api.enums.PMML_MODEL	getPmmlMODEL()
String	getTargetField()
KiePMMLTransformationDictionary	getTransformationDictionary()

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

miningFields

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

outputFields

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

kiePMMLMiningFields

protected List<KiePMMLMiningField> kiePMMLMiningFields

kiePMMLOutputFields

protected List<KiePMMLOutputField> kiePMMLOutputFields

kiePMMLTargets

protected List<KiePMMLTarget> kiePMMLTargets

transformationDictionary

protected KiePMMLTransformationDictionary transformationDictionary

localTransformations

protected KiePMMLLocalTransformations localTransformations

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()

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

getOutputFields

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

Specified by:

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

getKiePMMLTargets

public List<KiePMMLTarget> getKiePMMLTargets()

getKiePMMLMiningFields

public List<KiePMMLMiningField> getKiePMMLMiningFields()

getKiePMMLOutputFields

public List<KiePMMLOutputField> getKiePMMLOutputFields()

getTransformationDictionary

public KiePMMLTransformationDictionary getTransformationDictionary()

getLocalTransformations

public KiePMMLLocalTransformations getLocalTransformations()

evaluate

public abstract Object evaluate(Object knowledgeBase,
                                Map<String,Object> requestData,
                                org.kie.pmml.api.runtime.PMMLContext context)

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 -

context - used to accumulate additional evaluated values

Returns: