Package adams.flow.container

Class WekaNearestNeighborSearchContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.WekaNearestNeighborSearchContainer

All Implemented Interfaces:

CloneHandler<Container>, GlobalInfoSupporter, SpreadSheetSupporter, Container, Serializable

public class WekaNearestNeighborSearchContainer
extends AbstractContainer

A container for nearest neighbor search (instance and neighborhood).

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	VALUE_DISTANCES	the identifier for the distances.
static String	VALUE_INSTANCE	the identifier for the Instance.
static String	VALUE_NEIGHBORHOOD	the identifier for the neighborhood.

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
WekaNearestNeighborSearchContainer()	Initializes the container.
WekaNearestNeighborSearchContainer(weka.core.Instance inst, weka.core.Instances hood)	Initializes the container with the filter and the associated data.
WekaNearestNeighborSearchContainer(weka.core.Instance inst, weka.core.Instances hood, double[] distances)	Initializes the container with the filter and the associated data.

Method Summary

Modifier and Type	Method	Description
protected void	initHelp()	Initializes the help strings.
boolean	isValid()	Checks whether the setup of the container is valid.
Iterator<String>	names()	Returns all value names that can be used (theoretically).

Methods inherited from class adams.flow.container.AbstractContainer

addAdditionalName, addHelp, addHelp, addHelp, checkDefaultConstructor, getClone, getHelp, getValue, getValue, globalInfo, hasHelp, hasValue, isValidName, removeAdditionalName, setValue, store, stored, toSpreadSheet, toString

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_INSTANCE

public static final String VALUE_INSTANCE

the identifier for the Instance.

See Also:

Constant Field Values

VALUE_NEIGHBORHOOD

public static final String VALUE_NEIGHBORHOOD

the identifier for the neighborhood.

See Also:

Constant Field Values

VALUE_DISTANCES

public static final String VALUE_DISTANCES

the identifier for the distances.

See Also:

Constant Field Values

Constructor Detail

WekaNearestNeighborSearchContainer

public WekaNearestNeighborSearchContainer()

Initializes the container.

Only used for generating help information.

WekaNearestNeighborSearchContainer

public WekaNearestNeighborSearchContainer(weka.core.Instance inst,
                                          weka.core.Instances hood)

Initializes the container with the filter and the associated data.

Parameters:

inst - the instance that triggered the nearest neighbor search

hood - the neighborhood

WekaNearestNeighborSearchContainer

public WekaNearestNeighborSearchContainer(weka.core.Instance inst,
                                          weka.core.Instances hood,
                                          double[] distances)

Initializes the container with the filter and the associated data.

Parameters:

inst - the instance that triggered the nearest neighbor search

hood - the neighborhood

distances - the distances, can be null

Method Detail

initHelp

protected void initHelp()

Initializes the help strings.

Overrides:

initHelp in class AbstractContainer

names

public Iterator<String> names()

Returns all value names that can be used (theoretically).

Specified by:

names in interface Container

Specified by:

names in class AbstractContainer

Returns:

enumeration over all possible value names

isValid

public boolean isValid()

Checks whether the setup of the container is valid.

Specified by:

isValid in interface Container

Specified by:

isValid in class AbstractContainer

Returns:

true if all the necessary values are available