Package adams.flow.container

Class MOAModelContainer

  • All Implemented Interfaces:
    adams.core.CloneHandler<adams.flow.container.Container>, adams.core.GlobalInfoSupporter, adams.data.spreadsheet.SpreadSheetSupporter, adams.flow.container.Container, Serializable
    public class MOAModelContainer
extends adams.flow.container.AbstractContainer
    A container for models (e.g., classifier or clusterer) and an optional header of a dataset.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz), Corey Sterling (coreytsterling at gmail dot com)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String VALUE_DATASET
      the identifier for the full dataset.
      static String VALUE_HEADER
      the identifier for the Header.
      static String VALUE_MODEL
      the identifier for the Model.

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

        m_AdditionalNames, m_Help, m_Values

    • Constructor Summary

      Constructors 
      Constructor Description
      MOAModelContainer()
      Initializes the container.
      MOAModelContainer​(Object model)
      Initializes the container with no header.
      MOAModelContainer​(Object model, com.yahoo.labs.samoa.instances.Instances header)
      Initializes the container with no header.
      MOAModelContainer​(Object model, com.yahoo.labs.samoa.instances.Instances header, com.yahoo.labs.samoa.instances.Instances data)
      Initializes the container with no header.

    • 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

      • MOAModelContainer

        public MOAModelContainer()
        Initializes the container.

        Only used for generating help information.

      • MOAModelContainer

        public MOAModelContainer​(Object model)
        Initializes the container with no header.
        Parameters:
        model - the model to use

      • MOAModelContainer

        public MOAModelContainer​(Object model,
                         com.yahoo.labs.samoa.instances.Instances header)
        Initializes the container with no header.
        Parameters:
        model - the model to use
        header - the header to use

      • MOAModelContainer

        public MOAModelContainer​(Object model,
                         com.yahoo.labs.samoa.instances.Instances header,
                         com.yahoo.labs.samoa.instances.Instances data)
        Initializes the container with no header.
        Parameters:
        model - the model to use
        header - the header to use
        data - the data to use

    • 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