org.kie.pmml.compiler.commons.utils

Class ModelUtils

java.lang.Object

org.kie.pmml.compiler.commons.utils.ModelUtils

public class ModelUtils
extends Object

Class to provide common methods to interact with Model, to convert org.dmn.pmml objects to Kie ones, etc...

Method Summary

Modifier and Type	Method and Description
static org.kie.pmml.api.models.MiningField	convertToKieMiningField(org.dmg.pmml.MiningField toConvert, org.dmg.pmml.DataField dataField) Return a org.kie.pmml.api.models.MiningField out of a org.dmg.pmml.MiningField and relative org.dmg.pmml.DataField ones
static List<org.kie.pmml.api.models.MiningField>	convertToKieMiningFieldList(org.dmg.pmml.MiningSchema toConvert, org.dmg.pmml.DataDictionary dataDictionary) Return a List<org.kie.pmml.api.models.MiningField&glt; out of a org.dmg.pmml .MiningSchema one
static org.kie.pmml.api.models.OutputField	convertToKieOutputField(org.dmg.pmml.OutputField toConvert, org.dmg.pmml.DataField dataField) Return a org.kie.pmml.api.models.OutputField out of a org.dmg.pmml.OutputField one
static List<org.kie.pmml.api.models.OutputField>	convertToKieOutputFieldList(org.dmg.pmml.Output toConvert, org.dmg.pmml.DataDictionary dataDictionary) Return a List<org.kie.pmml.api.models.OutputField> out of a org.dmg.pmml .Output one
static org.kie.pmml.commons.model.expressions.KiePMMLApply	convertToKiePMMLApply(org.dmg.pmml.Apply toConvert)
static org.kie.pmml.commons.model.expressions.KiePMMLConstant	convertToKiePMMLConstant(org.dmg.pmml.Constant toConvert)
static org.kie.pmml.commons.model.expressions.KiePMMLExpression	convertToKiePMMLExpression(org.dmg.pmml.Expression toConvert)
static List<org.kie.pmml.commons.model.expressions.KiePMMLExpression>	convertToKiePMMLExpressions(List<org.dmg.pmml.Expression> toConvert)
static org.kie.pmml.commons.model.expressions.KiePMMLFieldRef	convertToKiePMMLFieldRef(org.dmg.pmml.FieldRef toConvert)
static org.kie.pmml.commons.model.KiePMMLOutputField	convertToKiePMMLOutputField(org.dmg.pmml.OutputField toConvert) Return a org.kie.pmml.commons.model.KiePMMLOutputField out of a org.dmg.pmml .OutputField
static List<org.kie.pmml.commons.model.KiePMMLOutputField>	convertToKiePMMLOutputFieldList(org.dmg.pmml.Output toConvert) Return a List<org.kie.pmml.commons.model.KiePMMLOutputField> out of a org.dmg.pmml .Output
static org.kie.pmml.commons.model.KiePMMLTarget	convertToKiePMMLTarget(org.dmg.pmml.Target toConvert) Return a org.kie.pmml.commons.model.KiePMMLTarget out of a org.dmg.pmml.Target
static List<org.kie.pmml.commons.model.KiePMMLTarget>	convertToKiePMMLTargetList(org.dmg.pmml.Targets toConvert) Return a List<org.kie.pmml.commons.model.KiePMMLTarget> out of a org.dmg.pmml .Targets
static org.kie.pmml.commons.model.KiePMMLTargetValue	convertToKiePMMLTargetValue(org.dmg.pmml.TargetValue toConvert) Return a org.kie.pmml.commons.model.KiePMMLTargetValue out of a org.dmg.pmml .TargetValue
static List<org.kie.pmml.commons.model.KiePMMLTargetValue>	convertToKiePMMLTargetValueList(List<org.dmg.pmml.TargetValue> toConvert) Return a List<org.kie.pmml.commons.model.KiePMMLTargetValue> out of a List<org.dmg.pmml.TargetValue>
static String	getBoxedClassName(org.dmg.pmml.DataType dataType) Retrieve the mapped class name of the given DataType, eventually boxed (for primitive ones).
static String	getBoxedClassName(org.dmg.pmml.ParameterField parameterField) Retrieve the mapped class name of the given ParameterField, eventually boxed (for primitive ones) It returns Object ParameterField.getDataType() is null
static org.kie.pmml.api.enums.DATA_TYPE	getDataType(org.dmg.pmml.DataDictionary dataDictionary, String targetFieldName) DATA_TYPE of the given field
static org.dmg.pmml.DataType	getDataType(List<org.dmg.pmml.DerivedField> derivedFields, org.dmg.pmml.DataDictionary dataDictionary, String fieldName) DataType of the given field, first looked upon derivedFields and then in dataDictionary
static List<org.dmg.pmml.DerivedField>	getDerivedFields(org.dmg.pmml.TransformationDictionary transformationDictionary, org.dmg.pmml.LocalTransformations localTransformations) Return List<DerivedField>s from the given TransformationDictionary and LocalTransformations
static org.kie.pmml.api.enums.OP_TYPE	getOpType(org.dmg.pmml.DataDictionary dataDictionary, org.dmg.pmml.Model model, String targetFieldName) OP_TYPE may be defined inside DataField, MiningField or both.
static Optional<org.kie.pmml.api.enums.OP_TYPE>	getOpTypeFromDataDictionary(org.dmg.pmml.DataDictionary dataDictionary, String fieldName) Return Optional<OP_TYPE> of field with given fieldName from DataDictionary
static Optional<org.kie.pmml.api.enums.OP_TYPE>	getOpTypeFromMiningFields(org.dmg.pmml.MiningSchema miningSchema, String fieldName) Return Optional<OP_TYPE> of field with given fieldName from MiningSchema
static Optional<org.kie.pmml.api.enums.OP_TYPE>	getOpTypeFromTargets(org.dmg.pmml.Targets targets, String fieldName) Return Optional<OP_TYPE> of field with given fieldName from Targets
static Optional<String>	getTargetFieldName(org.dmg.pmml.DataDictionary dataDictionary, org.dmg.pmml.Model model) Return an Optional with the name of the field whose usageType is TARGET or PREDICTED While the xsd schema does not strictly enforce this, it seems that by convention majority of models has only one target.
static List<org.kie.pmml.commons.model.tuples.KiePMMLNameOpType>	getTargetFields(org.dmg.pmml.DataDictionary dataDictionary, org.dmg.pmml.Model model) Return a List<KiePMMLNameOpType> of target fields Please note that only predicted/target MiningField are considered.
static Map<String,org.kie.pmml.api.enums.DATA_TYPE>	getTargetFieldsTypeMap(org.dmg.pmml.DataDictionary dataDictionary, org.dmg.pmml.Model model) Returns a Map<String, DATA_TYPE> of target fields, where the key is the name of the field, and the value is the type of the field Please note that only predicted/target MiningField are considered.
static org.kie.pmml.api.enums.DATA_TYPE	getTargetFieldType(org.dmg.pmml.DataDictionary dataDictionary, org.dmg.pmml.Model model) Return the DATA_TYPE> of the field whose usageType is TARGET or PREDICTED.

Methods inherited from class java.lang.Object

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

Method Detail

getTargetFieldName

public static Optional<String> getTargetFieldName(org.dmg.pmml.DataDictionary dataDictionary,
                                                  org.dmg.pmml.Model model)

Return an Optional with the name of the field whose usageType is TARGET or PREDICTED

While the xsd schema does not strictly enforce this, it seems that by convention majority of models has only one target.

(see https://github.com/jpmml/jpmml-evaluator/issues/64 discussion)

Parameters:

model -

Returns:

getTargetFieldType

public static org.kie.pmml.api.enums.DATA_TYPE getTargetFieldType(org.dmg.pmml.DataDictionary dataDictionary,
                                                                  org.dmg.pmml.Model model)

Return the DATA_TYPE> of the field whose usageType is TARGET or PREDICTED. It throws exception if none of such fields are found

While the xsd schema does not strictly enforce this, it seems that by convention majority of models has only one target.

(see https://github.com/jpmml/jpmml-evaluator/issues/64 discussion)

Parameters:

dataDictionary -

model -

Returns:

getTargetFields

public static List<org.kie.pmml.commons.model.tuples.KiePMMLNameOpType> getTargetFields(org.dmg.pmml.DataDictionary dataDictionary,
                                                                                        org.dmg.pmml.Model model)

Return a List<KiePMMLNameOpType> of target fields Please note that only predicted/target MiningField are considered.

Parameters:

dataDictionary -

model -

Returns:

getTargetFieldsTypeMap

public static Map<String,org.kie.pmml.api.enums.DATA_TYPE> getTargetFieldsTypeMap(org.dmg.pmml.DataDictionary dataDictionary,
                                                                                  org.dmg.pmml.Model model)

Returns a Map<String, DATA_TYPE> of target fields, where the key is the name of the field, and the value is the type of the field Please note that only predicted/target MiningField are considered.

Parameters:

dataDictionary -

model -

Returns:

getOpType

public static org.kie.pmml.api.enums.OP_TYPE getOpType(org.dmg.pmml.DataDictionary dataDictionary,
                                                       org.dmg.pmml.Model model,
                                                       String targetFieldName)

OP_TYPE may be defined inside DataField, MiningField or both. In the latter case, MiningField override DataField definition

Parameters:

dataDictionary -

model -

targetFieldName -

Returns:

getOpTypeFromDataDictionary

public static Optional<org.kie.pmml.api.enums.OP_TYPE> getOpTypeFromDataDictionary(org.dmg.pmml.DataDictionary dataDictionary,
                                                                                   String fieldName)

Return Optional<OP_TYPE> of field with given fieldName from DataDictionary

Parameters:

dataDictionary -

fieldName -

Returns:

getOpTypeFromMiningFields

public static Optional<org.kie.pmml.api.enums.OP_TYPE> getOpTypeFromMiningFields(org.dmg.pmml.MiningSchema miningSchema,
                                                                                 String fieldName)

Return Optional<OP_TYPE> of field with given fieldName from MiningSchema

Parameters:

miningSchema -

fieldName -

Returns:

getOpTypeFromTargets

public static Optional<org.kie.pmml.api.enums.OP_TYPE> getOpTypeFromTargets(org.dmg.pmml.Targets targets,
                                                                            String fieldName)

Return Optional<OP_TYPE> of field with given fieldName from Targets

Parameters:

targets -

fieldName -

Returns:

getDataType

public static org.dmg.pmml.DataType getDataType(List<org.dmg.pmml.DerivedField> derivedFields,
                                                org.dmg.pmml.DataDictionary dataDictionary,
                                                String fieldName)

DataType of the given field, first looked upon derivedFields and then in dataDictionary

Parameters:

derivedFields -

dataDictionary -

fieldName -

Returns:

getDataType

public static org.kie.pmml.api.enums.DATA_TYPE getDataType(org.dmg.pmml.DataDictionary dataDictionary,
                                                           String targetFieldName)

DATA_TYPE of the given field

Parameters:

dataDictionary -

targetFieldName -

Returns:

getDerivedFields

public static List<org.dmg.pmml.DerivedField> getDerivedFields(org.dmg.pmml.TransformationDictionary transformationDictionary,
                                                               org.dmg.pmml.LocalTransformations localTransformations)

Return List<DerivedField>s from the given TransformationDictionary and LocalTransformations

Parameters:

transformationDictionary -

localTransformations -

Returns:

convertToKieMiningFieldList

public static List<org.kie.pmml.api.models.MiningField> convertToKieMiningFieldList(org.dmg.pmml.MiningSchema toConvert,
                                                                                    org.dmg.pmml.DataDictionary dataDictionary)

Return a List<org.kie.pmml.api.models.MiningField&glt; out of a org.dmg.pmml .MiningSchema one

Parameters:

toConvert -

dataDictionary -

Returns:

convertToKieMiningField

public static org.kie.pmml.api.models.MiningField convertToKieMiningField(org.dmg.pmml.MiningField toConvert,
                                                                          org.dmg.pmml.DataField dataField)

Return a org.kie.pmml.api.models.MiningField out of a org.dmg.pmml.MiningField and relative org.dmg.pmml.DataField ones

Parameters:

toConvert -

dataField -

Returns:

convertToKieOutputFieldList

public static List<org.kie.pmml.api.models.OutputField> convertToKieOutputFieldList(org.dmg.pmml.Output toConvert,
                                                                                    org.dmg.pmml.DataDictionary dataDictionary)

Return a List<org.kie.pmml.api.models.OutputField> out of a org.dmg.pmml .Output one

Parameters:

toConvert -

Returns:

convertToKieOutputField

public static org.kie.pmml.api.models.OutputField convertToKieOutputField(org.dmg.pmml.OutputField toConvert,
                                                                          org.dmg.pmml.DataField dataField)

Return a org.kie.pmml.api.models.OutputField out of a org.dmg.pmml.OutputField one

Parameters:

toConvert -

dataField - - this may be null

Returns:

convertToKiePMMLOutputFieldList

public static List<org.kie.pmml.commons.model.KiePMMLOutputField> convertToKiePMMLOutputFieldList(org.dmg.pmml.Output toConvert)

Return a List<org.kie.pmml.commons.model.KiePMMLOutputField> out of a org.dmg.pmml .Output

Parameters:

toConvert -

Returns:

convertToKiePMMLOutputField

public static org.kie.pmml.commons.model.KiePMMLOutputField convertToKiePMMLOutputField(org.dmg.pmml.OutputField toConvert)

Return a org.kie.pmml.commons.model.KiePMMLOutputField out of a org.dmg.pmml .OutputField

Parameters:

toConvert -

Returns:

convertToKiePMMLExpressions

public static List<org.kie.pmml.commons.model.expressions.KiePMMLExpression> convertToKiePMMLExpressions(List<org.dmg.pmml.Expression> toConvert)

convertToKiePMMLExpression

public static org.kie.pmml.commons.model.expressions.KiePMMLExpression convertToKiePMMLExpression(org.dmg.pmml.Expression toConvert)

convertToKiePMMLApply

public static org.kie.pmml.commons.model.expressions.KiePMMLApply convertToKiePMMLApply(org.dmg.pmml.Apply toConvert)

convertToKiePMMLConstant

public static org.kie.pmml.commons.model.expressions.KiePMMLConstant convertToKiePMMLConstant(org.dmg.pmml.Constant toConvert)

convertToKiePMMLFieldRef

public static org.kie.pmml.commons.model.expressions.KiePMMLFieldRef convertToKiePMMLFieldRef(org.dmg.pmml.FieldRef toConvert)

convertToKiePMMLTargetList

public static List<org.kie.pmml.commons.model.KiePMMLTarget> convertToKiePMMLTargetList(org.dmg.pmml.Targets toConvert)

Return a List<org.kie.pmml.commons.model.KiePMMLTarget> out of a org.dmg.pmml .Targets

Parameters:

toConvert -

Returns:

convertToKiePMMLTarget

public static org.kie.pmml.commons.model.KiePMMLTarget convertToKiePMMLTarget(org.dmg.pmml.Target toConvert)

Return a org.kie.pmml.commons.model.KiePMMLTarget out of a org.dmg.pmml.Target

Parameters:

toConvert -

Returns:

convertToKiePMMLTargetValueList

public static List<org.kie.pmml.commons.model.KiePMMLTargetValue> convertToKiePMMLTargetValueList(List<org.dmg.pmml.TargetValue> toConvert)

Return a List<org.kie.pmml.commons.model.KiePMMLTargetValue> out of a List<org.dmg.pmml.TargetValue>

Parameters:

toConvert -

Returns:

convertToKiePMMLTargetValue

public static org.kie.pmml.commons.model.KiePMMLTargetValue convertToKiePMMLTargetValue(org.dmg.pmml.TargetValue toConvert)

Return a org.kie.pmml.commons.model.KiePMMLTargetValue out of a org.dmg.pmml .TargetValue

Parameters:

toConvert -

Returns:

getBoxedClassName

public static String getBoxedClassName(org.dmg.pmml.ParameterField parameterField)

Retrieve the mapped class name of the given ParameterField, eventually boxed (for primitive ones) It returns Object ParameterField.getDataType() is null

Parameters:

parameterField -

Returns:

getBoxedClassName

public static String getBoxedClassName(org.dmg.pmml.DataType dataType)

Retrieve the mapped class name of the given DataType, eventually boxed (for primitive ones). It returns Object if null

Parameters:

dataType -

Returns: