org.dmg.pmml

Class ComparisonMeasure

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.ComparisonMeasure

All Implemented Interfaces:

com.sun.xml.bind.Locatable, Serializable, HasExtensions, Visitable

public class ComparisonMeasure
extends PMMLObject
implements com.sun.xml.bind.Locatable, 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"/>
         <choice>
           <element ref="{http://www.dmg.org/PMML-4_2}euclidean"/>
           <element ref="{http://www.dmg.org/PMML-4_2}squaredEuclidean"/>
           <element ref="{http://www.dmg.org/PMML-4_2}chebychev"/>
           <element ref="{http://www.dmg.org/PMML-4_2}cityBlock"/>
           <element ref="{http://www.dmg.org/PMML-4_2}minkowski"/>
           <element ref="{http://www.dmg.org/PMML-4_2}simpleMatching"/>
           <element ref="{http://www.dmg.org/PMML-4_2}jaccard"/>
           <element ref="{http://www.dmg.org/PMML-4_2}tanimoto"/>
           <element ref="{http://www.dmg.org/PMML-4_2}binarySimilarity"/>
         </choice>
       </sequence>
       <attribute name="kind" use="required">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="distance"/>
             <enumeration value="similarity"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="compareFunction" type="{http://www.dmg.org/PMML-4_2}COMPARE-FUNCTION" default="absDiff" />
       <attribute name="minimum" type="{http://www.dmg.org/PMML-4_2}NUMBER" />
       <attribute name="maximum" type="{http://www.dmg.org/PMML-4_2}NUMBER" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComparisonMeasure.Kind Java class for null.

Field Summary

Fields

Modifier and Type	Field and Description
protected CompareFunctionType	compareFunction
protected List<Extension>	extensions
protected ComparisonMeasure.Kind	kind
protected Locator	locator
protected Double	maximum
protected Measure	measure
protected Double	minimum

Constructor Summary

Constructors

Constructor and Description
ComparisonMeasure()
ComparisonMeasure(ComparisonMeasure.Kind kind)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
CompareFunctionType	getCompareFunction() Gets the value of the compareFunction property.
List<Extension>	getExtensions() Gets the value of the extensions property.
ComparisonMeasure.Kind	getKind() Gets the value of the kind property.
Double	getMaximum() Gets the value of the maximum property.
Measure	getMeasure() Gets the value of the measure property.
Double	getMinimum() Gets the value of the minimum property.
void	setCompareFunction(CompareFunctionType value) Sets the value of the compareFunction property.
void	setKind(ComparisonMeasure.Kind value) Sets the value of the kind property.
void	setMaximum(Double value) Sets the value of the maximum property.
void	setMeasure(Measure value) Sets the value of the measure property.
void	setMinimum(Double value) Sets the value of the minimum property.
void	setSourceLocation(Locator newLocator)
Locator	sourceLocation()
ComparisonMeasure	withCompareFunction(CompareFunctionType value)
ComparisonMeasure	withExtensions(Collection<Extension> values)
ComparisonMeasure	withExtensions(Extension... values)
ComparisonMeasure	withKind(ComparisonMeasure.Kind value)
ComparisonMeasure	withMaximum(Double value)
ComparisonMeasure	withMeasure(Measure value)
ComparisonMeasure	withMinimum(Double value)

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

measure

protected Measure measure

kind

protected ComparisonMeasure.Kind kind

compareFunction

protected CompareFunctionType compareFunction

minimum

protected Double minimum

maximum

protected Double maximum

locator

protected Locator locator

Constructor Detail

ComparisonMeasure

public ComparisonMeasure()

ComparisonMeasure

public ComparisonMeasure(ComparisonMeasure.Kind kind)

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

Specified by:

getExtensions in interface HasExtensions

getMeasure

public Measure getMeasure()

Gets the value of the measure property.

Returns:

possible object is Euclidean SquaredEuclidean Chebychev CityBlock Minkowski SimpleMatching Jaccard Tanimoto BinarySimilarity

setMeasure

public void setMeasure(Measure value)

Sets the value of the measure property.

Parameters:

value - allowed object is Euclidean SquaredEuclidean Chebychev CityBlock Minkowski SimpleMatching Jaccard Tanimoto BinarySimilarity

getKind

public ComparisonMeasure.Kind getKind()

Gets the value of the kind property.

Returns:

possible object is ComparisonMeasure.Kind

setKind

public void setKind(ComparisonMeasure.Kind value)

Sets the value of the kind property.

Parameters:

value - allowed object is ComparisonMeasure.Kind

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

getMinimum

public Double getMinimum()

Gets the value of the minimum property.

Returns:

possible object is Double

setMinimum

public void setMinimum(Double value)

Sets the value of the minimum property.

Parameters:

value - allowed object is Double

getMaximum

public Double getMaximum()

Gets the value of the maximum property.

Returns:

possible object is Double

setMaximum

public void setMaximum(Double value)

Sets the value of the maximum property.

Parameters:

value - allowed object is Double

withExtensions

public ComparisonMeasure withExtensions(Extension... values)

withExtensions

public ComparisonMeasure withExtensions(Collection<Extension> values)

withMeasure

public ComparisonMeasure withMeasure(Measure value)

withKind

public ComparisonMeasure withKind(ComparisonMeasure.Kind value)

withCompareFunction

public ComparisonMeasure withCompareFunction(CompareFunctionType value)

withMinimum

public ComparisonMeasure withMinimum(Double value)

withMaximum

public ComparisonMeasure withMaximum(Double value)

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

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable