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<NearestNeighborModel>, HasLocator, Visitable

public class NearestNeighborModel
extends Model
implements HasExtensions<NearestNeighborModel>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NearestNeighborModel.CategoricalScoringMethod
static class	NearestNeighborModel.ContinuousScoringMethod

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
NearestNeighborModel	addExtensions(Extension... extensions)
String	getAlgorithmName()
NearestNeighborModel.CategoricalScoringMethod	getCategoricalScoringMethod()
ComparisonMeasure	getComparisonMeasure()
NearestNeighborModel.ContinuousScoringMethod	getContinuousScoringMethod()
List<Extension>	getExtensions()
String	getInstanceIdVariable()
KNNInputs	getKNNInputs()
LocalTransformations	getLocalTransformations()
MathContext	getMathContext()
MiningFunction	getMiningFunction()
MiningSchema	getMiningSchema()
ModelExplanation	getModelExplanation()
String	getModelName()
ModelStats	getModelStats()
ModelVerification	getModelVerification()
Integer	getNumberOfNeighbors()
Output	getOutput()
Targets	getTargets()
Number	getThreshold()
TrainingInstances	getTrainingInstances()
boolean	hasExtensions()
boolean	isScorable()
ComparisonMeasure	requireComparisonMeasure()
KNNInputs	requireKNNInputs()
MiningFunction	requireMiningFunction()
MiningSchema	requireMiningSchema()
Integer	requireNumberOfNeighbors()
TrainingInstances	requireTrainingInstances()
NearestNeighborModel	setAlgorithmName(String algorithmName)
NearestNeighborModel	setCategoricalScoringMethod(NearestNeighborModel.CategoricalScoringMethod categoricalScoringMethod)
NearestNeighborModel	setComparisonMeasure(ComparisonMeasure comparisonMeasure)
NearestNeighborModel	setContinuousScoringMethod(NearestNeighborModel.ContinuousScoringMethod continuousScoringMethod)
NearestNeighborModel	setInstanceIdVariable(String instanceIdVariable)
NearestNeighborModel	setKNNInputs(KNNInputs knnInputs)
NearestNeighborModel	setLocalTransformations(LocalTransformations localTransformations)
NearestNeighborModel	setMathContext(MathContext mathContext)
NearestNeighborModel	setMiningFunction(MiningFunction miningFunction)
NearestNeighborModel	setMiningSchema(MiningSchema miningSchema)
NearestNeighborModel	setModelExplanation(ModelExplanation modelExplanation)
NearestNeighborModel	setModelName(String modelName)
NearestNeighborModel	setModelStats(ModelStats modelStats)
NearestNeighborModel	setModelVerification(ModelVerification modelVerification)
NearestNeighborModel	setNumberOfNeighbors(Integer numberOfNeighbors)
NearestNeighborModel	setOutput(Output output)
NearestNeighborModel	setScorable(Boolean scorable)
NearestNeighborModel	setTargets(Targets targets)
NearestNeighborModel	setThreshold(Number threshold)
NearestNeighborModel	setTrainingInstances(TrainingInstances trainingInstances)

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, hasLocator, 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,
                            Integer numberOfNeighbors,
                            MiningSchema miningSchema,
                            TrainingInstances trainingInstances,
                            ComparisonMeasure comparisonMeasure,
                            KNNInputs knnInputs)

Method Detail

getModelName

public String getModelName()

Specified by:

getModelName in class Model

setModelName

public NearestNeighborModel setModelName(String modelName)

Specified by:

setModelName in class Model

requireMiningFunction

public MiningFunction requireMiningFunction()

Specified by:

requireMiningFunction in class Model

getMiningFunction

public MiningFunction getMiningFunction()

Specified by:

getMiningFunction in class Model

setMiningFunction

public NearestNeighborModel setMiningFunction(MiningFunction miningFunction)

Specified by:

setMiningFunction in class Model

getAlgorithmName

public String getAlgorithmName()

Specified by:

getAlgorithmName in class Model

setAlgorithmName

public NearestNeighborModel setAlgorithmName(String algorithmName)

Specified by:

setAlgorithmName in class Model

requireNumberOfNeighbors

public Integer requireNumberOfNeighbors()

getNumberOfNeighbors

public Integer getNumberOfNeighbors()

setNumberOfNeighbors

public NearestNeighborModel setNumberOfNeighbors(Integer numberOfNeighbors)

getContinuousScoringMethod

public NearestNeighborModel.ContinuousScoringMethod getContinuousScoringMethod()

setContinuousScoringMethod

public NearestNeighborModel setContinuousScoringMethod(NearestNeighborModel.ContinuousScoringMethod continuousScoringMethod)

getCategoricalScoringMethod

public NearestNeighborModel.CategoricalScoringMethod getCategoricalScoringMethod()

setCategoricalScoringMethod

public NearestNeighborModel setCategoricalScoringMethod(NearestNeighborModel.CategoricalScoringMethod categoricalScoringMethod)

getInstanceIdVariable

public String getInstanceIdVariable()

setInstanceIdVariable

public NearestNeighborModel setInstanceIdVariable(String instanceIdVariable)

getThreshold

public Number getThreshold()

setThreshold

public NearestNeighborModel setThreshold(Number threshold)

isScorable

public boolean isScorable()

Specified by:

isScorable in class Model

setScorable

public NearestNeighborModel setScorable(Boolean scorable)

Specified by:

setScorable in class Model

getMathContext

public MathContext getMathContext()

Specified by:

getMathContext in class Model

setMathContext

public NearestNeighborModel setMathContext(MathContext mathContext)

Specified by:

setMathContext in class Model

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions<NearestNeighborModel>

getExtensions

public List<Extension> getExtensions()

Specified by:

getExtensions in interface HasExtensions<NearestNeighborModel>

addExtensions

public NearestNeighborModel addExtensions(Extension... extensions)

Specified by:

addExtensions in interface HasExtensions<NearestNeighborModel>

requireMiningSchema

public MiningSchema requireMiningSchema()

Specified by:

requireMiningSchema in class Model

getMiningSchema

public MiningSchema getMiningSchema()

Specified by:

getMiningSchema in class Model

setMiningSchema

public NearestNeighborModel setMiningSchema(MiningSchema miningSchema)

Specified by:

setMiningSchema in class Model

getOutput

public Output getOutput()

Overrides:

getOutput in class Model

setOutput

public NearestNeighborModel setOutput(Output output)

Overrides:

setOutput in class Model

getModelStats

public ModelStats getModelStats()

Overrides:

getModelStats in class Model

setModelStats

public NearestNeighborModel setModelStats(ModelStats modelStats)

Overrides:

setModelStats in class Model

getModelExplanation

public ModelExplanation getModelExplanation()

Overrides:

getModelExplanation in class Model

setModelExplanation

public NearestNeighborModel setModelExplanation(ModelExplanation modelExplanation)

Overrides:

setModelExplanation in class Model

getTargets

public Targets getTargets()

Overrides:

getTargets in class Model

setTargets

public NearestNeighborModel setTargets(Targets targets)

Overrides:

setTargets in class Model

getLocalTransformations

public LocalTransformations getLocalTransformations()

Specified by:

getLocalTransformations in class Model

setLocalTransformations

public NearestNeighborModel setLocalTransformations(LocalTransformations localTransformations)

Specified by:

setLocalTransformations in class Model

requireTrainingInstances

public TrainingInstances requireTrainingInstances()

getTrainingInstances

public TrainingInstances getTrainingInstances()

setTrainingInstances

public NearestNeighborModel setTrainingInstances(TrainingInstances trainingInstances)

requireComparisonMeasure

public ComparisonMeasure requireComparisonMeasure()

getComparisonMeasure

public ComparisonMeasure getComparisonMeasure()

setComparisonMeasure

public NearestNeighborModel setComparisonMeasure(ComparisonMeasure comparisonMeasure)

requireKNNInputs

public KNNInputs requireKNNInputs()

getKNNInputs

public KNNInputs getKNNInputs()

setKNNInputs

public NearestNeighborModel setKNNInputs(KNNInputs knnInputs)

getModelVerification

public ModelVerification getModelVerification()

Overrides:

getModelVerification in class Model

setModelVerification

public NearestNeighborModel setModelVerification(ModelVerification modelVerification)

Overrides:

setModelVerification in class Model

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable