Package adams.data.multispectrumoperation

Class Remove

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, Serializable
    public class Remove
extends AbstractMultiSpectrumOperation
    Removes all spectra from the multi-spectrum that match the criteria.

    Input/output:
    - accepts:
       knir.data.spectrum.MultiSpectrum
    - generates:
       knir.data.spectrum.MultiSpectrum


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: RemoveFromMultiSpectrum
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -sample-id <adams.core.base.BaseRegExp> (property: sampleID)
    The regular expression that the sample ID of a spectrum must match in order 
    to get removed.
    default: 
 
    -sample-type <adams.core.base.BaseRegExp> (property: sampleType)
    The regular expression that the sample type of a spectrum must match in 
    order to get removed.
    default: 
 
    -format <adams.core.base.BaseRegExp> (property: format)
    The regular expression that the format of a spectrum must match in order 
    to get removed.
    default:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.core.base.BaseRegExp m_Format
      the regular expression for the format.
      protected adams.core.base.BaseRegExp m_SampleID
      the regular expression for the sample ID.
      protected adams.core.base.BaseRegExp m_SampleType
      the regular expression for the sample type.

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Constructor Summary

      Constructors 
      Constructor Description
      Remove()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class[] accepts()
      Returns the class that the consumer accepts.
      void defineOptions()
      Adds options to the internal list of options.
      protected MultiSpectrum doApply​(MultiSpectrum multi, adams.core.MessageCollection errors)
      Executes the flow item.
      String formatTipText()
      Returns the tip text for this property.
      Class[] generates()
      Returns the class of objects that it generates.
      adams.core.base.BaseRegExp getFormat()
      Returns the regular expression that the format of a spectrum must match in order to get removed.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      adams.core.base.BaseRegExp getSampleID()
      Returns the regular expression that the sample ID of a spectrum must match in order to get removed.
      adams.core.base.BaseRegExp getSampleType()
      Returns the regular expression that the sample Type of a spectrum must match in order to get removed.
      String globalInfo()
      Returns a string describing the object.
      String sampleIDTipText()
      Returns the tip text for this property.
      String sampleTypeTipText()
      Returns the tip text for this property.
      void setFormat​(adams.core.base.BaseRegExp value)
      Sets the regular expression that the format of a spectrum must match in order to get removed.
      void setSampleID​(adams.core.base.BaseRegExp value)
      Sets the regular expression that the sample ID of a spectrum must match in order to get removed.
      void setSampleType​(adams.core.base.BaseRegExp value)
      Sets the regular expression that the sample Type of a spectrum must match in order to get removed.

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_SampleID

        protected adams.core.base.BaseRegExp m_SampleID
        the regular expression for the sample ID.

      • m_SampleType

        protected adams.core.base.BaseRegExp m_SampleType
        the regular expression for the sample type.

      • m_Format

        protected adams.core.base.BaseRegExp m_Format
        the regular expression for the format.

    • Constructor Detail

      • Remove

        public Remove()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.core.option.AbstractOptionHandler

      • setSampleID

        public void setSampleID​(adams.core.base.BaseRegExp value)
        Sets the regular expression that the sample ID of a spectrum must match in order to get removed.
        Parameters:
        value - the regular expression

      • getSampleID

        public adams.core.base.BaseRegExp getSampleID()
        Returns the regular expression that the sample ID of a spectrum must match in order to get removed.
        Returns:
        the regular expression

      • sampleIDTipText

        public String sampleIDTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setSampleType

        public void setSampleType​(adams.core.base.BaseRegExp value)
        Sets the regular expression that the sample Type of a spectrum must match in order to get removed.
        Parameters:
        value - the regular expression

      • getSampleType

        public adams.core.base.BaseRegExp getSampleType()
        Returns the regular expression that the sample Type of a spectrum must match in order to get removed.
        Returns:
        the regular expression

      • sampleTypeTipText

        public String sampleTypeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setFormat

        public void setFormat​(adams.core.base.BaseRegExp value)
        Sets the regular expression that the format of a spectrum must match in order to get removed.
        Parameters:
        value - the regular expression

      • getFormat

        public adams.core.base.BaseRegExp getFormat()
        Returns the regular expression that the format of a spectrum must match in order to get removed.
        Returns:
        the regular expression

      • formatTipText

        public String formatTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractMultiSpectrumOperation
        Returns:
        null if no info available, otherwise short string

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        the default DataContainer class for the project

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the default DataContainer class for the project

      • doApply

        protected MultiSpectrum doApply​(MultiSpectrum multi,
                                adams.core.MessageCollection errors)
        Executes the flow item.
        Specified by:
        doApply in class AbstractMultiSpectrumOperation
        Parameters:
        multi - the data to process
        errors - for collecting errors
        Returns:
        null if everything is fine, otherwise error message