Package adams.data.weka

Class WekaLabelIndex

  • All Implemented Interfaces:
    adams.core.CloneHandler<adams.core.Index>, adams.core.CustomDisplayStringProvider, adams.core.ExampleProvider, adams.core.HelpProvider, Serializable, Comparable<adams.core.Index>
    public class WekaLabelIndex
extends adams.core.AbstractDataBackedIndex<weka.core.Attribute>
    Extended Index class that can use a label name to determine an index of a label as well.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class adams.core.AbstractDataBackedIndex

        m_Data, m_Indices, m_Names

      • Fields inherited from class adams.core.Index

        FIRST, LAST, LAST_1, LAST_2, m_Index, m_IntIndex, m_Max, m_Raw, NUMERIC_START, SECOND, THIRD

    • Constructor Summary

      Constructors 
      Constructor Description
      WekaLabelIndex()
      Initializes with no index.
      WekaLabelIndex​(String index)
      Initializes with the given index, but no maximum.
      WekaLabelIndex​(String index, int max)
      Initializes with the given index and maximum.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      WekaLabelIndex getClone()
      Returns a clone of the object.
      String getExample()
      Returns the example.
      protected String getName​(weka.core.Attribute data, int colIndex)
      Returns the label name at the specified index.
      protected int getNumNames​(weka.core.Attribute data)
      Returns the number of labels that the attribute has.

      • Methods inherited from class adams.core.AbstractDataBackedIndex

        clean, getData, getIndices, getIntIndex, getNames, initialize, isName, parse, replaceName, setData

      • Methods inherited from class adams.core.Index

        compareTo, equals, getHelpDescription, getHelpIcon, getHelpTitle, getHelpURL, getIndex, getIntIndex, getMax, hashCode, hasIndex, isEmpty, isPlaceholder, parsePlaceholder, reset, setIndex, setMax, toDisplay, toString

    • Constructor Detail

      • WekaLabelIndex

        public WekaLabelIndex()
        Initializes with no index.

      • WekaLabelIndex

        public WekaLabelIndex​(String index)
        Initializes with the given index, but no maximum.
        Parameters:
        index - the index to use

      • WekaLabelIndex

        public WekaLabelIndex​(String index,
                      int max)
        Initializes with the given index and maximum.
        Parameters:
        index - the index to use
        max - the maximum of the 1-based index (e.g., use "10" to allow "1-10" or -1 for uninitialized)

    • Method Detail

      • getClone

        public WekaLabelIndex getClone()
        Returns a clone of the object.
        Specified by:
        getClone in interface adams.core.CloneHandler<adams.core.Index>
        Overrides:
        getClone in class adams.core.AbstractDataBackedIndex<weka.core.Attribute>
        Returns:
        the clone

      • getNumNames

        protected int getNumNames​(weka.core.Attribute data)
        Returns the number of labels that the attribute has.
        Specified by:
        getNumNames in class adams.core.AbstractDataBackedIndex<weka.core.Attribute>
        Parameters:
        data - the attribute to retrieve the number of labels

      • getName

        protected String getName​(weka.core.Attribute data,
                         int colIndex)
        Returns the label name at the specified index.
        Specified by:
        getName in class adams.core.AbstractDataBackedIndex<weka.core.Attribute>
        Parameters:
        data - the dataset to use
        colIndex - the label index
        Returns:
        the label name

      • getExample

        public String getExample()
        Returns the example.
        Specified by:
        getExample in interface adams.core.ExampleProvider
        Overrides:
        getExample in class adams.core.Index
        Returns:
        the example