Package adams.data.io.output

Class TrinamixSpectrumWriter

  • 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 TrinamixSpectrumWriter
extends AbstractTextBasedSpectrumWriter
    Writer for the trinamiX (https://trinamixsensing.com/) CSV format.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected String m_InstrumentName
      The instrument name 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
      boolean canWriteMultiple()
      Returns whether writing of multiple containers is supported.
      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 getInstrumentName()
      Get instrument name.
      String globalInfo()
      Returns a string describing the object.
      protected void initialize()
      Initializes the members.
      String instrumentNameTipText()
      Returns the tip text for this property.
      void setInstrumentName​(String mInstrumentName)
      Set instrument name.
      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

        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_InstrumentName

        protected String m_InstrumentName
        The instrument name to use.

    • Constructor Detail

      • TrinamixSpectrumWriter

        public TrinamixSpectrumWriter()

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

      • initialize

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

      • getInstrumentName

        public String getInstrumentName()
        Get instrument name.
        Returns:
        instrument name

      • setInstrumentName

        public void setInstrumentName​(String mInstrumentName)
        Set instrument name.
        Parameters:
        mInstrumentName - instrument name

      • instrumentNameTipText

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

      • 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 (without the dot!)

      • canWriteMultiple

        public boolean canWriteMultiple()
        Returns whether writing of multiple containers is supported.
        Specified by:
        canWriteMultiple in interface adams.data.io.output.DataContainerWriter<Spectrum>
        Overrides:
        canWriteMultiple in class AbstractSpectrumWriter
        Returns:
        true if multiple containers are supported

      • 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