Package adams.data.spectrumfilter

Class RenameReportField

  • 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>, adams.data.filter.OptionalProcessingInfoUpdate, Serializable, Comparable
    public class RenameReportField
extends adams.data.filter.AbstractFilter<Spectrum>
    Replaces the old field names with the new ones. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -no-id-update <boolean> (property: dontUpdateID)
    If enabled, suppresses updating the ID of adams.data.id.IDHandler data containers.
    default: false
 
    -no-processing-info-update <boolean> (property: dontUpdateProcessingInfo)
    If enabled, suppresses updating the processing information of adams.data.NotesHandler
    data containers.
    default: false
 
    -field-old <adams.data.report.Field> [-field-old ...] (property: fieldsOld)
    The olf fields to rename.
    default:
 
    -field-new <adams.data.report.Field> [-field-new ...] (property: fieldsNew)
    The new fields to use.
    default:
    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.data.report.Field[] m_FieldsNew
      the new field(s).
      protected adams.data.report.Field[] m_FieldsOld
      the old field(s).

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

        m_DontUpdateID, m_DontUpdateProcessingInfo

      • 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 defineOptions()
      Adds options to the internal list of options.
      String fieldsNewTipText()
      Returns the tip text for this property.
      String fieldsOldTipText()
      Returns the tip text for this property.
      adams.data.report.Field[] getFieldsNew()
      Returns the new fields to use.
      adams.data.report.Field[] getFieldsOld()
      Returns the old fields to rename.
      String globalInfo()
      Returns a string describing the object.
      protected Spectrum processData​(Spectrum data)
      Performs the actual filtering.
      void setFieldsNew​(adams.data.report.Field[] value)
      Sets the new fields to use.
      void setFieldsOld​(adams.data.report.Field[] value)
      Sets the old fields to rename.

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

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

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

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, toCommandLine, toString

      • Methods inherited from class adams.core.logging.CustomLoggingLevelObject

        setLoggingLevel

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

        protected adams.data.report.Field[] m_FieldsOld
        the old field(s).

      • m_FieldsNew

        protected adams.data.report.Field[] m_FieldsNew
        the new field(s).

    • Constructor Detail

      • RenameReportField

        public RenameReportField()

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

      • setFieldsOld

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

      • getFieldsOld

        public adams.data.report.Field[] getFieldsOld()
        Returns the old fields to rename.
        Returns:
        the old fields

      • fieldsOldTipText

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

      • setFieldsNew

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

      • getFieldsNew

        public adams.data.report.Field[] getFieldsNew()
        Returns the new fields to use.
        Returns:
        the new fields

      • fieldsNewTipText

        public String fieldsNewTipText()
        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