org.dmg.pmml

Class ClusteringField

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.ComparisonField

org.dmg.pmml.ClusteringField

All Implemented Interfaces:

java.io.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.

Field Summary

Fields

Modifier and Type	Field and Description
protected ClusteringField.CenterField	centerField
protected CompareFunctionType	compareFunction
protected Comparisons	comparisons
protected java.util.List<Extension>	extensions
protected FieldName	field
protected java.lang.Double	fieldWeight
protected java.lang.Double	similarityScale

Constructor Summary

Constructors

Constructor and Description
ClusteringField()
ClusteringField(FieldName field)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
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.
java.util.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.
java.lang.Double	getSimilarityScale() Gets the value of the similarityScale property.
boolean	hasExtensions()
void	setCenterField(ClusteringField.CenterField value) Sets the value of the centerField property.
void	setCompareFunction(CompareFunctionType value) Sets the value of the compareFunction property.
void	setComparisons(Comparisons value) Sets the value of the comparisons property.
void	setField(FieldName value) Sets the value of the field property.
void	setFieldWeight(java.lang.Double value) Sets the value of the fieldWeight property.
void	setSimilarityScale(java.lang.Double value) Sets the value of the similarityScale property.
ClusteringField	withCenterField(ClusteringField.CenterField value)
ClusteringField	withCompareFunction(CompareFunctionType value)
ClusteringField	withComparisons(Comparisons value)
ClusteringField	withExtensions(java.util.Collection<Extension> values)
ClusteringField	withExtensions(Extension... values)
ClusteringField	withField(FieldName value)
ClusteringField	withFieldWeight(java.lang.Double value)
ClusteringField	withSimilarityScale(java.lang.Double 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

field

protected FieldName field

centerField

protected ClusteringField.CenterField centerField

fieldWeight

protected java.lang.Double fieldWeight

similarityScale

protected java.lang.Double similarityScale

compareFunction

protected CompareFunctionType compareFunction

extensions

protected java.util.List<Extension> extensions

comparisons

protected Comparisons comparisons

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 void setField(FieldName value)

Sets the value of the field property.

Specified by:

setField in class ComparisonField

Parameters:

value - allowed object is String

getCenterField

public ClusteringField.CenterField getCenterField()

Gets the value of the centerField property.

Returns:

possible object is ClusteringField.CenterField

setCenterField

public void setCenterField(ClusteringField.CenterField value)

Sets the value of the centerField property.

Parameters:

value - 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 void setFieldWeight(java.lang.Double value)

Sets the value of the fieldWeight property.

Specified by:

setFieldWeight in class ComparisonField

Parameters:

value - allowed object is Double

getSimilarityScale

public java.lang.Double getSimilarityScale()

Gets the value of the similarityScale property.

Specified by:

getSimilarityScale in class ComparisonField

Returns:

possible object is Double

setSimilarityScale

public void setSimilarityScale(java.lang.Double value)

Sets the value of the similarityScale property.

Specified by:

setSimilarityScale in class ComparisonField

Parameters:

value - 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 void setCompareFunction(CompareFunctionType value)

Sets the value of the compareFunction property.

Specified by:

setCompareFunction in class ComparisonField

Parameters:

value - allowed object is CompareFunctionType

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

getComparisons

public Comparisons getComparisons()

Gets the value of the comparisons property.

Returns:

possible object is Comparisons

setComparisons

public void setComparisons(Comparisons value)

Sets the value of the comparisons property.

Parameters:

value - allowed object is Comparisons

withField

public ClusteringField withField(FieldName value)

withCenterField

public ClusteringField withCenterField(ClusteringField.CenterField value)

withFieldWeight

public ClusteringField withFieldWeight(java.lang.Double value)

withSimilarityScale

public ClusteringField withSimilarityScale(java.lang.Double value)

withCompareFunction

public ClusteringField withCompareFunction(CompareFunctionType value)

withExtensions

public ClusteringField withExtensions(Extension... values)

withExtensions

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

withComparisons

public ClusteringField withComparisons(Comparisons value)

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable