Package adams.data.io.output

Class FlowSpectrumWriter

  • 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>, Serializable, Comparable
    public class FlowSpectrumWriter
extends AbstractSpectrumWriter
    Writes the spectra using the specified flow.
    The flow must be a sink and accepting an array of spectra. 

    -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
 
    -output <adams.core.io.PlaceholderFile> (property: output)
    The file to write the spectrum to.
    default: ${TMP}/out.tmp
 
    -output-file <boolean> (property: outputFile)
    Whether the output needs to be a file (true) or directory (true).
    default: true
 
    -flow-file <adams.core.io.FlowFile> (property: flowFile)
    The flow that loads the spectral data.
    default: ${CWD}
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.flow.core.Actor m_Flow
      the actor for loading the data.
      protected adams.core.io.FlowFile m_FlowFile
      the flow to use for reading the spectra.

      • 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 flowFileTipText()
      Returns the tip text for this property.
      adams.core.io.FlowFile getFlowFile()
      Returns the flow to use.
      String getFormatDescription()
      Returns a string describing the format (used in the file chooser).
      String[] getFormatExtensions()
      Returns the extension(s) of the format.
      String globalInfo()
      Returns a string describing the object.
      String outputFileTipText()
      Returns the tip text for this property.
      void setFlowFile​(adams.core.io.FlowFile value)
      Sets the flow to use.
      void setOutputFile​(boolean value)
      Sets whether the output needs to be a file or directory.
      protected String setupFlow()
      Sets up the flow, if necessary.
      protected boolean writeData​(List<Spectrum> data)
      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, 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

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

        cleanUpOptions, getOptionManager, toCommandLine

    • Field Detail

      • m_FlowFile

        protected adams.core.io.FlowFile m_FlowFile
        the flow to use for reading the spectra.

      • m_Flow

        protected transient adams.flow.core.Actor m_Flow
        the actor for loading the data.

    • Constructor Detail

      • FlowSpectrumWriter

        public FlowSpectrumWriter()

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

      • setOutputFile

        public void setOutputFile​(boolean value)
        Sets whether the output needs to be a file or directory.
        Parameters:
        value - true if the output needs to be a file, a directory otherwise

      • outputFileTipText

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

      • setFlowFile

        public void setFlowFile​(adams.core.io.FlowFile value)
        Sets the flow to use.
        Parameters:
        value - the file

      • getFlowFile

        public adams.core.io.FlowFile getFlowFile()
        Returns the flow to use.
        Returns:
        the file

      • flowFileTipText

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

      • setupFlow

        protected String setupFlow()
        Sets up the flow, if necessary.
        Returns:
        null if successful, otherwise error message

      • writeData

        protected boolean writeData​(List<Spectrum> data)
        Performs the actual writing.
        Specified by:
        writeData in class adams.data.io.output.AbstractDataContainerWriter<Spectrum>
        Parameters:
        data - the data to write
        Returns:
        true if successfully written