Package adams.data.io.output

Class ASCIIXYSpectrumWriter

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.io.FileFormatHandler, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.data.io.output.DataContainerWriter>, adams.core.SizeOfHandler, adams.data.io.output.DataContainerWriter<Spectrum>, adams.data.io.output.StreamableDataContainerWriter<Spectrum>, adams.data.io.output.StreamableTextBasedDataContainerWriter<Spectrum>, Serializable, Comparable
    public class ASCIIXYSpectrumWriter
extends AbstractTextBasedSpectrumWriter
    Writer that stores spectra in ASCII XY format. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -output <adams.core.io.PlaceholderFile> (property: output)
    The file to write the container to.
    default: ${TMP}/out.tmp
 
    -separator <java.lang.String> (property: separator)
    The separator to use between X and Y column.
    default: ;
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected String m_Separator
      the separator to use.

      • Fields inherited from class adams.data.io.output.AbstractDataContainerWriter

        m_Output, m_OutputIsFile

      • 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 getFormatDescription()
      Returns a string describing the format (used in the file chooser).
      String[] getFormatExtensions()
      Returns the extension(s) of the format.
      String getSeparator()
      Returns the separator to use between X and Y columns.
      String globalInfo()
      Returns a string describing the object.
      protected void initialize()
      Initializes the members.
      String separatorTipText()
      Returns the tip text for this property.
      void setSeparator​(String value)
      Sets the separator to use between X and Y columns.
      protected boolean writeData​(List<Spectrum> data, Writer writer)
      Performs the actual writing.

      • Methods inherited from class adams.data.io.output.AbstractDataContainerWriter

        checkData, cleanUp, compareTo, destroy, equals, forCommandLine, forName, getAdditionalInformation, getDefaultFormatExtension, getOutput, isOutputFile, reset, setOutput, shallowCopy, shallowCopy, write, write

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

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, 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.AdditionalInformationHandler

        getAdditionalInformation

      • Methods inherited from interface adams.core.CleanUpHandler

        cleanUp

      • Methods inherited from interface adams.data.io.output.DataContainerWriter

        canWriteMultiple, getOutput, isOutputFile, outputTipText, setOutput, write, write

      • Methods inherited from interface adams.core.Destroyable

        destroy

      • Methods inherited from interface adams.core.io.FileFormatHandler

        getDefaultFormatExtension

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

        getLoggingLevel

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

        cleanUpOptions, getOptionManager, toCommandLine

      • Methods inherited from interface adams.core.ShallowCopySupporter

        shallowCopy, shallowCopy

    • Field Detail

      • m_Separator

        protected String m_Separator
        the separator to use.

    • Constructor Detail

      • ASCIIXYSpectrumWriter

        public ASCIIXYSpectrumWriter()

    • 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.io.output.AbstractDataContainerWriter<Spectrum>

      • getFormatDescription

        public String getFormatDescription()
        Returns a string describing the format (used in the file chooser).
        Specified by:
        getFormatDescription in interface adams.core.io.FileFormatHandler
        Specified by:
        getFormatDescription in class adams.data.io.output.AbstractDataContainerWriter<Spectrum>
        Returns:
        a description suitable for displaying in the file chooser

      • getFormatExtensions

        public String[] getFormatExtensions()
        Returns the extension(s) of the format.
        Specified by:
        getFormatExtensions in interface adams.core.io.FileFormatHandler
        Specified by:
        getFormatExtensions in class adams.data.io.output.AbstractDataContainerWriter<Spectrum>
        Returns:
        the extension(s) (without the dot!)

      • setSeparator

        public void setSeparator​(String value)
        Sets the separator to use between X and Y columns.
        Parameters:
        value - the separator

      • getSeparator

        public String getSeparator()
        Returns the separator to use between X and Y columns.
        Returns:
        the separator

      • separatorTipText

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

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class adams.core.option.AbstractOptionHandler

      • writeData

        protected boolean writeData​(List<Spectrum> data,
                            Writer writer)
        Performs the actual writing.
        Specified by:
        writeData in class AbstractTextBasedSpectrumWriter
        Parameters:
        data - the data to write
        writer - the writer to write the spectra to
        Returns:
        true if successfully written