org.dmg.pmml

Class NearestNeighborModel

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.NearestNeighborModel

All Implemented Interfaces:

java.io.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_2}Extension" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}MiningSchema"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Output" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ModelExplanation" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Targets" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}TrainingInstances"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ComparisonMeasure"/>
         <element ref="{http://www.dmg.org/PMML-4_2}KNNInputs"/>
         <element ref="{http://www.dmg.org/PMML-4_2}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_2}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_2}INT-NUMBER" />
       <attribute name="continuousScoringMethod" type="{http://www.dmg.org/PMML-4_2}CONT-SCORING-METHOD" default="average" />
       <attribute name="categoricalScoringMethod" type="{http://www.dmg.org/PMML-4_2}CAT-SCORING-METHOD" default="majorityVote" />
       <attribute name="instanceIdVariable" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="threshold" type="{http://www.dmg.org/PMML-4_2}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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	algorithmName
protected CategoricalScoringMethodType	categoricalScoringMethod
protected ComparisonMeasure	comparisonMeasure
protected ContinuousScoringMethodType	continuousScoringMethod
protected java.util.List<Extension>	extensions
protected MiningFunctionType	functionName
protected java.lang.String	instanceIdVariable
protected KNNInputs	knnInputs
protected LocalTransformations	localTransformations
protected MiningSchema	miningSchema
protected ModelExplanation	modelExplanation
protected java.lang.String	modelName
protected ModelStats	modelStats
protected ModelVerification	modelVerification
protected java.lang.Integer	numberOfNeighbors
protected Output	output
protected java.lang.Boolean	scorable
protected Targets	targets
protected java.lang.Double	threshold
protected TrainingInstances	trainingInstances

Constructor Summary

Constructors

Constructor and Description
NearestNeighborModel()
NearestNeighborModel(MiningFunctionType functionName, java.lang.Integer numberOfNeighbors, MiningSchema miningSchema, TrainingInstances trainingInstances, ComparisonMeasure comparisonMeasure, KNNInputs knnInputs)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
java.lang.String	getAlgorithmName() Gets the value of the algorithmName property.
CategoricalScoringMethodType	getCategoricalScoringMethod() Gets the value of the categoricalScoringMethod property.
ComparisonMeasure	getComparisonMeasure() Gets the value of the comparisonMeasure property.
ContinuousScoringMethodType	getContinuousScoringMethod() Gets the value of the continuousScoringMethod property.
java.util.List<Extension>	getExtensions() Gets the value of the extensions property.
MiningFunctionType	getFunctionName() Gets the value of the functionName property.
java.lang.String	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.
MiningSchema	getMiningSchema() Gets the value of the miningSchema property.
ModelExplanation	getModelExplanation() Gets the value of the modelExplanation property.
java.lang.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.
java.lang.Integer	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.
void	setAlgorithmName(java.lang.String value) Sets the value of the algorithmName property.
void	setCategoricalScoringMethod(CategoricalScoringMethodType value) Sets the value of the categoricalScoringMethod property.
void	setComparisonMeasure(ComparisonMeasure value) Sets the value of the comparisonMeasure property.
void	setContinuousScoringMethod(ContinuousScoringMethodType value) Sets the value of the continuousScoringMethod property.
void	setFunctionName(MiningFunctionType value) Sets the value of the functionName property.
void	setInstanceIdVariable(java.lang.String value) Sets the value of the instanceIdVariable property.
void	setKNNInputs(KNNInputs value) Sets the value of the knnInputs property.
void	setLocalTransformations(LocalTransformations value) Sets the value of the localTransformations property.
void	setMiningSchema(MiningSchema value) Sets the value of the miningSchema property.
void	setModelExplanation(ModelExplanation value) Sets the value of the modelExplanation property.
void	setModelName(java.lang.String value) Sets the value of the modelName property.
void	setModelStats(ModelStats value) Sets the value of the modelStats property.
void	setModelVerification(ModelVerification value) Sets the value of the modelVerification property.
void	setNumberOfNeighbors(java.lang.Integer value) Sets the value of the numberOfNeighbors property.
void	setOutput(Output value) Sets the value of the output property.
void	setScorable(java.lang.Boolean value) Sets the value of the scorable property.
void	setTargets(Targets value) Sets the value of the targets property.
void	setThreshold(java.lang.Double value) Sets the value of the threshold property.
void	setTrainingInstances(TrainingInstances value) Sets the value of the trainingInstances property.
NearestNeighborModel	withAlgorithmName(java.lang.String value)
NearestNeighborModel	withCategoricalScoringMethod(CategoricalScoringMethodType value)
NearestNeighborModel	withComparisonMeasure(ComparisonMeasure value)
NearestNeighborModel	withContinuousScoringMethod(ContinuousScoringMethodType value)
NearestNeighborModel	withExtensions(java.util.Collection<Extension> values)
NearestNeighborModel	withExtensions(Extension... values)
NearestNeighborModel	withFunctionName(MiningFunctionType value)
NearestNeighborModel	withInstanceIdVariable(java.lang.String value)
NearestNeighborModel	withKNNInputs(KNNInputs value)
NearestNeighborModel	withLocalTransformations(LocalTransformations value)
NearestNeighborModel	withMiningSchema(MiningSchema value)
NearestNeighborModel	withModelExplanation(ModelExplanation value)
NearestNeighborModel	withModelName(java.lang.String value)
NearestNeighborModel	withModelStats(ModelStats value)
NearestNeighborModel	withModelVerification(ModelVerification value)
NearestNeighborModel	withNumberOfNeighbors(java.lang.Integer value)
NearestNeighborModel	withOutput(Output value)
NearestNeighborModel	withScorable(java.lang.Boolean value)
NearestNeighborModel	withTargets(Targets value)
NearestNeighborModel	withThreshold(java.lang.Double value)
NearestNeighborModel	withTrainingInstances(TrainingInstances 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

modelName

protected java.lang.String modelName

functionName

protected MiningFunctionType functionName

algorithmName

protected java.lang.String algorithmName

numberOfNeighbors

protected java.lang.Integer numberOfNeighbors

continuousScoringMethod

protected ContinuousScoringMethodType continuousScoringMethod

categoricalScoringMethod

protected CategoricalScoringMethodType categoricalScoringMethod

instanceIdVariable

protected java.lang.String instanceIdVariable

threshold

protected java.lang.Double threshold

scorable

protected java.lang.Boolean scorable

extensions

protected java.util.List<Extension> extensions

miningSchema

protected MiningSchema miningSchema

output

protected Output output

modelStats

protected ModelStats modelStats

modelExplanation

protected ModelExplanation modelExplanation

targets

protected Targets targets

localTransformations

protected LocalTransformations localTransformations

trainingInstances

protected TrainingInstances trainingInstances

comparisonMeasure

protected ComparisonMeasure comparisonMeasure

knnInputs

protected KNNInputs knnInputs

modelVerification

protected ModelVerification modelVerification

Constructor Detail

NearestNeighborModel

public NearestNeighborModel()

NearestNeighborModel

public NearestNeighborModel(MiningFunctionType functionName,
                    java.lang.Integer numberOfNeighbors,
                    MiningSchema miningSchema,
                    TrainingInstances trainingInstances,
                    ComparisonMeasure comparisonMeasure,
                    KNNInputs knnInputs)

Method Detail

getModelName

public java.lang.String getModelName()

Gets the value of the modelName property.

Specified by:

getModelName in class Model

Returns:

possible object is String

setModelName

public void setModelName(java.lang.String value)

Sets the value of the modelName property.

Specified by:

setModelName in class Model

Parameters:

value - allowed object is String

getFunctionName

public MiningFunctionType getFunctionName()

Gets the value of the functionName property.

Specified by:

getFunctionName in class Model

Returns:

possible object is MiningFunctionType

setFunctionName

public void setFunctionName(MiningFunctionType value)

Sets the value of the functionName property.

Specified by:

setFunctionName in class Model

Parameters:

value - allowed object is MiningFunctionType

getAlgorithmName

public java.lang.String getAlgorithmName()

Gets the value of the algorithmName property.

Specified by:

getAlgorithmName in class Model

Returns:

possible object is String

setAlgorithmName

public void setAlgorithmName(java.lang.String value)

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

value - allowed object is String

getNumberOfNeighbors

public java.lang.Integer getNumberOfNeighbors()

Gets the value of the numberOfNeighbors property.

Returns:

possible object is String

setNumberOfNeighbors

public void setNumberOfNeighbors(java.lang.Integer value)

Sets the value of the numberOfNeighbors property.

Parameters:

value - allowed object is String

getContinuousScoringMethod

public ContinuousScoringMethodType getContinuousScoringMethod()

Gets the value of the continuousScoringMethod property.

Returns:

possible object is ContinuousScoringMethodType

setContinuousScoringMethod

public void setContinuousScoringMethod(ContinuousScoringMethodType value)

Sets the value of the continuousScoringMethod property.

Parameters:

value - allowed object is ContinuousScoringMethodType

getCategoricalScoringMethod

public CategoricalScoringMethodType getCategoricalScoringMethod()

Gets the value of the categoricalScoringMethod property.

Returns:

possible object is CategoricalScoringMethodType

setCategoricalScoringMethod

public void setCategoricalScoringMethod(CategoricalScoringMethodType value)

Sets the value of the categoricalScoringMethod property.

Parameters:

value - allowed object is CategoricalScoringMethodType

getInstanceIdVariable

public java.lang.String getInstanceIdVariable()

Gets the value of the instanceIdVariable property.

Returns:

possible object is String

setInstanceIdVariable

public void setInstanceIdVariable(java.lang.String value)

Sets the value of the instanceIdVariable property.

Parameters:

value - allowed object is String

getThreshold

public double getThreshold()

Gets the value of the threshold property.

Returns:

possible object is Double

setThreshold

public void setThreshold(java.lang.Double value)

Sets the value of the threshold property.

Parameters:

value - 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 void setScorable(java.lang.Boolean value)

Sets the value of the scorable property.

Specified by:

setScorable in class Model

Parameters:

value - allowed object is Boolean

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

getMiningSchema

public MiningSchema getMiningSchema()

Gets the value of the miningSchema property.

Specified by:

getMiningSchema in class Model

Returns:

possible object is MiningSchema

setMiningSchema

public void setMiningSchema(MiningSchema value)

Sets the value of the miningSchema property.

Specified by:

setMiningSchema in class Model

Parameters:

value - allowed object is MiningSchema

getOutput

public Output getOutput()

Gets the value of the output property.

Specified by:

getOutput in class Model

Returns:

possible object is Output

setOutput

public void setOutput(Output value)

Sets the value of the output property.

Specified by:

setOutput in class Model

Parameters:

value - 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 void setModelStats(ModelStats value)

Sets the value of the modelStats property.

Specified by:

setModelStats in class Model

Parameters:

value - allowed object is ModelStats

getModelExplanation

public ModelExplanation getModelExplanation()

Gets the value of the modelExplanation property.

Specified by:

getModelExplanation in class Model

Returns:

possible object is ModelExplanation

setModelExplanation

public void setModelExplanation(ModelExplanation value)

Sets the value of the modelExplanation property.

Specified by:

setModelExplanation in class Model

Parameters:

value - allowed object is ModelExplanation

getTargets

public Targets getTargets()

Gets the value of the targets property.

Specified by:

getTargets in class Model

Returns:

possible object is Targets

setTargets

public void setTargets(Targets value)

Sets the value of the targets property.

Specified by:

setTargets in class Model

Parameters:

value - 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 void setLocalTransformations(LocalTransformations value)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

value - allowed object is LocalTransformations

getTrainingInstances

public TrainingInstances getTrainingInstances()

Gets the value of the trainingInstances property.

Returns:

possible object is TrainingInstances

setTrainingInstances

public void setTrainingInstances(TrainingInstances value)

Sets the value of the trainingInstances property.

Parameters:

value - allowed object is TrainingInstances

getComparisonMeasure

public ComparisonMeasure getComparisonMeasure()

Gets the value of the comparisonMeasure property.

Returns:

possible object is ComparisonMeasure

setComparisonMeasure

public void setComparisonMeasure(ComparisonMeasure value)

Sets the value of the comparisonMeasure property.

Parameters:

value - allowed object is ComparisonMeasure

getKNNInputs

public KNNInputs getKNNInputs()

Gets the value of the knnInputs property.

Returns:

possible object is KNNInputs

setKNNInputs

public void setKNNInputs(KNNInputs value)

Sets the value of the knnInputs property.

Parameters:

value - allowed object is KNNInputs

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Specified by:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

public void setModelVerification(ModelVerification value)

Sets the value of the modelVerification property.

Specified by:

setModelVerification in class Model

Parameters:

value - allowed object is ModelVerification

withModelName

public NearestNeighborModel withModelName(java.lang.String value)

withFunctionName

public NearestNeighborModel withFunctionName(MiningFunctionType value)

withAlgorithmName

public NearestNeighborModel withAlgorithmName(java.lang.String value)

withNumberOfNeighbors

public NearestNeighborModel withNumberOfNeighbors(java.lang.Integer value)

withContinuousScoringMethod

public NearestNeighborModel withContinuousScoringMethod(ContinuousScoringMethodType value)

withCategoricalScoringMethod

public NearestNeighborModel withCategoricalScoringMethod(CategoricalScoringMethodType value)

withInstanceIdVariable

public NearestNeighborModel withInstanceIdVariable(java.lang.String value)

withThreshold

public NearestNeighborModel withThreshold(java.lang.Double value)

withScorable

public NearestNeighborModel withScorable(java.lang.Boolean value)

withExtensions

public NearestNeighborModel withExtensions(Extension... values)

withExtensions

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

withMiningSchema

public NearestNeighborModel withMiningSchema(MiningSchema value)

withOutput

public NearestNeighborModel withOutput(Output value)

withModelStats

public NearestNeighborModel withModelStats(ModelStats value)

withModelExplanation

public NearestNeighborModel withModelExplanation(ModelExplanation value)

withTargets

public NearestNeighborModel withTargets(Targets value)

withLocalTransformations

public NearestNeighborModel withLocalTransformations(LocalTransformations value)

withTrainingInstances

public NearestNeighborModel withTrainingInstances(TrainingInstances value)

withComparisonMeasure

public NearestNeighborModel withComparisonMeasure(ComparisonMeasure value)

withKNNInputs

public NearestNeighborModel withKNNInputs(KNNInputs value)

withModelVerification

public NearestNeighborModel withModelVerification(ModelVerification value)

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable