Package adams.db

Class AbstractSpectrumConditions

  • 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.ReportConditions, SampleTypeRegExpSupporter, Serializable
    Direct Known Subclasses:
    SpectrumConditionsMulti, SpectrumConditionsSingle
    public abstract class AbstractSpectrumConditions
extends adams.db.AbstractLimitedConditions
implements adams.db.ReportConditions, SampleTypeRegExpSupporter
    Ancestor for spectrum conditions.
    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.BaseDateTime m_EndDate
      the end date of the spectra (incl.).
      protected boolean m_ExcludeDummies
      whether to exclude spectra with dummy reports.
      protected adams.core.base.BaseRegExp m_Format
      the regular expression on the format type of the spectrum.
      protected adams.core.base.BaseRegExp m_Instrument
      the regular expression on the name of the instrument.
      protected boolean m_Latest
      whether to get latest (= reverse order).
      protected boolean m_OnlyDummies
      whether to only include spectra with dummy reports.
      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 sample type of the spectrum.
      protected boolean m_SortOnInsertTimestamp
      whether to sort by insert timestamp.
      protected boolean m_SortOnSampleID
      whether to sort by sample ID.
      protected adams.core.base.BaseDateTime m_StartDate
      the start date of the spectra (incl.).

      • 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 check()
      Checks the correctness of the provided values.
      void defineOptions()
      Adds options to the internal list of options.
      String endDateTipText()
      Returns the tip text for this property.
      String excludeDummiesTipText()
      Returns the tip text for this property.
      String formatTipText()
      Returns the tip text for this property.
      adams.core.base.BaseDateTime getEndDate()
      Returns the end date.
      boolean getExcludeDummies()
      Returns whether spectra with reports flagged as dummies are excluded or not.
      adams.core.base.BaseRegExp getFormat()
      Returns the regular expression for the format.
      adams.core.base.BaseRegExp getInstrument()
      Returns the regular expression for the instrument name.
      boolean getLatest()
      Returns whether only the latest ones are returned (= reverse order).
      boolean getOnlyDummies()
      Returns whether only spectra with reports flagged as dummies are included or not.
      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.
      boolean getSortOnInsertTimestamp()
      Returns whether to sort on SampleData.INSERT_TIMESTAMP instead of auto ID.
      boolean getSortOnSampleID()
      Returns whether to sort on SampleData.SAMPLE_ID instead of auto ID.
      adams.core.base.BaseDateTime getStartDate()
      Returns the start date.
      String instrumentTipText()
      Returns the tip text for this property.
      String latestTipText()
      Returns the tip text for this property.
      String onlyDummiesTipText()
      Returns the tip text for this property.
      String sampleIDRegExpTipText()
      Returns the tip text for this property.
      String sampleTypeRegExpTipText()
      Returns the tip text for this property.
      void setEndDate​(adams.core.base.BaseDateTime value)
      Sets the end date.
      void setExcludeDummies​(boolean value)
      Sets whether to exclude spectra with reports flagged as dummies or not.
      void setFormat​(adams.core.base.BaseRegExp value)
      Sets the regular expression for the format.
      void setInstrument​(adams.core.base.BaseRegExp value)
      Sets the regular expression for the instrument name.
      void setLatest​(boolean value)
      Sets whether to get only the latest ones (= reverse order).
      void setOnlyDummies​(boolean value)
      Sets whether to include only spectra with reports flagged as dummies or not.
      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 setSortOnInsertTimestamp​(boolean value)
      Sets whether to sort on SampleData.INSERT_TIMESTAMP instead of auto ID.
      void setSortOnSampleID​(boolean value)
      Sets whether to sort on SampleData.SAMPLE_ID instead of auto ID.
      void setStartDate​(adams.core.base.BaseDateTime value)
      Sets the start date.
      String sortOnInsertTimestampTipText()
      Returns the tip text for this property.
      String sortOnSampleIDTipText()
      Returns the tip text for this property.
      String startDateTipText()
      Returns the tip text for this property.
      void update()
      Automatically corrects values.

      • Methods inherited from class adams.db.AbstractLimitedConditions

        getDefaultLimit, getLimit, limitTipText, setLimit

      • Methods inherited from class adams.db.AbstractConditions

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

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

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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_Instrument

        protected adams.core.base.BaseRegExp m_Instrument
        the regular expression on the name of the instrument.

      • 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 sample type of the spectrum.

      • m_Format

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

      • m_StartDate

        protected adams.core.base.BaseDateTime m_StartDate
        the start date of the spectra (incl.).

      • m_EndDate

        protected adams.core.base.BaseDateTime m_EndDate
        the end date of the spectra (incl.).

      • m_ExcludeDummies

        protected boolean m_ExcludeDummies
        whether to exclude spectra with dummy reports.

      • m_OnlyDummies

        protected boolean m_OnlyDummies
        whether to only include spectra with dummy reports.

      • m_Latest

        protected boolean m_Latest
        whether to get latest (= reverse order).

      • m_SortOnInsertTimestamp

        protected boolean m_SortOnInsertTimestamp
        whether to sort by insert timestamp.

      • m_SortOnSampleID

        protected boolean m_SortOnSampleID
        whether to sort by sample ID.

    • Constructor Detail

      • AbstractSpectrumConditions

        public AbstractSpectrumConditions()

    • Method Detail

      • 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

      • setInstrument

        public void setInstrument​(adams.core.base.BaseRegExp value)
        Sets the regular expression for the instrument name.
        Parameters:
        value - the regular expression

      • getInstrument

        public adams.core.base.BaseRegExp getInstrument()
        Returns the regular expression for the instrument name.
        Returns:
        the regular expression

      • instrumentTipText

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

      • setSampleIDRegExp

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

      • getSampleIDRegExp

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

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

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

      • setStartDate

        public void setStartDate​(adams.core.base.BaseDateTime value)
        Sets the start date.
        Parameters:
        value - the start date

      • getStartDate

        public adams.core.base.BaseDateTime getStartDate()
        Returns the start date.
        Returns:
        the start date

      • startDateTipText

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

      • setEndDate

        public void setEndDate​(adams.core.base.BaseDateTime value)
        Sets the end date.
        Parameters:
        value - the end date

      • getEndDate

        public adams.core.base.BaseDateTime getEndDate()
        Returns the end date.
        Returns:
        the end date

      • endDateTipText

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

      • setExcludeDummies

        public void setExcludeDummies​(boolean value)
        Sets whether to exclude spectra with reports flagged as dummies or not.
        Specified by:
        setExcludeDummies in interface adams.db.ReportConditions
        Parameters:
        value - if true then dummies are excluded

      • getExcludeDummies

        public boolean getExcludeDummies()
        Returns whether spectra with reports flagged as dummies are excluded or not.
        Specified by:
        getExcludeDummies in interface adams.db.ReportConditions
        Returns:
        true if dummies are to be excluded

      • excludeDummiesTipText

        public String excludeDummiesTipText()
        Returns the tip text for this property.
        Specified by:
        excludeDummiesTipText in interface adams.db.ReportConditions
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOnlyDummies

        public void setOnlyDummies​(boolean value)
        Sets whether to include only spectra with reports flagged as dummies or not.
        Specified by:
        setOnlyDummies in interface adams.db.ReportConditions
        Parameters:
        value - if true then only dummies are included

      • getOnlyDummies

        public boolean getOnlyDummies()
        Returns whether only spectra with reports flagged as dummies are included or not.
        Specified by:
        getOnlyDummies in interface adams.db.ReportConditions
        Returns:
        true if only dummies are to be included

      • onlyDummiesTipText

        public String onlyDummiesTipText()
        Returns the tip text for this property.
        Specified by:
        onlyDummiesTipText in interface adams.db.ReportConditions
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setLatest

        public void setLatest​(boolean value)
        Sets whether to get only the latest ones (= reverse order).
        Parameters:
        value - if true then the latest ones are returned

      • getLatest

        public boolean getLatest()
        Returns whether only the latest ones are returned (= reverse order).
        Returns:
        true if only latest ones are returned

      • latestTipText

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

      • sortOnInsertTimestampTipText

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

      • setSortOnSampleID

        public void setSortOnSampleID​(boolean value)
        Sets whether to sort on SampleData.SAMPLE_ID instead of auto ID.
        Parameters:
        value - if true then to sort on SampleData.SAMPLE_ID

      • sortOnSampleIDTipText

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

      • check

        public void check()
        Checks the correctness of the provided values.
        Overrides:
        check in class adams.db.AbstractConditions

      • update

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