NearestNeighborModel (Drools :: PMML - Compiler 6.3.0.CR1 API)

java.lang.Object
- org.dmg.pmml.pmml_4_2.descr.NearestNeighborModel

All Implemented Interfaces:: Serializable

public class NearestNeighborModel
extends Object
implements Serializable

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"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Extension" maxOccurs="unbounded" 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 String`	`algorithmName`
`protected CATSCORINGMETHOD`	`categoricalScoringMethod`
`protected CONTSCORINGMETHOD`	`continuousScoringMethod`
`protected List<Serializable>`	`extensionsAndKNNInputsAndComparisonMeasures`
`protected MININGFUNCTION`	`functionName`
`protected String`	`instanceIdVariable`
`protected Boolean`	`isScorable`
`protected String`	`modelName`
`protected BigInteger`	`numberOfNeighbors`
`protected Double`	`threshold`

Constructor Summary

Constructors
Constructor and Description

NearestNeighborModel()

Constructors
Constructor and Description
`NearestNeighborModel()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAlgorithmName()` Gets the value of the algorithmName property.
`CATSCORINGMETHOD`	`getCategoricalScoringMethod()` Gets the value of the categoricalScoringMethod property.
`CONTSCORINGMETHOD`	`getContinuousScoringMethod()` Gets the value of the continuousScoringMethod property.
`List<Serializable>`	`getExtensionsAndKNNInputsAndComparisonMeasures()` Gets the value of the extensionsAndKNNInputsAndComparisonMeasures property.
`MININGFUNCTION`	`getFunctionName()` Gets the value of the functionName property.
`String`	`getInstanceIdVariable()` Gets the value of the instanceIdVariable property.
`String`	`getModelName()` Gets the value of the modelName property.
`BigInteger`	`getNumberOfNeighbors()` Gets the value of the numberOfNeighbors property.
`double`	`getThreshold()` Gets the value of the threshold property.
`boolean`	`isIsScorable()` Gets the value of the isScorable property.
`void`	`setAlgorithmName(String value)` Sets the value of the algorithmName property.
`void`	`setCategoricalScoringMethod(CATSCORINGMETHOD value)` Sets the value of the categoricalScoringMethod property.
`void`	`setContinuousScoringMethod(CONTSCORINGMETHOD value)` Sets the value of the continuousScoringMethod property.
`void`	`setFunctionName(MININGFUNCTION value)` Sets the value of the functionName property.
`void`	`setInstanceIdVariable(String value)` Sets the value of the instanceIdVariable property.
`void`	`setIsScorable(Boolean value)` Sets the value of the isScorable property.
`void`	`setModelName(String value)` Sets the value of the modelName property.
`void`	`setNumberOfNeighbors(BigInteger value)` Sets the value of the numberOfNeighbors property.
`void`	`setThreshold(Double value)` Sets the value of the threshold property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - extensionsAndKNNInputsAndComparisonMeasures
```
protected List<Serializable> extensionsAndKNNInputsAndComparisonMeasures
```
  - modelName
```
protected String modelName
```
  - functionName
```
protected MININGFUNCTION functionName
```
  - algorithmName
```
protected String algorithmName
```
  - numberOfNeighbors
```
protected BigInteger numberOfNeighbors
```
  - continuousScoringMethod
```
protected CONTSCORINGMETHOD continuousScoringMethod
```
  - categoricalScoringMethod
```
protected CATSCORINGMETHOD categoricalScoringMethod
```
  - instanceIdVariable
```
protected String instanceIdVariable
```
  - threshold
```
protected Double threshold
```
  - isScorable
```
protected Boolean isScorable
```
- Constructor Detail
  - NearestNeighborModel
```
public NearestNeighborModel()
```
- Method Detail
  - getExtensionsAndKNNInputsAndComparisonMeasures
```
public List<Serializable> getExtensionsAndKNNInputsAndComparisonMeasures()
```
    Gets the value of the extensionsAndKNNInputsAndComparisonMeasures 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 extensionsAndKNNInputsAndComparisonMeasures property.
    For example, to add a new item, do as follows:
```
    getExtensionsAndKNNInputsAndComparisonMeasures().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list LocalTransformations ModelExplanation ModelVerification TrainingInstances ModelStats KNNInputs Output Targets ComparisonMeasure Extension MiningSchema
  - getModelName
```
public String getModelName()
```
    Gets the value of the modelName property.
    
    Returns:
    possible object is String
  - setModelName
```
public void setModelName(String value)
```
    Sets the value of the modelName property.
    
    Parameters:
    value - allowed object is String
  - getFunctionName
```
public MININGFUNCTION getFunctionName()
```
    Gets the value of the functionName property.
    
    Returns:
    possible object is MININGFUNCTION
  - setFunctionName
```
public void setFunctionName(MININGFUNCTION value)
```
    Sets the value of the functionName property.
    
    Parameters:
    value - allowed object is MININGFUNCTION
  - getAlgorithmName
```
public String getAlgorithmName()
```
    Gets the value of the algorithmName property.
    
    Returns:
    possible object is String
  - setAlgorithmName
```
public void setAlgorithmName(String value)
```
    Sets the value of the algorithmName property.
    
    Parameters:
    value - allowed object is String
  - getNumberOfNeighbors
```
public BigInteger getNumberOfNeighbors()
```
    Gets the value of the numberOfNeighbors property.
    
    Returns:
    possible object is BigInteger
  - setNumberOfNeighbors
```
public void setNumberOfNeighbors(BigInteger value)
```
    Sets the value of the numberOfNeighbors property.
    
    Parameters:
    value - allowed object is BigInteger
  - getContinuousScoringMethod
```
public CONTSCORINGMETHOD getContinuousScoringMethod()
```
    Gets the value of the continuousScoringMethod property.
    
    Returns:
    possible object is CONTSCORINGMETHOD
  - setContinuousScoringMethod
```
public void setContinuousScoringMethod(CONTSCORINGMETHOD value)
```
    Sets the value of the continuousScoringMethod property.
    
    Parameters:
    value - allowed object is CONTSCORINGMETHOD
  - getCategoricalScoringMethod
```
public CATSCORINGMETHOD getCategoricalScoringMethod()
```
    Gets the value of the categoricalScoringMethod property.
    
    Returns:
    possible object is CATSCORINGMETHOD
  - setCategoricalScoringMethod
```
public void setCategoricalScoringMethod(CATSCORINGMETHOD value)
```
    Sets the value of the categoricalScoringMethod property.
    
    Parameters:
    value - allowed object is CATSCORINGMETHOD
  - getInstanceIdVariable
```
public String getInstanceIdVariable()
```
    Gets the value of the instanceIdVariable property.
    
    Returns:
    possible object is String
  - setInstanceIdVariable
```
public void setInstanceIdVariable(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(Double value)
```
    Sets the value of the threshold property.
    
    Parameters:
    value - allowed object is Double
  - isIsScorable
```
public boolean isIsScorable()
```
    Gets the value of the isScorable property.
    
    Returns:
    possible object is Boolean
  - setIsScorable
```
public void setIsScorable(Boolean value)
```
    Sets the value of the isScorable property.
    
    Parameters:
    value - allowed object is Boolean

Class NearestNeighborModel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

extensionsAndKNNInputsAndComparisonMeasures

modelName

functionName

algorithmName

numberOfNeighbors

continuousScoringMethod

categoricalScoringMethod

instanceIdVariable

threshold

isScorable

Constructor Detail

NearestNeighborModel

Method Detail

getExtensionsAndKNNInputsAndComparisonMeasures

getModelName

setModelName

getFunctionName

setFunctionName

getAlgorithmName

setAlgorithmName

getNumberOfNeighbors

setNumberOfNeighbors

getContinuousScoringMethod

setContinuousScoringMethod

getCategoricalScoringMethod

setCategoricalScoringMethod

getInstanceIdVariable

setInstanceIdVariable

getThreshold

setThreshold

isIsScorable

setIsScorable