Package adams.data.multifilter

Class PickByReportValue

  • All Implemented Interfaces:
    adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<AbstractMultiSpectrumFilter>, adams.core.SizeOfHandler, Serializable, Comparable
    public class PickByReportValue
extends AbstractMultiSpectrumFilter
    Extracts the first sub-spectrum that matches the condition for the field. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -no-id-update <boolean> (property: dontUpdateID)
    If enabled, suppresses updating the ID of adams.data.id.IDHandler data containers.
    default: false
 
    -field <knir.data.sampledata.Field> (property: field)
    The field to inspect.
    default: Instrument[S]
 
    -condition-string <adams.core.base.BaseRegExp> (property: conditionString)
    The regular expression to apply to string fields.
    default: .*
 
    -condition-numeric-min <double> (property: conditionNumericMin)
    The lower bound for numeric fields.
    default: 4.9E-324
 
    -condition-numeric-max <double> (property: conditionNumericMax)
    The upper bound for numeric fields.
    default: 1.7976931348623157E308
 
    -condition-boolean <boolean> (property: conditionBoolean)
    Whether the boolean field must be true or false.
    default: true
    Version:
    $Revision$
    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 field to use.

      • m_ConditionString

        protected adams.core.base.BaseRegExp m_ConditionString
        the condition for string fields.

      • m_ConditionNumericMin

        protected double m_ConditionNumericMin
        the condition for numeric (lower bound).

      • m_ConditionNumericMax

        protected double m_ConditionNumericMax
        the condition for numeric (upper bound).

      • m_ConditionBoolean

        protected boolean m_ConditionBoolean
        the condition for boolean fields.

    • Constructor Detail

      • PickByReportValue

        public PickByReportValue()

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

      • setField

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

      • getField

        public adams.data.report.Field getField()
        Returns the field to inspect.
        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.

      • setConditionString

        public void setConditionString​(adams.core.base.BaseRegExp value)
        Sets the regular expression to apply to string fields.
        Parameters:
        value - the regexp

      • getConditionString

        public adams.core.base.BaseRegExp getConditionString()
        Returns the regular expression to apply to string fields.
        Returns:
        the field

      • conditionStringTipText

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

      • setConditionNumericMin

        public void setConditionNumericMin​(double value)
        Sets the lower bound that numeric fields must match.
        Parameters:
        value - the lower bound

      • getConditionNumericMin

        public double getConditionNumericMin()
        Returns the lower bound that numeric fields must match.
        Returns:
        the lower bound

      • conditionNumericMinTipText

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

      • setConditionNumericMax

        public void setConditionNumericMax​(double value)
        Sets the upper bound that numeric fields must match.
        Parameters:
        value - the upper bound

      • getConditionNumericMax

        public double getConditionNumericMax()
        Returns the upper bound that numeric fields must match.
        Returns:
        the upper bound

      • conditionNumericMaxTipText

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

      • setConditionBoolean

        public void setConditionBoolean​(boolean value)
        Sets whether the boolean field must be true or false.
        Parameters:
        value - the condition

      • getConditionBoolean

        public boolean getConditionBoolean()
        Returns whether the boolean field must be true or false.
        Returns:
        the condition

      • conditionBooleanTipText

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