Package org.dmg.pmml.clustering

Class ClusteringModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.clustering.ClusteringModel

All Implemented Interfaces:

java.io.Serializable, HasExtensions<ClusteringModel>, HasLocator, Visitable

public class ClusteringModel
extends Model
implements HasExtensions<ClusteringModel>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClusteringModel.ModelClass

Constructor Summary

Constructors

Constructor	Description
ClusteringModel()
ClusteringModel(MiningFunction miningFunction, ClusteringModel.ModelClass modelClass, java.lang.Integer numberOfClusters, MiningSchema miningSchema, ComparisonMeasure comparisonMeasure, java.util.List<ClusteringField> clusteringFields, java.util.List<Cluster> clusters)

Method Summary

Modifier and Type	Method	Description
VisitorAction	accept(Visitor visitor)
ClusteringModel	addClusteringFields(ClusteringField... clusteringFields)
ClusteringModel	addClusters(Cluster... clusters)
ClusteringModel	addExtensions(Extension... extensions)
java.lang.String	getAlgorithmName()
CenterFields	getCenterFields()
java.util.List<ClusteringField>	getClusteringFields()
java.util.List<Cluster>	getClusters()
ComparisonMeasure	getComparisonMeasure()
java.util.List<Extension>	getExtensions()
LocalTransformations	getLocalTransformations()
MathContext	getMathContext()
MiningFunction	getMiningFunction()
MiningSchema	getMiningSchema()
MissingValueWeights	getMissingValueWeights()
ClusteringModel.ModelClass	getModelClass()
ModelExplanation	getModelExplanation()
java.lang.String	getModelName()
ModelStats	getModelStats()
ModelVerification	getModelVerification()
java.lang.Integer	getNumberOfClusters()
Output	getOutput()
boolean	hasClusteringFields()
boolean	hasClusters()
boolean	hasExtensions()
boolean	isScorable()
java.util.List<ClusteringField>	requireClusteringFields()
java.util.List<Cluster>	requireClusters()
ComparisonMeasure	requireComparisonMeasure()
MiningFunction	requireMiningFunction()
MiningSchema	requireMiningSchema()
ClusteringModel.ModelClass	requireModelClass()
java.lang.Integer	requireNumberOfClusters()
ClusteringModel	setAlgorithmName(java.lang.String algorithmName)
ClusteringModel	setCenterFields(CenterFields centerFields)
ClusteringModel	setComparisonMeasure(ComparisonMeasure comparisonMeasure)
ClusteringModel	setLocalTransformations(LocalTransformations localTransformations)
ClusteringModel	setMathContext(MathContext mathContext)
ClusteringModel	setMiningFunction(MiningFunction miningFunction)
ClusteringModel	setMiningSchema(MiningSchema miningSchema)
ClusteringModel	setMissingValueWeights(MissingValueWeights missingValueWeights)
ClusteringModel	setModelClass(ClusteringModel.ModelClass modelClass)
ClusteringModel	setModelExplanation(ModelExplanation modelExplanation)
ClusteringModel	setModelName(java.lang.String modelName)
ClusteringModel	setModelStats(ModelStats modelStats)
ClusteringModel	setModelVerification(ModelVerification modelVerification)
ClusteringModel	setNumberOfClusters(java.lang.Integer numberOfClusters)
ClusteringModel	setOutput(Output output)
ClusteringModel	setScorable(java.lang.Boolean scorable)

Methods inherited from class org.dmg.pmml.Model

getTargets, setTargets

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, getSchemaVersion, getSchemaVersion, hasLocator, setLocator

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusteringModel

public ClusteringModel()

ClusteringModel

public ClusteringModel(MiningFunction miningFunction,
                       ClusteringModel.ModelClass modelClass,
                       java.lang.Integer numberOfClusters,
                       MiningSchema miningSchema,
                       ComparisonMeasure comparisonMeasure,
                       java.util.List<ClusteringField> clusteringFields,
                       java.util.List<Cluster> clusters)

Method Detail

getModelName

public java.lang.String getModelName()

Specified by:

getModelName in class Model

setModelName

public ClusteringModel setModelName(java.lang.String modelName)

Specified by:

setModelName in class Model

requireMiningFunction

public MiningFunction requireMiningFunction()

Specified by:

requireMiningFunction in class Model

getMiningFunction

public MiningFunction getMiningFunction()

Specified by:

getMiningFunction in class Model

setMiningFunction

public ClusteringModel setMiningFunction(MiningFunction miningFunction)

Specified by:

setMiningFunction in class Model

getAlgorithmName

public java.lang.String getAlgorithmName()

Specified by:

getAlgorithmName in class Model

setAlgorithmName

public ClusteringModel setAlgorithmName(java.lang.String algorithmName)

Specified by:

setAlgorithmName in class Model

requireModelClass

public ClusteringModel.ModelClass requireModelClass()

getModelClass

public ClusteringModel.ModelClass getModelClass()

setModelClass

public ClusteringModel setModelClass(ClusteringModel.ModelClass modelClass)

requireNumberOfClusters

public java.lang.Integer requireNumberOfClusters()

getNumberOfClusters

public java.lang.Integer getNumberOfClusters()

setNumberOfClusters

public ClusteringModel setNumberOfClusters(java.lang.Integer numberOfClusters)

isScorable

public boolean isScorable()

Specified by:

isScorable in class Model

setScorable

public ClusteringModel setScorable(java.lang.Boolean scorable)

Specified by:

setScorable in class Model

getMathContext

public MathContext getMathContext()

Specified by:

getMathContext in class Model

setMathContext

public ClusteringModel setMathContext(MathContext mathContext)

Specified by:

setMathContext in class Model

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions<ClusteringModel>

getExtensions

public java.util.List<Extension> getExtensions()

Specified by:

getExtensions in interface HasExtensions<ClusteringModel>

addExtensions

public ClusteringModel addExtensions(Extension... extensions)

Specified by:

addExtensions in interface HasExtensions<ClusteringModel>

requireMiningSchema

public MiningSchema requireMiningSchema()

Specified by:

requireMiningSchema in class Model

getMiningSchema

public MiningSchema getMiningSchema()

Specified by:

getMiningSchema in class Model

setMiningSchema

public ClusteringModel setMiningSchema(MiningSchema miningSchema)

Specified by:

setMiningSchema in class Model

getOutput

public Output getOutput()

Overrides:

getOutput in class Model

setOutput

public ClusteringModel setOutput(Output output)

Overrides:

setOutput in class Model

getModelStats

public ModelStats getModelStats()

Overrides:

getModelStats in class Model

setModelStats

public ClusteringModel setModelStats(ModelStats modelStats)

Overrides:

setModelStats in class Model

getModelExplanation

public ModelExplanation getModelExplanation()

Overrides:

getModelExplanation in class Model

setModelExplanation

public ClusteringModel setModelExplanation(ModelExplanation modelExplanation)

Overrides:

setModelExplanation in class Model

getLocalTransformations

public LocalTransformations getLocalTransformations()

Specified by:

getLocalTransformations in class Model

setLocalTransformations

public ClusteringModel setLocalTransformations(LocalTransformations localTransformations)

Specified by:

setLocalTransformations in class Model

requireComparisonMeasure

public ComparisonMeasure requireComparisonMeasure()

getComparisonMeasure

public ComparisonMeasure getComparisonMeasure()

setComparisonMeasure

public ClusteringModel setComparisonMeasure(ComparisonMeasure comparisonMeasure)

hasClusteringFields

public boolean hasClusteringFields()

requireClusteringFields

public java.util.List<ClusteringField> requireClusteringFields()

getClusteringFields

public java.util.List<ClusteringField> getClusteringFields()

addClusteringFields

public ClusteringModel addClusteringFields(ClusteringField... clusteringFields)

getCenterFields

public CenterFields getCenterFields()

setCenterFields

public ClusteringModel setCenterFields(CenterFields centerFields)

getMissingValueWeights

public MissingValueWeights getMissingValueWeights()

setMissingValueWeights

public ClusteringModel setMissingValueWeights(MissingValueWeights missingValueWeights)

hasClusters

public boolean hasClusters()

requireClusters

public java.util.List<Cluster> requireClusters()

getClusters

public java.util.List<Cluster> getClusters()

addClusters

public ClusteringModel addClusters(Cluster... clusters)

getModelVerification

public ModelVerification getModelVerification()

Overrides:

getModelVerification in class Model

setModelVerification

public ClusteringModel setModelVerification(ModelVerification modelVerification)

Overrides:

setModelVerification in class Model

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable