Package org.kie.pmml.compiler.api.utils

Class ModelUtils

java.lang.Object

org.kie.pmml.compiler.api.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	Description
static org.kie.pmml.api.models.MiningField	convertToKieMiningField(org.dmg.pmml.MiningField toConvert, org.dmg.pmml.Field<?> field)	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, List<org.dmg.pmml.Field<?>> fields)	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.Field<?> field)	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, List<org.dmg.pmml.Field<?>> fields)	Return a List<org.kie.pmml.api.models.OutputField> out of a org.dmg.pmml .Output one
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	getDATA_TYPE(List<org.dmg.pmml.Field<?>> fields, String fieldName)	DATA_TYPE of the given field
static org.dmg.pmml.DataType	getDataType(List<org.dmg.pmml.Field<?>> fields, 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 List<org.dmg.pmml.Field<?>>	getFieldsFromDataDictionaryAndTransformationDictionary(org.dmg.pmml.DataDictionary dataDictionary, org.dmg.pmml.TransformationDictionary transformationDictionary)
static List<org.dmg.pmml.Field<?>>	getFieldsFromDataDictionaryTransformationDictionaryAndModel(org.dmg.pmml.DataDictionary dataDictionary, org.dmg.pmml.TransformationDictionary transformationDictionary, org.dmg.pmml.Model model)
static List<Object>	getObjectsFromArray(org.dmg.pmml.Array source)
static org.kie.pmml.api.enums.OP_TYPE	getOpType(List<org.dmg.pmml.Field<?>> fields, 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>	getOpTypeFromFields(List<org.dmg.pmml.Field<?>> fields, 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(List<org.dmg.pmml.Field<?>> fields, org.dmg.pmml.Model model)	Return an Optional with the name of the field whose usageType is TARGET or PREDICTED
static List<org.kie.pmml.commons.model.tuples.KiePMMLNameOpType>	getTargetFields(List<org.dmg.pmml.Field<?>> fields, 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(List<org.dmg.pmml.Field<?>> fields, 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(List<org.dmg.pmml.Field<?>> fields, 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(List<org.dmg.pmml.Field<?>> fields,
                                                  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:

fields -

model -

Returns:

getTargetFieldType

public static org.kie.pmml.api.enums.DATA_TYPE getTargetFieldType(List<org.dmg.pmml.Field<?>> fields,
                                                                  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:

fields -

model -

Returns:

getTargetFields

public static List<org.kie.pmml.commons.model.tuples.KiePMMLNameOpType> getTargetFields(List<org.dmg.pmml.Field<?>> fields,
                                                                                        org.dmg.pmml.Model model)

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

Parameters:

fields -

model -

Returns:

getTargetFieldsTypeMap

public static Map<String,org.kie.pmml.api.enums.DATA_TYPE> getTargetFieldsTypeMap(List<org.dmg.pmml.Field<?>> fields,
                                                                                        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:

fields -

model -

Returns:

getOpType

public static org.kie.pmml.api.enums.OP_TYPE getOpType(List<org.dmg.pmml.Field<?>> fields,
                                                       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:

fields -

model -

targetFieldName -

Returns:

getOpTypeFromFields

public static Optional<org.kie.pmml.api.enums.OP_TYPE> getOpTypeFromFields(List<org.dmg.pmml.Field<?>> fields,
                                                                           String fieldName)

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

Parameters:

fields -

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.Field<?>> fields,
                                                String fieldName)

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

Parameters:

fields -

fieldName -

Returns:

getDATA_TYPE

public static org.kie.pmml.api.enums.DATA_TYPE getDATA_TYPE(List<org.dmg.pmml.Field<?>> fields,
                                                            String fieldName)

DATA_TYPE of the given field

Parameters:

fields -

fieldName -

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:

getObjectsFromArray

public static List<Object> getObjectsFromArray(org.dmg.pmml.Array source)

convertToKieMiningFieldList

public static List<org.kie.pmml.api.models.MiningField> convertToKieMiningFieldList(org.dmg.pmml.MiningSchema toConvert,
                                                                                    List<org.dmg.pmml.Field<?>> fields)

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

Parameters:

toConvert -

fields -

Returns:

convertToKieMiningField

public static org.kie.pmml.api.models.MiningField convertToKieMiningField(org.dmg.pmml.MiningField toConvert,
                                                                          org.dmg.pmml.Field<?> field)

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

Parameters:

toConvert -

field -

Returns:

convertToKieOutputFieldList

public static List<org.kie.pmml.api.models.OutputField> convertToKieOutputFieldList(org.dmg.pmml.Output toConvert,
                                                                                    List<org.dmg.pmml.Field<?>> fields)

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.Field<?> field)

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

Parameters:

toConvert -

field - - this may be null

Returns:

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:

getFieldsFromDataDictionaryAndTransformationDictionary

public static List<org.dmg.pmml.Field<?>> getFieldsFromDataDictionaryAndTransformationDictionary(org.dmg.pmml.DataDictionary dataDictionary,
                                                                                                 org.dmg.pmml.TransformationDictionary transformationDictionary)

getFieldsFromDataDictionaryTransformationDictionaryAndModel

public static List<org.dmg.pmml.Field<?>> getFieldsFromDataDictionaryTransformationDictionaryAndModel(org.dmg.pmml.DataDictionary dataDictionary,
                                                                                                      org.dmg.pmml.TransformationDictionary transformationDictionary,
                                                                                                      org.dmg.pmml.Model model)