org.dmg.pmml

Class ClusteringModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.ClusteringModel

All Implemented Interfaces:

java.io.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_2}Extension" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}MiningSchema"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Output" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ModelExplanation" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ComparisonMeasure"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ClusteringField" maxOccurs="unbounded"/>
         <element ref="{http://www.dmg.org/PMML-4_2}CenterFields" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}MissingValueWeights" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Cluster" maxOccurs="unbounded"/>
         <element ref="{http://www.dmg.org/PMML-4_2}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_2}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_2}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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	algorithmName
protected CenterFields	centerFields
protected java.util.List<ClusteringField>	clusteringFields
protected java.util.List<Cluster>	clusters
protected ComparisonMeasure	comparisonMeasure
protected java.util.List<Extension>	extensions
protected MiningFunctionType	functionName
protected LocalTransformations	localTransformations
protected MiningSchema	miningSchema
protected MissingValueWeights	missingValueWeights
protected ClusteringModel.ModelClass	modelClass
protected ModelExplanation	modelExplanation
protected java.lang.String	modelName
protected ModelStats	modelStats
protected ModelVerification	modelVerification
protected java.lang.Integer	numberOfClusters
protected Output	output
protected java.lang.Boolean	scorable

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
java.lang.String	getAlgorithmName() Gets the value of the algorithmName property.
CenterFields	getCenterFields() Gets the value of the centerFields property.
java.util.List<ClusteringField>	getClusteringFields() Gets the value of the clusteringFields property.
java.util.List<Cluster>	getClusters() Gets the value of the clusters property.
ComparisonMeasure	getComparisonMeasure() Gets the value of the comparisonMeasure property.
java.util.List<Extension>	getExtensions() Gets the value of the extensions property.
MiningFunctionType	getFunctionName() Gets the value of the functionName property.
LocalTransformations	getLocalTransformations() Gets the value of the localTransformations 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.
java.lang.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.
java.lang.Integer	getNumberOfClusters() Gets the value of the numberOfClusters property.
Output	getOutput() Gets the value of the output property.
Targets	getTargets() Gets the value of the targets property.
boolean	hasClusteringFields()
boolean	hasClusters()
boolean	hasExtensions()
boolean	isScorable() Gets the value of the scorable property.
void	setAlgorithmName(java.lang.String value) Sets the value of the algorithmName property.
void	setCenterFields(CenterFields value) Sets the value of the centerFields property.
void	setComparisonMeasure(ComparisonMeasure value) Sets the value of the comparisonMeasure property.
void	setFunctionName(MiningFunctionType value) Sets the value of the functionName property.
void	setLocalTransformations(LocalTransformations value) Sets the value of the localTransformations property.
void	setMiningSchema(MiningSchema value) Sets the value of the miningSchema property.
void	setMissingValueWeights(MissingValueWeights value) Sets the value of the missingValueWeights property.
void	setModelClass(ClusteringModel.ModelClass value) Sets the value of the modelClass property.
void	setModelExplanation(ModelExplanation value) Sets the value of the modelExplanation property.
void	setModelName(java.lang.String value) Sets the value of the modelName property.
void	setModelStats(ModelStats value) Sets the value of the modelStats property.
void	setModelVerification(ModelVerification value) Sets the value of the modelVerification property.
void	setNumberOfClusters(java.lang.Integer value) Sets the value of the numberOfClusters property.
void	setOutput(Output value) Sets the value of the output property.
void	setScorable(java.lang.Boolean value) Sets the value of the scorable property.
void	setTargets(Targets targets) Sets the value of the targets property.
ClusteringModel	withAlgorithmName(java.lang.String value)
ClusteringModel	withCenterFields(CenterFields value)
ClusteringModel	withClusteringFields(ClusteringField... values)
ClusteringModel	withClusteringFields(java.util.Collection<ClusteringField> values)
ClusteringModel	withClusters(Cluster... values)
ClusteringModel	withClusters(java.util.Collection<Cluster> values)
ClusteringModel	withComparisonMeasure(ComparisonMeasure value)
ClusteringModel	withExtensions(java.util.Collection<Extension> values)
ClusteringModel	withExtensions(Extension... values)
ClusteringModel	withFunctionName(MiningFunctionType value)
ClusteringModel	withLocalTransformations(LocalTransformations value)
ClusteringModel	withMiningSchema(MiningSchema value)
ClusteringModel	withMissingValueWeights(MissingValueWeights value)
ClusteringModel	withModelClass(ClusteringModel.ModelClass value)
ClusteringModel	withModelExplanation(ModelExplanation value)
ClusteringModel	withModelName(java.lang.String value)
ClusteringModel	withModelStats(ModelStats value)
ClusteringModel	withModelVerification(ModelVerification value)
ClusteringModel	withNumberOfClusters(java.lang.Integer value)
ClusteringModel	withOutput(Output value)
ClusteringModel	withScorable(java.lang.Boolean value)

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, setLocator

Methods inherited from class java.lang.Object

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

Field Detail

modelName

protected java.lang.String modelName

functionName

protected MiningFunctionType functionName

algorithmName

protected java.lang.String algorithmName

modelClass

protected ClusteringModel.ModelClass modelClass

numberOfClusters

protected java.lang.Integer numberOfClusters

scorable

protected java.lang.Boolean scorable

extensions

protected java.util.List<Extension> extensions

miningSchema

protected MiningSchema miningSchema

output

protected Output output

modelStats

protected ModelStats modelStats

modelExplanation

protected ModelExplanation modelExplanation

localTransformations

protected LocalTransformations localTransformations

comparisonMeasure

protected ComparisonMeasure comparisonMeasure

clusteringFields

protected java.util.List<ClusteringField> clusteringFields

centerFields

protected CenterFields centerFields

missingValueWeights

protected MissingValueWeights missingValueWeights

clusters

protected java.util.List<Cluster> clusters

modelVerification

protected ModelVerification modelVerification

Constructor Detail

ClusteringModel

public ClusteringModel()

ClusteringModel

public ClusteringModel(MiningFunctionType functionName,
               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()

Gets the value of the modelName property.

Specified by:

getModelName in class Model

Returns:

possible object is String

setModelName

public void setModelName(java.lang.String value)

Sets the value of the modelName property.

Specified by:

setModelName in class Model

Parameters:

value - allowed object is String

getFunctionName

public MiningFunctionType getFunctionName()

Gets the value of the functionName property.

Specified by:

getFunctionName in class Model

Returns:

possible object is MiningFunctionType

setFunctionName

public void setFunctionName(MiningFunctionType value)

Sets the value of the functionName property.

Specified by:

setFunctionName in class Model

Parameters:

value - allowed object is MiningFunctionType

getAlgorithmName

public java.lang.String getAlgorithmName()

Gets the value of the algorithmName property.

Specified by:

getAlgorithmName in class Model

Returns:

possible object is String

setAlgorithmName

public void setAlgorithmName(java.lang.String value)

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

value - allowed object is String

getModelClass

public ClusteringModel.ModelClass getModelClass()

Gets the value of the modelClass property.

Returns:

possible object is ClusteringModel.ModelClass

setModelClass

public void setModelClass(ClusteringModel.ModelClass value)

Sets the value of the modelClass property.

Parameters:

value - allowed object is ClusteringModel.ModelClass

getNumberOfClusters

public java.lang.Integer getNumberOfClusters()

Gets the value of the numberOfClusters property.

Returns:

possible object is String

setNumberOfClusters

public void setNumberOfClusters(java.lang.Integer value)

Sets the value of the numberOfClusters property.

Parameters:

value - allowed object is String

isScorable

public boolean isScorable()

Gets the value of the scorable property.

Specified by:

isScorable in class Model

Returns:

possible object is Boolean

setScorable

public void setScorable(java.lang.Boolean value)

Sets the value of the scorable property.

Specified by:

setScorable in class Model

Parameters:

value - allowed object is Boolean

getExtensions

public java.util.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 void setMiningSchema(MiningSchema value)

Sets the value of the miningSchema property.

Specified by:

setMiningSchema in class Model

Parameters:

value - allowed object is MiningSchema

getOutput

public Output getOutput()

Gets the value of the output property.

Specified by:

getOutput in class Model

Returns:

possible object is Output

setOutput

public void setOutput(Output value)

Sets the value of the output property.

Specified by:

setOutput in class Model

Parameters:

value - 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 void setModelStats(ModelStats value)

Sets the value of the modelStats property.

Specified by:

setModelStats in class Model

Parameters:

value - allowed object is ModelStats

getModelExplanation

public ModelExplanation getModelExplanation()

Gets the value of the modelExplanation property.

Specified by:

getModelExplanation in class Model

Returns:

possible object is ModelExplanation

setModelExplanation

public void setModelExplanation(ModelExplanation value)

Sets the value of the modelExplanation property.

Specified by:

setModelExplanation in class Model

Parameters:

value - 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 void setLocalTransformations(LocalTransformations value)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

value - allowed object is LocalTransformations

getComparisonMeasure

public ComparisonMeasure getComparisonMeasure()

Gets the value of the comparisonMeasure property.

Returns:

possible object is ComparisonMeasure

setComparisonMeasure

public void setComparisonMeasure(ComparisonMeasure value)

Sets the value of the comparisonMeasure property.

Parameters:

value - allowed object is ComparisonMeasure

getClusteringFields

public java.util.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 void setCenterFields(CenterFields value)

Sets the value of the centerFields property.

Parameters:

value - allowed object is CenterFields

getMissingValueWeights

public MissingValueWeights getMissingValueWeights()

Gets the value of the missingValueWeights property.

Returns:

possible object is MissingValueWeights

setMissingValueWeights

public void setMissingValueWeights(MissingValueWeights value)

Sets the value of the missingValueWeights property.

Parameters:

value - allowed object is MissingValueWeights

getClusters

public java.util.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.

Specified by:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

public void setModelVerification(ModelVerification value)

Sets the value of the modelVerification property.

Specified by:

setModelVerification in class Model

Parameters:

value - allowed object is ModelVerification

withModelName

public ClusteringModel withModelName(java.lang.String value)

withFunctionName

public ClusteringModel withFunctionName(MiningFunctionType value)

withAlgorithmName

public ClusteringModel withAlgorithmName(java.lang.String value)

withModelClass

public ClusteringModel withModelClass(ClusteringModel.ModelClass value)

withNumberOfClusters

public ClusteringModel withNumberOfClusters(java.lang.Integer value)

withScorable

public ClusteringModel withScorable(java.lang.Boolean value)

withExtensions

public ClusteringModel withExtensions(Extension... values)

withExtensions

public ClusteringModel withExtensions(java.util.Collection<Extension> values)

withMiningSchema

public ClusteringModel withMiningSchema(MiningSchema value)

withOutput

public ClusteringModel withOutput(Output value)

withModelStats

public ClusteringModel withModelStats(ModelStats value)

withModelExplanation

public ClusteringModel withModelExplanation(ModelExplanation value)

withLocalTransformations

public ClusteringModel withLocalTransformations(LocalTransformations value)

withComparisonMeasure

public ClusteringModel withComparisonMeasure(ComparisonMeasure value)

withClusteringFields

public ClusteringModel withClusteringFields(ClusteringField... values)

withClusteringFields

public ClusteringModel withClusteringFields(java.util.Collection<ClusteringField> values)

withCenterFields

public ClusteringModel withCenterFields(CenterFields value)

withMissingValueWeights

public ClusteringModel withMissingValueWeights(MissingValueWeights value)

withClusters

public ClusteringModel withClusters(Cluster... values)

withClusters

public ClusteringModel withClusters(java.util.Collection<Cluster> values)

withModelVerification

public ClusteringModel withModelVerification(ModelVerification value)

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

hasClusteringFields

public boolean hasClusteringFields()

hasClusters

public boolean hasClusters()

getTargets

public Targets getTargets()

Gets the value of the targets property.

Specified by:

getTargets in class Model

Throws:

java.lang.UnsupportedOperationException - Always.

setTargets

public void setTargets(Targets targets)

Sets the value of the targets property.

Specified by:

setTargets in class Model

Throws:

java.lang.UnsupportedOperationException - Always.

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable