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

Method Summary

Modifier and Type	Method and Description
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.commons.model.enums.DATA_TYPE	getDataType(org.dmg.pmml.DataDictionary dataDictionary, String targetFieldName) DATA_TYPE of the given field
static org.kie.pmml.commons.model.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<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
static Map<String,org.kie.pmml.commons.model.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
static org.kie.pmml.commons.model.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.commons.model.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

Parameters:

dataDictionary -

model -

Returns:

getTargetFieldsTypeMap

public static Map<String,org.kie.pmml.commons.model.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

Parameters:

dataDictionary -

model -

Returns:

getOpType

public static org.kie.pmml.commons.model.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:

getDataType

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

DATA_TYPE of the given field

Parameters:

dataDictionary -

targetFieldName -

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: