Package adams.flow.container

Class CleaningContainer

  • All Implemented Interfaces:
    adams.core.CloneHandler<adams.flow.container.Container>, adams.core.GlobalInfoSupporter, adams.data.spreadsheet.SpreadSheetSupporter, adams.flow.container.Container, Serializable
    public class CleaningContainer
extends adams.flow.container.AbstractContainer
    Container used by cleaners.
    Version:
    $Revision: 2391 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String VALUE_CHECKS
      the identifier for the checks.
      static String VALUE_CLEANER
      the identifier for the cleaner.
      static String VALUE_INSTANCE
      the identifier for the instance.
      static String VALUE_INSTANCES
      the identifier for the instances.

      • Fields inherited from class adams.flow.container.AbstractContainer

        m_AdditionalNames, m_Help, m_Values

    • Constructor Summary

      Constructors 
      Constructor Description
      CleaningContainer()
      Default constructor.
      CleaningContainer​(weka.core.Instance inst)
      Initializes the container with the WEKA instance.
      CleaningContainer​(weka.core.Instance inst, adams.data.spreadsheet.SpreadSheet checks)
      Initializes the container with the WEKA instance.
      CleaningContainer​(weka.core.Instances inst)
      Initializes the container with the WEKA instances.

    • 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

      • CleaningContainer

        public CleaningContainer()
        Default constructor.

      • CleaningContainer

        public CleaningContainer​(weka.core.Instance inst)
        Initializes the container with the WEKA instance.
        Parameters:
        inst - the instance

      • CleaningContainer

        public CleaningContainer​(weka.core.Instance inst,
                         adams.data.spreadsheet.SpreadSheet checks)
        Initializes the container with the WEKA instance.
        Parameters:
        inst - the instance
        checks - the associated checks

      • CleaningContainer

        public CleaningContainer​(weka.core.Instances inst)
        Initializes the container with the WEKA instances.
        Parameters:
        inst - the instances

    • 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