Package adams.db

Class SpectrumConditionsMulti

  • 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 SpectrumConditionsMulti
extends AbstractSpectrumConditions
    Conditions for the retrieval of spectra.
    Several fields 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> [-field ...] (property: fields)
    The required fields in the sample data.
    default: 
 
    -min <adams.core.base.BaseDouble> [-min ...] (property: minimumValues)
    The required minimum values for the fields in the sample data (-1 is unbounded
    ).
    default: 
 
    -max <adams.core.base.BaseDouble> [-max ...] (property: maximumValues)
    The required maximum values for the fields in the sample data (-1 is unbounded
    ).
    default: 
 
    -required <knir.data.sampledata.Field> [-required ...] (property: requiredFields)
    The fields that are required to be present in the report, regardless of 
    values they have.
    default:
    Version:
    $Revision: 11831 $
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Fields

        protected adams.data.report.Field[] m_Fields
        the reference fields.

      • m_MinimumValues

        protected adams.core.base.BaseDouble[] m_MinimumValues
        the minimum value for the field(s).

      • m_MaximumValues

        protected adams.core.base.BaseDouble[] m_MaximumValues
        the maximum value for the field(s).

      • m_RequiredFields

        protected adams.data.report.Field[] m_RequiredFields
        the fields that are required to be present in report.

    • Constructor Detail

      • SpectrumConditionsMulti

        public SpectrumConditionsMulti()

    • 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

      • setFields

        public void setFields​(adams.data.report.Field[] value)
        Sets the fields to require.
        Parameters:
        value - the fields

      • getFields

        public adams.data.report.Field[] getFields()
        Returns the required fields.
        Returns:
        the fields

      • fieldsTipText

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

      • setMinimumValues

        public void setMinimumValues​(adams.core.base.BaseDouble[] value)
        Sets the minimum values to the fields.
        Parameters:
        value - the minimum values

      • getMinimumValues

        public adams.core.base.BaseDouble[] getMinimumValues()
        Returns the minimum values for the fields.
        Returns:
        the minimum values

      • minimumValuesTipText

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

      • setMaximumValues

        public void setMaximumValues​(adams.core.base.BaseDouble[] value)
        Sets the maximum values to the fields.
        Parameters:
        value - the maximum values

      • getMaximumValues

        public adams.core.base.BaseDouble[] getMaximumValues()
        Returns the maximum values for the fields.
        Returns:
        the maximum values

      • maximumValuesTipText

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

      • setRequiredFields

        public void setRequiredFields​(adams.data.report.Field[] value)
        Sets the required fields.
        Parameters:
        value - the fields

      • getRequiredFields

        public adams.data.report.Field[] getRequiredFields()
        Returns the required fields.
        Returns:
        the fields

      • requiredFieldsTipText

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