Package adams.data.spectrumfilter

Class ConditionalReportField

  • 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<adams.data.filter.Filter>, adams.core.SizeOfHandler, adams.data.filter.Filter<Spectrum>, Serializable, Comparable
    public class ConditionalReportField
extends adams.data.filter.AbstractFilter<Spectrum>
    Sets the 'success' value for the specified field if the condition evaluates to 'true', otherwise the 'failure' value.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class adams.data.filter.AbstractFilter

        adams.data.filter.AbstractFilter.FilterJob<T extends adams.data.container.DataContainer>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.flow.condition.bool.BooleanCondition m_Condition
      the condition to apply.
      protected String m_Failure
      the failure value.
      protected String m_Success
      the success value.
      protected adams.data.report.Field m_Target
      the target field.

      • Fields inherited from class adams.data.filter.AbstractFilter

        m_DontUpdateID

      • 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
      String conditionTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      String failureTipText()
      Returns the tip text for this property.
      adams.flow.condition.bool.BooleanCondition getCondition()
      Returns the condition to evaluate.
      String getFailure()
      Returns the failure value, ie the value to use when the condition evaluates to true.
      String getSuccess()
      Returns the success value, ie the value to use when the condition evaluates to true.
      adams.data.report.Field getTarget()
      Returns the target field in the report to store the result in.
      String globalInfo()
      Returns a string describing the object.
      protected Spectrum processData​(Spectrum data)
      Performs the actual filtering.
      void setCondition​(adams.flow.condition.bool.BooleanCondition value)
      Sets the condition to evaluate.
      void setFailure​(String value)
      Sets the failure value, ie the value to use when the condition evaluates to true.
      void setSuccess​(String value)
      Sets the success value, ie the value to use when the condition evaluates to true.
      void setTarget​(adams.data.report.Field value)
      Sets the target field in the report to store the result in.
      String successTipText()
      Returns the tip text for this property.
      String targetTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.data.filter.AbstractFilter

        checkData, cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, getDontUpdateID, reset, setDontUpdateID, shallowCopy, shallowCopy

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

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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, setLoggingLevel

      • Methods inherited from interface adams.core.logging.LoggingSupporter

        getLogger, isLoggingEnabled

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager, toCommandLine

    • Field Detail

      • m_Condition

        protected adams.flow.condition.bool.BooleanCondition m_Condition
        the condition to apply.

      • m_Target

        protected adams.data.report.Field m_Target
        the target field.

      • m_Success

        protected String m_Success
        the success value.

      • m_Failure

        protected String m_Failure
        the failure value.

    • Constructor Detail

      • ConditionalReportField

        public ConditionalReportField()

    • 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.data.filter.AbstractFilter<Spectrum>

      • setCondition

        public void setCondition​(adams.flow.condition.bool.BooleanCondition value)
        Sets the condition to evaluate.
        Parameters:
        value - the condition

      • getCondition

        public adams.flow.condition.bool.BooleanCondition getCondition()
        Returns the condition to evaluate.
        Returns:
        the condition

      • conditionTipText

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

      • setTarget

        public void setTarget​(adams.data.report.Field value)
        Sets the target field in the report to store the result in.
        Parameters:
        value - the field

      • getTarget

        public adams.data.report.Field getTarget()
        Returns the target field in the report to store the result in.
        Returns:
        the field

      • targetTipText

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

      • setSuccess

        public void setSuccess​(String value)
        Sets the success value, ie the value to use when the condition evaluates to true.
        Parameters:
        value - the success value

      • getSuccess

        public String getSuccess()
        Returns the success value, ie the value to use when the condition evaluates to true.
        Returns:
        the success value

      • successTipText

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

      • setFailure

        public void setFailure​(String value)
        Sets the failure value, ie the value to use when the condition evaluates to true.
        Parameters:
        value - the failure value

      • getFailure

        public String getFailure()
        Returns the failure value, ie the value to use when the condition evaluates to true.
        Returns:
        the failure value

      • failureTipText

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

      • processData

        protected Spectrum processData​(Spectrum data)
        Performs the actual filtering.
        Specified by:
        processData in class adams.data.filter.AbstractFilter<Spectrum>
        Parameters:
        data - the data to filter
        Returns:
        the filtered data