org.jpmml.manager

Interface Consumer

All Superinterfaces:

Serializable

All Known Implementing Classes:

ModelManager

public interface Consumer
extends Serializable

Method Summary

Methods

Modifier and Type	Method and Description
List<org.dmg.pmml.FieldName>	getActiveFields() Gets the independent (ie.
org.dmg.pmml.DataField	getDataField(org.dmg.pmml.FieldName name) Gets the definition of a field from the DataDictionary.
List<org.dmg.pmml.FieldName>	getGroupFields() Gets the grouping fields of a Model from its MiningSchema.
org.dmg.pmml.MiningField	getMiningField(org.dmg.pmml.FieldName name) Gets the definition of a field from the MiningSchema.
org.dmg.pmml.OutputField	getOutputField(org.dmg.pmml.FieldName name) Gets the definition of a field from the Output
List<org.dmg.pmml.FieldName>	getOutputFields() Gets the output fields of a Model from its Output.
String	getSummary() Returns a short description of the underlying Model
org.dmg.pmml.FieldName	getTargetField() Convenience method for retrieving the sole target field.
List<org.dmg.pmml.FieldName>	getTargetFields() Gets the dependent (ie.

Method Detail

getSummary

String getSummary()

Returns a short description of the underlying Model

getDataField

org.dmg.pmml.DataField getDataField(org.dmg.pmml.FieldName name)

Gets the definition of a field from the DataDictionary.

getActiveFields

List<org.dmg.pmml.FieldName> getActiveFields()

Gets the independent (ie. input) fields of a Model from its MiningSchema.

getGroupFields

List<org.dmg.pmml.FieldName> getGroupFields()

Gets the grouping fields of a Model from its MiningSchema. A model should have no more than 1 grouping field.

getTargetFields

List<org.dmg.pmml.FieldName> getTargetFields()

Gets the dependent (ie. target in supervised training) field(s) of a Model from its MiningSchema.

getTargetField

org.dmg.pmml.FieldName getTargetField()

Convenience method for retrieving the sole target field.

Returns:

The sole target field, or null if it does not exist

Throws:

InvalidFeatureException - If the number of target fields is not exactly one.

See Also:

getTargetFields()

getMiningField

org.dmg.pmml.MiningField getMiningField(org.dmg.pmml.FieldName name)

Gets the definition of a field from the MiningSchema.

See Also:

getActiveFields(), getGroupFields(), getTargetFields()

getOutputField

org.dmg.pmml.OutputField getOutputField(org.dmg.pmml.FieldName name)

Gets the definition of a field from the Output

See Also:

getOutputFields()

getOutputFields

List<org.dmg.pmml.FieldName> getOutputFields()

Gets the output fields of a Model from its Output.