Package adams.flow.container

Class WekaNearestNeighborSearchContainer

  • All Implemented Interfaces:
    adams.core.CloneHandler<adams.flow.container.Container>, adams.core.GlobalInfoSupporter, adams.data.spreadsheet.SpreadSheetSupporter, adams.flow.container.Container, Serializable
    public class WekaNearestNeighborSearchContainer
extends adams.flow.container.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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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

    • 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 adams.flow.container.AbstractContainer

      • names

        public Iterator<String> names()
        Returns all value names that can be used (theoretically).
        Specified by:
        names in interface adams.flow.container.Container
        Specified by:
        names in class adams.flow.container.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 adams.flow.container.Container
        Specified by:
        isValid in class adams.flow.container.AbstractContainer
        Returns:
        true if all the necessary values are available