org.dmg.pmml

Class ClusteringField

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.ClusteringField

All Implemented Interfaces:

com.sun.xml.bind.Locatable, Serializable

public class ClusteringField
extends PMMLObject
implements com.sun.xml.bind.Locatable

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_1}Extension" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_1}Comparisons" minOccurs="0"/>
       </sequence>
       <attribute name="field" use="required" type="{http://www.dmg.org/PMML-4_1}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_1}REAL-NUMBER" default="1" />
       <attribute name="similarityScale" type="{http://www.dmg.org/PMML-4_1}REAL-NUMBER" />
       <attribute name="compareFunction" type="{http://www.dmg.org/PMML-4_1}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 List<Extension>	extensions
protected FieldName	field
protected Double	fieldWeight
protected Locator	locator
protected Double	similarityScale

Constructor Summary

Constructors

Constructor and Description
ClusteringField() Deprecated.
ClusteringField(FieldName field)

Method Summary

Methods

Modifier and Type	Method and Description
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.
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(Double value) Sets the value of the fieldWeight property.
void	setSimilarityScale(Double value) Sets the value of the similarityScale property.
void	setSourceLocation(Locator newLocator)
Locator	sourceLocation()

Methods inherited from class java.lang.Object

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

Field Detail

extensions

protected List<Extension> extensions

comparisons

protected Comparisons comparisons

field

protected FieldName field

centerField

protected ClusteringField.CenterField centerField

fieldWeight

protected Double fieldWeight

similarityScale

protected Double similarityScale

compareFunction

protected CompareFunctionType compareFunction

locator

protected Locator locator

Constructor Detail

ClusteringField

@Deprecated
public ClusteringField()

Deprecated.

ClusteringField

public ClusteringField(FieldName field)

Method Detail

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

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

getField

public FieldName getField()

Gets the value of the field property.

Returns:

possible object is String

setField

public void setField(FieldName value)

Sets the value of the field property.

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.

Returns:

possible object is Double

setFieldWeight

public void setFieldWeight(Double value)

Sets the value of the fieldWeight property.

Parameters:

value - allowed object is Double

getSimilarityScale

public Double getSimilarityScale()

Gets the value of the similarityScale property.

Returns:

possible object is Double

setSimilarityScale

public void setSimilarityScale(Double value)

Sets the value of the similarityScale property.

Parameters:

value - allowed object is Double

getCompareFunction

public CompareFunctionType getCompareFunction()

Gets the value of the compareFunction property.

Returns:

possible object is CompareFunctionType

setCompareFunction

public void setCompareFunction(CompareFunctionType value)

Sets the value of the compareFunction property.

Parameters:

value - allowed object is CompareFunctionType

sourceLocation

public Locator sourceLocation()

Specified by:

sourceLocation in interface com.sun.xml.bind.Locatable

Specified by:

sourceLocation in class PMMLObject

setSourceLocation

public void setSourceLocation(Locator newLocator)

Specified by:

setSourceLocation in class PMMLObject