org.jpmml.manager

Interface Consumer

All Superinterfaces:

Serializable

All Known Implementing Classes:

AssociationModelManager, MiningModelManager, ModelManager, NeuralNetworkManager, RegressionModelManager, RuleSetModelManager, ScorecardManager, TreeModelManager

public interface Consumer
extends Serializable

Method Summary

Methods

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

Method Detail

getSummary

String getSummary()

Returns a short description of the underlying Model

getDataField

DataField getDataField(FieldName name)

Gets the definition of a field from the DataDictionary.

See Also:

PMMLManager.getDataField(FieldName)

getActiveFields

List<FieldName> getActiveFields()

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

See Also:

ModelManager.getActiveFields()

getGroupFields

List<FieldName> getGroupFields()

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

See Also:

ModelManager.getGroupFields()

getTargetField

FieldName getTargetField()

Convenience method for retrieving the sole predicted field.

Returns:

The sole predicted field

Throws:

InvalidFeatureException - If the number of predicted fields is not exactly one

See Also:

ModelManager.getTargetField()

getPredictedFields

List<FieldName> getPredictedFields()

Gets the dependent (ie. output) field(s) of a Model from its MiningSchema.

See Also:

ModelManager.getPredictedFields()

getMiningField

MiningField getMiningField(FieldName name)

Gets the definition of a field from the MiningSchema.

See Also:

getActiveFields(), getPredictedFields(), ModelManager.getMiningField(FieldName)

getOutputFields

List<FieldName> getOutputFields()

Gets the output fields of a Model from its Output.

See Also:

ModelManager.getOutputFields()

getOutputField

OutputField getOutputField(FieldName name)

Gets the definition of a field from the Output

See Also:

getOutputFields()