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:

Serializable, HasExtensions, HasLocator, Visitable

public class ClusteringModel
extends Model
implements HasExtensions

Java class for anonymous complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://www.dmg.org/PMML-4_3}Extension" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}MiningSchema"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Output" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelExplanation" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ComparisonMeasure"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ClusteringField" maxOccurs="unbounded"/>
         <element ref="{http://www.dmg.org/PMML-4_3}CenterFields" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}MissingValueWeights" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Cluster" maxOccurs="unbounded"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelVerification" minOccurs="0"/>
       </sequence>
       <attribute name="modelName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="functionName" use="required" type="{http://www.dmg.org/PMML-4_3}MINING-FUNCTION" />
       <attribute name="algorithmName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="modelClass" use="required">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="centerBased"/>
             <enumeration value="distributionBased"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="numberOfClusters" use="required" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="isScorable" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusteringModel.ModelClass Java class for null.

Constructor Summary

Constructors

Constructor and Description
ClusteringModel()
ClusteringModel(MiningFunction miningFunction, ClusteringModel.ModelClass modelClass, int numberOfClusters, MiningSchema miningSchema, ComparisonMeasure comparisonMeasure, List<ClusteringField> clusteringFields, List<Cluster> clusters)

Method Summary

Methods

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

Methods inherited from class org.dmg.pmml.Model

getTargets, setTargets

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, setLocator, traverse, traverse, traverse, traverse, traverseMixed

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusteringModel

public ClusteringModel()

ClusteringModel

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

Method Detail

getModelName

public String getModelName()

Gets the value of the modelName property.

Specified by:

getModelName in class Model

Returns:

possible object is String

setModelName

public ClusteringModel setModelName(String modelName)

Sets the value of the modelName property.

Specified by:

setModelName in class Model

Parameters:

modelName - allowed object is String

getMiningFunction

public MiningFunction getMiningFunction()

Gets the value of the miningFunction property.

Specified by:

getMiningFunction in class Model

Returns:

possible object is MiningFunction

setMiningFunction

public ClusteringModel setMiningFunction(MiningFunction miningFunction)

Sets the value of the miningFunction property.

Specified by:

setMiningFunction in class Model

Parameters:

miningFunction - allowed object is MiningFunction

getAlgorithmName

public String getAlgorithmName()

Gets the value of the algorithmName property.

Specified by:

getAlgorithmName in class Model

Returns:

possible object is String

setAlgorithmName

public ClusteringModel setAlgorithmName(String algorithmName)

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

algorithmName - allowed object is String

getModelClass

public ClusteringModel.ModelClass getModelClass()

Gets the value of the modelClass property.

Returns:

possible object is ClusteringModel.ModelClass

setModelClass

public ClusteringModel setModelClass(ClusteringModel.ModelClass modelClass)

Sets the value of the modelClass property.

Parameters:

modelClass - allowed object is ClusteringModel.ModelClass

getNumberOfClusters

public int getNumberOfClusters()

Gets the value of the numberOfClusters property.

setNumberOfClusters

public ClusteringModel setNumberOfClusters(int numberOfClusters)

Sets the value of the numberOfClusters property.

isScorable

public boolean isScorable()

Gets the value of the scorable property.

Specified by:

isScorable in class Model

Returns:

possible object is Boolean

setScorable

public ClusteringModel setScorable(Boolean scorable)

Sets the value of the scorable property.

Specified by:

setScorable in class Model

Parameters:

scorable - allowed object is Boolean

getExtensions

public List<Extension> getExtensions()

Gets the value of the extensions property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the extensions property.

For example, to add a new item, do as follows:

    getExtensions().add(newItem);
 

Objects of the following type(s) are allowed in the list Extension

Specified by:

getExtensions in interface HasExtensions

getMiningSchema

public MiningSchema getMiningSchema()

Gets the value of the miningSchema property.

Specified by:

getMiningSchema in class Model

Returns:

possible object is MiningSchema

setMiningSchema

public ClusteringModel setMiningSchema(MiningSchema miningSchema)

Sets the value of the miningSchema property.

Specified by:

setMiningSchema in class Model

Parameters:

miningSchema - allowed object is MiningSchema

getOutput

public Output getOutput()

Gets the value of the output property.

Overrides:

getOutput in class Model

Returns:

possible object is Output

setOutput

public ClusteringModel setOutput(Output output)

Sets the value of the output property.

Overrides:

setOutput in class Model

Parameters:

output - allowed object is Output

getModelStats

public ModelStats getModelStats()

Gets the value of the modelStats property.

Specified by:

getModelStats in class Model

Returns:

possible object is ModelStats

setModelStats

public ClusteringModel setModelStats(ModelStats modelStats)

Sets the value of the modelStats property.

Specified by:

setModelStats in class Model

Parameters:

modelStats - allowed object is ModelStats

getModelExplanation

public ModelExplanation getModelExplanation()

Gets the value of the modelExplanation property.

Overrides:

getModelExplanation in class Model

Returns:

possible object is ModelExplanation

setModelExplanation

public ClusteringModel setModelExplanation(ModelExplanation modelExplanation)

Sets the value of the modelExplanation property.

Overrides:

setModelExplanation in class Model

Parameters:

modelExplanation - allowed object is ModelExplanation

getLocalTransformations

public LocalTransformations getLocalTransformations()

Gets the value of the localTransformations property.

Specified by:

getLocalTransformations in class Model

Returns:

possible object is LocalTransformations

setLocalTransformations

public ClusteringModel setLocalTransformations(LocalTransformations localTransformations)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

localTransformations - allowed object is LocalTransformations

getComparisonMeasure

public ComparisonMeasure getComparisonMeasure()

Gets the value of the comparisonMeasure property.

Returns:

possible object is ComparisonMeasure

setComparisonMeasure

public ClusteringModel setComparisonMeasure(ComparisonMeasure comparisonMeasure)

Sets the value of the comparisonMeasure property.

Parameters:

comparisonMeasure - allowed object is ComparisonMeasure

getClusteringFields

public List<ClusteringField> getClusteringFields()

Gets the value of the clusteringFields property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the clusteringFields property.

For example, to add a new item, do as follows:

    getClusteringFields().add(newItem);
 

Objects of the following type(s) are allowed in the list ClusteringField

getCenterFields

public CenterFields getCenterFields()

Gets the value of the centerFields property.

Returns:

possible object is CenterFields

setCenterFields

public ClusteringModel setCenterFields(CenterFields centerFields)

Sets the value of the centerFields property.

Parameters:

centerFields - allowed object is CenterFields

getMissingValueWeights

public MissingValueWeights getMissingValueWeights()

Gets the value of the missingValueWeights property.

Returns:

possible object is MissingValueWeights

setMissingValueWeights

public ClusteringModel setMissingValueWeights(MissingValueWeights missingValueWeights)

Sets the value of the missingValueWeights property.

Parameters:

missingValueWeights - allowed object is MissingValueWeights

getClusters

public List<Cluster> getClusters()

Gets the value of the clusters property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the clusters property.

For example, to add a new item, do as follows:

    getClusters().add(newItem);
 

Objects of the following type(s) are allowed in the list Cluster

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Overrides:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

public ClusteringModel setModelVerification(ModelVerification modelVerification)

Sets the value of the modelVerification property.

Overrides:

setModelVerification in class Model

Parameters:

modelVerification - allowed object is ModelVerification

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

addExtensions

public ClusteringModel addExtensions(Extension... extensions)

hasClusteringFields

public boolean hasClusteringFields()

addClusteringFields

public ClusteringModel addClusteringFields(ClusteringField... clusteringFields)

hasClusters

public boolean hasClusters()

addClusters

public ClusteringModel addClusters(Cluster... clusters)

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable