Package adams.db

Class SpectrumIDConditions

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.option.PreGetOptionslistHook, adams.core.SizeOfHandler, adams.db.DataContainerConditions, SampleIDRegExpSupporter, SampleTypeRegExpSupporter, Serializable
    public class SpectrumIDConditions
extends adams.db.AbstractLimitedConditions
implements adams.db.DataContainerConditions, SampleIDRegExpSupporter, SampleTypeRegExpSupporter
    Conditions for the retrieval of spectrum IDs.

    Valid options are: 

    -D (property: debug)
         If set to true, scheme may output additional info to the console.
 
    -limit <int> (property: limit)
         The maximum number of IDs to retrieve.
         default: 10000
 
    -sampleid <java.lang.String> (property: regexSampleID)
         The regular expression on the spectrum ID.
         default:
 
    -format <java.lang.String> (property: format)
         The regular expression on the data format.
         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 on the format type of the spectrum.
      protected adams.core.base.BaseRegExp m_SampleIDRegExp
      the regular expression on the name of the spectrum.
      protected adams.core.base.BaseRegExp m_SampleTypeRegExp
      the regular expression on the type of the spectrum.

      • Fields inherited from class adams.db.AbstractLimitedConditions

        m_Limit

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      String formatTipText()
      Returns the tip text for this property.
      adams.core.base.BaseRegExp getFormat()
      Returns the regular expression for the format.
      adams.core.base.BaseRegExp getSampleIDRegExp()
      Returns the regular expression for the spectrum name.
      adams.core.base.BaseRegExp getSampleTypeRegExp()
      Returns the regular expression for the sample type.
      String globalInfo()
      Returns a string describing the object.
      String sampleIDRegExpTipText()
      Returns the tip text for this property.
      String sampleTypeRegExpTipText()
      Returns the tip text for this property.
      void setFormat​(adams.core.base.BaseRegExp value)
      Sets the regular expression for the format.
      void setSampleIDRegExp​(adams.core.base.BaseRegExp value)
      Sets the regular expression for the spectrum name.
      void setSampleTypeRegExp​(adams.core.base.BaseRegExp value)
      Sets the regular expression for the sample type.
      void update()
      Automatically corrects values.

      • Methods inherited from class adams.db.AbstractLimitedConditions

        getDefaultLimit, getLimit, limitTipText, setLimit

      • Methods inherited from class adams.db.AbstractConditions

        check, compareTo, equals, forCommandLine, forName, getFilters, preGetOptionsList, shallowCopy, shallowCopy

      • 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_SampleIDRegExp

        protected adams.core.base.BaseRegExp m_SampleIDRegExp
        the regular expression on the name of the spectrum.

      • m_SampleTypeRegExp

        protected adams.core.base.BaseRegExp m_SampleTypeRegExp
        the regular expression on the type of the spectrum.

      • m_Format

        protected adams.core.base.BaseRegExp m_Format
        the regular expression on the format type of the spectrum.

    • Constructor Detail

      • SpectrumIDConditions

        public SpectrumIDConditions()

    • 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.db.AbstractLimitedConditions

      • setSampleIDRegExp

        public void setSampleIDRegExp​(adams.core.base.BaseRegExp value)
        Sets the regular expression for the spectrum name.
        Specified by:
        setSampleIDRegExp in interface SampleIDRegExpSupporter
        Parameters:
        value - the regular expression

      • getSampleIDRegExp

        public adams.core.base.BaseRegExp getSampleIDRegExp()
        Returns the regular expression for the spectrum name.
        Specified by:
        getSampleIDRegExp in interface SampleIDRegExpSupporter
        Returns:
        the regular expression

      • sampleIDRegExpTipText

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

      • setSampleTypeRegExp

        public void setSampleTypeRegExp​(adams.core.base.BaseRegExp value)
        Sets the regular expression for the sample type.
        Specified by:
        setSampleTypeRegExp in interface SampleTypeRegExpSupporter
        Parameters:
        value - the regular expression

      • getSampleTypeRegExp

        public adams.core.base.BaseRegExp getSampleTypeRegExp()
        Returns the regular expression for the sample type.
        Specified by:
        getSampleTypeRegExp in interface SampleTypeRegExpSupporter
        Returns:
        the regular expression

      • sampleTypeRegExpTipText

        public String sampleTypeRegExpTipText()
        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 for the format.
        Parameters:
        value - the regular expression

      • getFormat

        public adams.core.base.BaseRegExp getFormat()
        Returns the regular expression for the format.
        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.

      • update

        public void update()
        Automatically corrects values.
        Specified by:
        update in class adams.db.AbstractConditions