org.jpmml.manager

Class ModelManager<M extends org.dmg.pmml.Model>

java.lang.Object

org.jpmml.manager.PMMLManager

org.jpmml.manager.ModelManager<M>

All Implemented Interfaces:

java.io.Serializable, Consumer

public class ModelManager<M extends org.dmg.pmml.Model>
extends PMMLManager
implements Consumer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ModelManager(org.dmg.pmml.PMML pmml, M model)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<org.dmg.pmml.FieldName>	getActiveFields() Gets the independent (ie.
java.util.List<org.dmg.pmml.FieldName>	getGroupFields() Gets the grouping fields of a Model from its MiningSchema.
org.dmg.pmml.DerivedField	getLocalDerivedField(org.dmg.pmml.FieldName name)
org.dmg.pmml.MiningField	getMiningField(org.dmg.pmml.FieldName name) Gets the definition of a field from the MiningSchema.
org.dmg.pmml.MiningSchema	getMiningSchema()
M	getModel()
org.dmg.pmml.LocalTransformations	getOrCreateLocalTransformations()
org.dmg.pmml.Output	getOrCreateOutput()
org.dmg.pmml.Targets	getOrCreateTargets()
org.dmg.pmml.OutputField	getOutputField(org.dmg.pmml.FieldName name) Gets the definition of a field from the Output
java.util.List<org.dmg.pmml.FieldName>	getOutputFields() Gets the output fields of a Model from its Output.
java.lang.String	getSummary() Returns a short description of the underlying Model
org.dmg.pmml.Target	getTarget(org.dmg.pmml.FieldName name)
org.dmg.pmml.FieldName	getTargetField() Convenience method for retrieving the sole target field.
java.util.List<org.dmg.pmml.FieldName>	getTargetFields() Gets the dependent (ie.
org.dmg.pmml.DerivedField	resolveDerivedField(org.dmg.pmml.FieldName name)

Methods inherited from class org.jpmml.manager.PMMLManager

find, find, findAll, getDataDictionary, getDataField, getDerivedField, getFunction, getHeader, getModel, getModelManager, getModels, getOrCreateTransformationDictionary, getPMML

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jpmml.manager.Consumer

getDataField

Constructor Detail

ModelManager

public ModelManager(org.dmg.pmml.PMML pmml,
            M model)

Method Detail

getModel

public M getModel()

getSummary

public java.lang.String getSummary()

Description copied from interface: Consumer

Returns a short description of the underlying Model

Specified by:

getSummary in interface Consumer

getActiveFields

public java.util.List<org.dmg.pmml.FieldName> getActiveFields()

Description copied from interface: Consumer

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

Specified by:

getActiveFields in interface Consumer

getGroupFields

public java.util.List<org.dmg.pmml.FieldName> getGroupFields()

Description copied from interface: Consumer

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

Specified by:

getGroupFields in interface Consumer

getTargetFields

public java.util.List<org.dmg.pmml.FieldName> getTargetFields()

Description copied from interface: Consumer

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

Specified by:

getTargetFields in interface Consumer

getTargetField

public org.dmg.pmml.FieldName getTargetField()

Description copied from interface: Consumer

Convenience method for retrieving the sole target field.

Specified by:

getTargetField in interface Consumer

Returns:

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

See Also:

Consumer.getTargetFields()

getMiningField

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

Description copied from interface: Consumer

Gets the definition of a field from the MiningSchema.

Specified by:

getMiningField in interface Consumer

See Also:

Consumer.getActiveFields(), Consumer.getGroupFields(), Consumer.getTargetFields()

getLocalDerivedField

public org.dmg.pmml.DerivedField getLocalDerivedField(org.dmg.pmml.FieldName name)

resolveDerivedField

public org.dmg.pmml.DerivedField resolveDerivedField(org.dmg.pmml.FieldName name)

getOutputField

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

Description copied from interface: Consumer

Gets the definition of a field from the Output

Specified by:

getOutputField in interface Consumer

See Also:

Consumer.getOutputFields()

getOutputFields

public java.util.List<org.dmg.pmml.FieldName> getOutputFields()

Description copied from interface: Consumer

Gets the output fields of a Model from its Output.

Specified by:

getOutputFields in interface Consumer

getTarget

public org.dmg.pmml.Target getTarget(org.dmg.pmml.FieldName name)

getMiningSchema

public org.dmg.pmml.MiningSchema getMiningSchema()

getOrCreateLocalTransformations

public org.dmg.pmml.LocalTransformations getOrCreateLocalTransformations()

getOrCreateOutput

public org.dmg.pmml.Output getOrCreateOutput()

getOrCreateTargets

public org.dmg.pmml.Targets getOrCreateTargets()