Package adams.flow.container

Class ThreeWayDataModelContainer

  • All Implemented Interfaces:
    adams.core.CloneHandler<adams.flow.container.Container>, adams.core.GlobalInfoSupporter, adams.data.spreadsheet.SpreadSheetSupporter, adams.flow.container.Container, Serializable
    public class ThreeWayDataModelContainer
extends adams.flow.container.AbstractContainer
    Container for spectrum filters.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String VALUE_MODEL
      the model key.
      static String VALUE_TRAIN
      the training data key.

      • 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 initFilterHelp()
      Initializes help strings specific to the filter.
      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, initHelp, isValidName, removeAdditionalName, setValue, store, stored, toSpreadSheet, toString

    • Constructor Detail

      • ThreeWayDataModelContainer

        public ThreeWayDataModelContainer()
        Initializes the container.

        Only used for generating help information.

      • ThreeWayDataModelContainer

        public ThreeWayDataModelContainer​(nz.ac.waikato.cms.adams.multiway.algorithm.api.AbstractAlgorithm model,
                                  TensorContainer train)
        Initializes the container with the model and the associated data.
        Parameters:
        model - the model
        train - the dataset, can be null

      • ThreeWayDataModelContainer

        public ThreeWayDataModelContainer​(nz.ac.waikato.cms.adams.multiway.algorithm.api.AbstractAlgorithm model,
                                  TensorContainer[] train)
        Initializes the container with the model and the associated data.
        Parameters:
        model - the model
        train - the dataset, can be null

    • Method Detail

      • initFilterHelp

        protected void initFilterHelp()
        Initializes help strings specific to the filter.

      • 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:
        iterator 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