org.dmg.pmml.nearest_neighbor

Class NearestNeighborModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.nearest_neighbor.NearestNeighborModel

All Implemented Interfaces:

Serializable, HasExtensions, HasLocator, Visitable

public class NearestNeighborModel
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_3}Extension" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}MiningSchema"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Output" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelExplanation" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Targets" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}TrainingInstances"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ComparisonMeasure"/>
         <element ref="{http://www.dmg.org/PMML-4_3}KNNInputs"/>
         <element ref="{http://www.dmg.org/PMML-4_3}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_3}MINING-FUNCTION" />
       <attribute name="algorithmName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="numberOfNeighbors" use="required" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="continuousScoringMethod" default="average">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="median"/>
             <enumeration value="average"/>
             <enumeration value="weightedAverage"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="categoricalScoringMethod" default="majorityVote">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="majorityVote"/>
             <enumeration value="weightedMajorityVote"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="instanceIdVariable" type="{http://www.dmg.org/PMML-4_3}FIELD-NAME" />
       <attribute name="threshold" type="{http://www.dmg.org/PMML-4_3}REAL-NUMBER" default="0.001" />
       <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	NearestNeighborModel.CategoricalScoringMethod Java class for null.
static class	NearestNeighborModel.ContinuousScoringMethod Java class for null.

Constructor Summary

Constructors

Constructor and Description
NearestNeighborModel()
NearestNeighborModel(MiningFunction miningFunction, int numberOfNeighbors, MiningSchema miningSchema, TrainingInstances trainingInstances, ComparisonMeasure comparisonMeasure, KNNInputs knnInputs)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
NearestNeighborModel	addExtensions(Extension... extensions)
String	getAlgorithmName() Gets the value of the algorithmName property.
NearestNeighborModel.CategoricalScoringMethod	getCategoricalScoringMethod() Gets the value of the categoricalScoringMethod property.
ComparisonMeasure	getComparisonMeasure() Gets the value of the comparisonMeasure property.
NearestNeighborModel.ContinuousScoringMethod	getContinuousScoringMethod() Gets the value of the continuousScoringMethod property.
List<Extension>	getExtensions() Gets the value of the extensions property.
FieldName	getInstanceIdVariable() Gets the value of the instanceIdVariable property.
KNNInputs	getKNNInputs() Gets the value of the knnInputs property.
LocalTransformations	getLocalTransformations() Gets the value of the localTransformations property.
MiningFunction	getMiningFunction() Gets the value of the miningFunction property.
MiningSchema	getMiningSchema() Gets the value of the miningSchema property.
ModelExplanation	getModelExplanation() Gets the value of the modelExplanation property.
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.
int	getNumberOfNeighbors() Gets the value of the numberOfNeighbors property.
Output	getOutput() Gets the value of the output property.
Targets	getTargets() Gets the value of the targets property.
Double	getThreshold() Gets the value of the threshold property.
TrainingInstances	getTrainingInstances() Gets the value of the trainingInstances property.
boolean	hasExtensions()
boolean	isScorable() Gets the value of the scorable property.
NearestNeighborModel	setAlgorithmName(String algorithmName) Sets the value of the algorithmName property.
NearestNeighborModel	setCategoricalScoringMethod(NearestNeighborModel.CategoricalScoringMethod categoricalScoringMethod) Sets the value of the categoricalScoringMethod property.
NearestNeighborModel	setComparisonMeasure(ComparisonMeasure comparisonMeasure) Sets the value of the comparisonMeasure property.
NearestNeighborModel	setContinuousScoringMethod(NearestNeighborModel.ContinuousScoringMethod continuousScoringMethod) Sets the value of the continuousScoringMethod property.
NearestNeighborModel	setInstanceIdVariable(FieldName instanceIdVariable) Sets the value of the instanceIdVariable property.
NearestNeighborModel	setKNNInputs(KNNInputs knnInputs) Sets the value of the knnInputs property.
NearestNeighborModel	setLocalTransformations(LocalTransformations localTransformations) Sets the value of the localTransformations property.
NearestNeighborModel	setMiningFunction(MiningFunction miningFunction) Sets the value of the miningFunction property.
NearestNeighborModel	setMiningSchema(MiningSchema miningSchema) Sets the value of the miningSchema property.
NearestNeighborModel	setModelExplanation(ModelExplanation modelExplanation) Sets the value of the modelExplanation property.
NearestNeighborModel	setModelName(String modelName) Sets the value of the modelName property.
NearestNeighborModel	setModelStats(ModelStats modelStats) Sets the value of the modelStats property.
NearestNeighborModel	setModelVerification(ModelVerification modelVerification) Sets the value of the modelVerification property.
NearestNeighborModel	setNumberOfNeighbors(int numberOfNeighbors) Sets the value of the numberOfNeighbors property.
NearestNeighborModel	setOutput(Output output) Sets the value of the output property.
NearestNeighborModel	setScorable(Boolean scorable) Sets the value of the scorable property.
NearestNeighborModel	setTargets(Targets targets) Sets the value of the targets property.
NearestNeighborModel	setThreshold(Double threshold) Sets the value of the threshold property.
NearestNeighborModel	setTrainingInstances(TrainingInstances trainingInstances) Sets the value of the trainingInstances property.

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, setLocator, traverse, traverse, traverse, traverse, traverseMixed

Methods inherited from class java.lang.Object

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

Constructor Detail

NearestNeighborModel

public NearestNeighborModel()

NearestNeighborModel

public NearestNeighborModel(MiningFunction miningFunction,
                    int numberOfNeighbors,
                    MiningSchema miningSchema,
                    TrainingInstances trainingInstances,
                    ComparisonMeasure comparisonMeasure,
                    KNNInputs knnInputs)

Method Detail

getModelName

public String getModelName()

Gets the value of the modelName property.

Specified by:

getModelName in class Model

Returns:

possible object is String

setModelName

public NearestNeighborModel setModelName(String modelName)

Sets the value of the modelName property.

Specified by:

setModelName in class Model

Parameters:

modelName - allowed object is String

getMiningFunction

public MiningFunction getMiningFunction()

Gets the value of the miningFunction property.

Specified by:

getMiningFunction in class Model

Returns:

possible object is MiningFunction

setMiningFunction

public NearestNeighborModel setMiningFunction(MiningFunction miningFunction)

Sets the value of the miningFunction property.

Specified by:

setMiningFunction in class Model

Parameters:

miningFunction - allowed object is MiningFunction

getAlgorithmName

public String getAlgorithmName()

Gets the value of the algorithmName property.

Specified by:

getAlgorithmName in class Model

Returns:

possible object is String

setAlgorithmName

public NearestNeighborModel setAlgorithmName(String algorithmName)

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

algorithmName - allowed object is String

getNumberOfNeighbors

public int getNumberOfNeighbors()

Gets the value of the numberOfNeighbors property.

setNumberOfNeighbors

public NearestNeighborModel setNumberOfNeighbors(int numberOfNeighbors)

Sets the value of the numberOfNeighbors property.

getContinuousScoringMethod

public NearestNeighborModel.ContinuousScoringMethod getContinuousScoringMethod()

Gets the value of the continuousScoringMethod property.

Returns:

possible object is NearestNeighborModel.ContinuousScoringMethod

setContinuousScoringMethod

public NearestNeighborModel setContinuousScoringMethod(NearestNeighborModel.ContinuousScoringMethod continuousScoringMethod)

Sets the value of the continuousScoringMethod property.

Parameters:

continuousScoringMethod - allowed object is NearestNeighborModel.ContinuousScoringMethod

getCategoricalScoringMethod

public NearestNeighborModel.CategoricalScoringMethod getCategoricalScoringMethod()

Gets the value of the categoricalScoringMethod property.

Returns:

possible object is NearestNeighborModel.CategoricalScoringMethod

setCategoricalScoringMethod

public NearestNeighborModel setCategoricalScoringMethod(NearestNeighborModel.CategoricalScoringMethod categoricalScoringMethod)

Sets the value of the categoricalScoringMethod property.

Parameters:

categoricalScoringMethod - allowed object is NearestNeighborModel.CategoricalScoringMethod

getInstanceIdVariable

public FieldName getInstanceIdVariable()

Gets the value of the instanceIdVariable property.

Returns:

possible object is String

setInstanceIdVariable

public NearestNeighborModel setInstanceIdVariable(FieldName instanceIdVariable)

Sets the value of the instanceIdVariable property.

Parameters:

instanceIdVariable - allowed object is String

getThreshold

public Double getThreshold()

Gets the value of the threshold property.

Returns:

possible object is Double

setThreshold

public NearestNeighborModel setThreshold(Double threshold)

Sets the value of the threshold property.

Parameters:

threshold - allowed object is Double

isScorable

public boolean isScorable()

Gets the value of the scorable property.

Specified by:

isScorable in class Model

Returns:

possible object is Boolean

setScorable

public NearestNeighborModel setScorable(Boolean scorable)

Sets the value of the scorable property.

Specified by:

setScorable in class Model

Parameters:

scorable - allowed object is Boolean

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

getMiningSchema

public MiningSchema getMiningSchema()

Gets the value of the miningSchema property.

Specified by:

getMiningSchema in class Model

Returns:

possible object is MiningSchema

setMiningSchema

public NearestNeighborModel setMiningSchema(MiningSchema miningSchema)

Sets the value of the miningSchema property.

Specified by:

setMiningSchema in class Model

Parameters:

miningSchema - allowed object is MiningSchema

getOutput

public Output getOutput()

Gets the value of the output property.

Overrides:

getOutput in class Model

Returns:

possible object is Output

setOutput

public NearestNeighborModel setOutput(Output output)

Sets the value of the output property.

Overrides:

setOutput in class Model

Parameters:

output - 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 NearestNeighborModel setModelStats(ModelStats modelStats)

Sets the value of the modelStats property.

Specified by:

setModelStats in class Model

Parameters:

modelStats - allowed object is ModelStats

getModelExplanation

public ModelExplanation getModelExplanation()

Gets the value of the modelExplanation property.

Overrides:

getModelExplanation in class Model

Returns:

possible object is ModelExplanation

setModelExplanation

public NearestNeighborModel setModelExplanation(ModelExplanation modelExplanation)

Sets the value of the modelExplanation property.

Overrides:

setModelExplanation in class Model

Parameters:

modelExplanation - allowed object is ModelExplanation

getTargets

public Targets getTargets()

Gets the value of the targets property.

Overrides:

getTargets in class Model

Returns:

possible object is Targets

setTargets

public NearestNeighborModel setTargets(Targets targets)

Sets the value of the targets property.

Overrides:

setTargets in class Model

Parameters:

targets - allowed object is Targets

getLocalTransformations

public LocalTransformations getLocalTransformations()

Gets the value of the localTransformations property.

Specified by:

getLocalTransformations in class Model

Returns:

possible object is LocalTransformations

setLocalTransformations

public NearestNeighborModel setLocalTransformations(LocalTransformations localTransformations)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

localTransformations - allowed object is LocalTransformations

getTrainingInstances

public TrainingInstances getTrainingInstances()

Gets the value of the trainingInstances property.

Returns:

possible object is TrainingInstances

setTrainingInstances

public NearestNeighborModel setTrainingInstances(TrainingInstances trainingInstances)

Sets the value of the trainingInstances property.

Parameters:

trainingInstances - allowed object is TrainingInstances

getComparisonMeasure

public ComparisonMeasure getComparisonMeasure()

Gets the value of the comparisonMeasure property.

Returns:

possible object is ComparisonMeasure

setComparisonMeasure

public NearestNeighborModel setComparisonMeasure(ComparisonMeasure comparisonMeasure)

Sets the value of the comparisonMeasure property.

Parameters:

comparisonMeasure - allowed object is ComparisonMeasure

getKNNInputs

public KNNInputs getKNNInputs()

Gets the value of the knnInputs property.

Returns:

possible object is KNNInputs

setKNNInputs

public NearestNeighborModel setKNNInputs(KNNInputs knnInputs)

Sets the value of the knnInputs property.

Parameters:

knnInputs - allowed object is KNNInputs

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Overrides:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

public NearestNeighborModel setModelVerification(ModelVerification modelVerification)

Sets the value of the modelVerification property.

Overrides:

setModelVerification in class Model

Parameters:

modelVerification - allowed object is ModelVerification

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

addExtensions

public NearestNeighborModel addExtensions(Extension... extensions)

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable