Package adams.db

Class SpectrumConditionsSingle

  • 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
    public class SpectrumConditionsSingle
extends AbstractSpectrumConditions
    Conditions for the retrieval of spectra.
    Only a single field can be specified.

    Valid options are: 

    -D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 
    -limit <int> (property: limit)
    The maximum number of records to retrieve.
    default: 10000
    minimum: -1
 
    -instrument <adams.core.base.BaseRegExp> (property: instrument)
    The regular expression on the instrument.
    default: 
 
    -sampleid <adams.core.base.BaseRegExp> (property: sampleIDRegExp)
    The regular expression on the spectrum ID.
    default: 
 
    -format <adams.core.base.BaseRegExp> (property: format)
    The regular expression on the data format.
    default: 
 
    -type <adams.core.base.BaseRegExp> (property: sampleTypeRegExp)
    The regular expression on the sample type.
    default: 
 
    -start <adams.core.base.BaseDateTime> (property: startDate)
    The start date for the spectra (yyyy-MM-dd HH:mm:ss).
    default: -INF
 
    -end <adams.core.base.BaseDateTime> (property: endDate)
    The end date for the spectra (yyyy-MM-dd HH:mm:ss).
    default: +INF
 
    -no-dummies (property: excludeDummies)
    If set to true, then spectra with sample data flagged as dummies will be 
    excluded.
 
    -only-dummies (property: onlyDummies)
    If set to true, then only spectra with sample data flagged as dummies will 
    be included.
 
    -latest (property: latest)
    If set to true, order is reversed and only latest ones are returned.
 
    -field <knir.data.sampledata.Field> (property: field)
    The required field in the sample data.
    default: [U]
 
    -min <adams.core.base.BaseDouble> (property: minimumValue)
    The required minimum value for the field in the sample data (-1 is unbounded
    ).
    default: -1.0
 
    -max <adams.core.base.BaseDouble> (property: maximumValue)
    The required maximum value for the field in the sample data (-1 is unbounded
    ).
    default: -1.0
 
    -required <knir.data.sampledata.Field> (property: requiredField)
    The field that is required to be present in the report, regardless of values 
    it has.
    default: [U]
    Version:
    $Revision: 11831 $
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Field

        protected adams.data.report.Field m_Field
        the reference fields.

      • m_MinimumValue

        protected adams.core.base.BaseDouble m_MinimumValue
        the minimum value for the field.

      • m_MaximumValue

        protected adams.core.base.BaseDouble m_MaximumValue
        the maximum value for the field.

      • m_RequiredField

        protected adams.data.report.Field m_RequiredField
        the field that us required to be present in report.

    • Constructor Detail

      • SpectrumConditionsSingle

        public SpectrumConditionsSingle()

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

      • setField

        public void setField​(adams.data.report.Field value)
        Sets the field to require.
        Parameters:
        value - the field

      • getField

        public adams.data.report.Field getField()
        Returns the required field.
        Returns:
        the field

      • fieldTipText

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

      • setMinimumValue

        public void setMinimumValue​(adams.core.base.BaseDouble value)
        Sets the minimum value for the field.
        Parameters:
        value - the minimum value

      • getMinimumValue

        public adams.core.base.BaseDouble getMinimumValue()
        Returns the minimum value for the field.
        Returns:
        the minimum value

      • minimumValueTipText

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

      • setMaximumValue

        public void setMaximumValue​(adams.core.base.BaseDouble value)
        Sets the maximum value to the fields.
        Parameters:
        value - the maximum value

      • getMaximumValue

        public adams.core.base.BaseDouble getMaximumValue()
        Returns the maximum values for the fields.
        Returns:
        the maximum values

      • maximumValueTipText

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

      • setRequiredField

        public void setRequiredField​(adams.data.report.Field value)
        Sets the required field.
        Parameters:
        value - the field

      • getRequiredField

        public adams.data.report.Field getRequiredField()
        Returns the required field.
        Returns:
        the field

      • requiredFieldTipText

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