Package adams.gui.visualization.spectrum

Class SpectrumContainer

  • All Implemented Interfaces:
    adams.data.id.DatabaseIDHandler, adams.data.id.IDHandler, adams.data.id.MutableIDHandler, adams.gui.visualization.container.ColorContainer, adams.gui.visualization.container.DatabaseContainer, adams.gui.visualization.container.NamedContainer, adams.gui.visualization.container.VisibilityContainer, Serializable, Comparable<adams.gui.visualization.container.AbstractContainer>
    public class SpectrumContainer
extends adams.gui.visualization.container.AbstractContainer
implements adams.gui.visualization.container.VisibilityContainer, adams.gui.visualization.container.NamedContainer, adams.gui.visualization.container.ColorContainer, adams.gui.visualization.container.DatabaseContainer
    A container class for a spectrum and additional information.
    Version:
    $Revision: 2195 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected Color m_Color
      the associated color.
      protected boolean m_Visible
      whether the spectrum is visible.

      • Fields inherited from class adams.gui.visualization.container.AbstractContainer

        m_Manager, m_Payload, m_Updating

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void assign​(adams.gui.visualization.container.AbstractContainer c)
      Updates itself with the values from given container (the manager is excluded!).
      Color getColor()
      Returns the current color in use.
      Spectrum getData()
      Returns the stored spectrum.
      int getDatabaseID()
      Returns the database ID.
      String getDisplayID()
      Returns an ID to be used in the GUI (the DB ID with added single quotes to make it unique among the spectra in the container manager).
      String getID()
      Returns the ID used for display.
      int hashCode()
      Returns the hashcode of the ID string.
      protected void initialize()
      Initializes members.
      boolean isVisible()
      Returns whether the spectrum is visible.
      void setColor​(Color value)
      Sets the color to use.
      void setData​(Spectrum value)
      Sets the spectrum.
      void setID​(String value)
      Sets the ID to use for display.
      void setVisible​(boolean value)
      Sets the spectra visibility.
      String toString()
      Returns a short string representation of the container.

      • Methods inherited from class adams.gui.visualization.container.AbstractContainer

        compareTo, copy, equals, getManager, getPayload, invalidate, postProcessPayload, setManager, setPayload

    • Field Detail

      • m_Visible

        protected boolean m_Visible
        whether the spectrum is visible.

      • m_Color

        protected Color m_Color
        the associated color.

    • Constructor Detail

      • SpectrumContainer

        public SpectrumContainer​(SpectrumContainerManager manager,
                         Spectrum data)
        Initializes the container.
        Parameters:
        manager - the owning manager
        data - the spectrum to store (visible)

    • Method Detail

      • initialize

        protected void initialize()
        Initializes members.
        Overrides:
        initialize in class adams.gui.visualization.container.AbstractContainer

      • setID

        public void setID​(String value)
        Sets the ID to use for display.
        Specified by:
        setID in interface adams.data.id.MutableIDHandler
        Specified by:
        setID in interface adams.gui.visualization.container.NamedContainer
        Parameters:
        value - the ID

      • getID

        public String getID()
        Returns the ID used for display.
        Specified by:
        getID in interface adams.data.id.IDHandler
        Specified by:
        getID in interface adams.gui.visualization.container.NamedContainer
        Returns:
        the ID

      • getDisplayID

        public String getDisplayID()
        Returns an ID to be used in the GUI (the DB ID with added single quotes to make it unique among the spectra in the container manager).
        Specified by:
        getDisplayID in interface adams.gui.visualization.container.NamedContainer
        Returns:
        a short ID for the GUI

      • setData

        public void setData​(Spectrum value)
        Sets the spectrum.
        Parameters:
        value - the spectrum

      • getData

        public Spectrum getData()
        Returns the stored spectrum.
        Returns:
        the spectrum

      • setVisible

        public void setVisible​(boolean value)
        Sets the spectra visibility.
        Specified by:
        setVisible in interface adams.gui.visualization.container.VisibilityContainer
        Parameters:
        value - if true then the spectrum will be visible

      • isVisible

        public boolean isVisible()
        Returns whether the spectrum is visible.
        Specified by:
        isVisible in interface adams.gui.visualization.container.VisibilityContainer
        Returns:
        true if the spectrum is visible

      • setColor

        public void setColor​(Color value)
        Sets the color to use.
        Specified by:
        setColor in interface adams.gui.visualization.container.ColorContainer
        Parameters:
        value - the color

      • getColor

        public Color getColor()
        Returns the current color in use.
        Specified by:
        getColor in interface adams.gui.visualization.container.ColorContainer
        Returns:
        the color

      • getDatabaseID

        public int getDatabaseID()
        Returns the database ID.
        Specified by:
        getDatabaseID in interface adams.data.id.DatabaseIDHandler
        Returns:
        the database ID

      • assign

        public void assign​(adams.gui.visualization.container.AbstractContainer c)
        Updates itself with the values from given container (the manager is excluded!). Derived classes need to override this method.
        Overrides:
        assign in class adams.gui.visualization.container.AbstractContainer
        Parameters:
        c - the container to get the values from

      • hashCode

        public int hashCode()
        Returns the hashcode of the ID string.
        Overrides:
        hashCode in class Object
        Returns:
        the hashcode

      • toString

        public String toString()
        Returns a short string representation of the container.
        Overrides:
        toString in class adams.gui.visualization.container.AbstractContainer
        Returns:
        a string representation