org.dmg.pmml

Class ClusteringField

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.ComparisonField

org.dmg.pmml.ClusteringField

All Implemented Interfaces:

Serializable, HasExtensions, HasLocator, Visitable

public class ClusteringField
extends ComparisonField
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}Comparisons" minOccurs="0"/>
       </sequence>
       <attribute name="field" use="required" type="{http://www.dmg.org/PMML-4_2}FIELD-NAME" />
       <attribute name="isCenterField" default="true">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="true"/>
             <enumeration value="false"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="fieldWeight" type="{http://www.dmg.org/PMML-4_2}REAL-NUMBER" default="1" />
       <attribute name="similarityScale" type="{http://www.dmg.org/PMML-4_2}REAL-NUMBER" />
       <attribute name="compareFunction" type="{http://www.dmg.org/PMML-4_2}COMPARE-FUNCTION" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusteringField.CenterField Java class for null.

Constructor Summary

Constructors

Constructor and Description
ClusteringField()
ClusteringField(FieldName field)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
ClusteringField	addExtensions(Extension... extensions)
ClusteringField.CenterField	getCenterField() Gets the value of the centerField property.
CompareFunctionType	getCompareFunction() Gets the value of the compareFunction property.
Comparisons	getComparisons() Gets the value of the comparisons property.
List<Extension>	getExtensions() Gets the value of the extensions property.
FieldName	getField() Gets the value of the field property.
Double	getFieldWeight() Gets the value of the fieldWeight property.
Double	getSimilarityScale() Gets the value of the similarityScale property.
boolean	hasExtensions()
ClusteringField	setCenterField(ClusteringField.CenterField centerField) Sets the value of the centerField property.
ClusteringField	setCompareFunction(CompareFunctionType compareFunction) Sets the value of the compareFunction property.
ClusteringField	setComparisons(Comparisons comparisons) Sets the value of the comparisons property.
ClusteringField	setField(FieldName field) Sets the value of the field property.
ClusteringField	setFieldWeight(Double fieldWeight) Sets the value of the fieldWeight property.
ClusteringField	setSimilarityScale(Double similarityScale) Sets the value of the similarityScale property.

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

Constructor Detail

ClusteringField

public ClusteringField()

ClusteringField

public ClusteringField(FieldName field)

Method Detail

getField

public FieldName getField()

Gets the value of the field property.

Specified by:

getField in class ComparisonField

Returns:

possible object is String

setField

public ClusteringField setField(FieldName field)

Sets the value of the field property.

Specified by:

setField in class ComparisonField

Parameters:

field - allowed object is String

getCenterField

public ClusteringField.CenterField getCenterField()

Gets the value of the centerField property.

Returns:

possible object is ClusteringField.CenterField

setCenterField

public ClusteringField setCenterField(ClusteringField.CenterField centerField)

Sets the value of the centerField property.

Parameters:

centerField - allowed object is ClusteringField.CenterField

getFieldWeight

public Double getFieldWeight()

Gets the value of the fieldWeight property.

Specified by:

getFieldWeight in class ComparisonField

Returns:

possible object is Double

setFieldWeight

public ClusteringField setFieldWeight(Double fieldWeight)

Sets the value of the fieldWeight property.

Specified by:

setFieldWeight in class ComparisonField

Parameters:

fieldWeight - allowed object is Double

getSimilarityScale

public Double getSimilarityScale()

Gets the value of the similarityScale property.

Overrides:

getSimilarityScale in class ComparisonField

Returns:

possible object is Double

setSimilarityScale

public ClusteringField setSimilarityScale(Double similarityScale)

Sets the value of the similarityScale property.

Overrides:

setSimilarityScale in class ComparisonField

Parameters:

similarityScale - allowed object is Double

getCompareFunction

public CompareFunctionType getCompareFunction()

Gets the value of the compareFunction property.

Specified by:

getCompareFunction in class ComparisonField

Returns:

possible object is CompareFunctionType

setCompareFunction

public ClusteringField setCompareFunction(CompareFunctionType compareFunction)

Sets the value of the compareFunction property.

Specified by:

setCompareFunction in class ComparisonField

Parameters:

compareFunction - allowed object is CompareFunctionType

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

getComparisons

public Comparisons getComparisons()

Gets the value of the comparisons property.

Returns:

possible object is Comparisons

setComparisons

public ClusteringField setComparisons(Comparisons comparisons)

Sets the value of the comparisons property.

Parameters:

comparisons - allowed object is Comparisons

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

addExtensions

public ClusteringField addExtensions(Extension... extensions)

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable