Package adams.data.io.output

Class SimpleXYZWriter

  • 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.AbstractDataContainerWriter>, adams.core.SizeOfHandler, adams.data.CompressionSupporter, Serializable, Comparable
    public class SimpleXYZWriter
extends AbstractThreeWayDataWriter
implements adams.data.CompressionSupporter
    Writes 3-way data in CSV format (x/y/z/data columns). 

    -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 for the columns; use '\t' for tab.
    default:
 
    -output-sample-data <boolean> (property: outputSampleData)
    If set to true, the sample data gets stored in the file as well (as comment
    ).
    default: false
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean m_OutputSampleData
      whether to output the sample data as well.
      protected String m_Separator
      the column separator.
      protected boolean m_UseCompression
      whether to use compression.

      • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      SimpleXYZWriter()  

    • 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.
      boolean getOutputSampleData()
      Returns whether to output eh sample data as well.
      String getSeparator()
      Returns the string used as separator for the columns, '\t' for tab.
      boolean getUseCompression()
      Returns whether compression is in use.
      String globalInfo()
      Returns a string describing the object.
      String outputSampleDataTipText()
      Returns the tip text for this property.
      String separatorTipText()
      Returns the tip text for this property.
      void setOutputSampleData​(boolean value)
      Sets whether to output the sample data as well.
      void setSeparator​(String value)
      Sets the string to use as separator for the columns, use '\t' for tab.
      void setUseCompression​(boolean value)
      Sets whether to use compression.
      String useCompressionTipText()
      Returns the tip text for this property.
      protected boolean writeData​(List<ThreeWayData> data)
      Performs the actual writing.

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

        checkData, cleanUp, compareTo, destroy, equals, forCommandLine, forName, getAdditionalInformation, getDefaultFormatExtension, getOutput, getWriters, isOutputFile, outputTipText, 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.Destroyable

        destroy

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

        getLoggingLevel

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

        cleanUpOptions, getOptionManager, toCommandLine

    • Field Detail

      • m_Separator

        protected String m_Separator
        the column separator.

      • m_OutputSampleData

        protected boolean m_OutputSampleData
        whether to output the sample data as well.

      • m_UseCompression

        protected boolean m_UseCompression
        whether to use compression.

    • Constructor Detail

      • SimpleXYZWriter

        public SimpleXYZWriter()

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

      • setSeparator

        public void setSeparator​(String value)
        Sets the string to use as separator for the columns, use '\t' for tab.
        Parameters:
        value - the separator

      • getSeparator

        public String getSeparator()
        Returns the string used as separator for the columns, '\t' for tab.
        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.

      • setOutputSampleData

        public void setOutputSampleData​(boolean value)
        Sets whether to output the sample data as well.
        Parameters:
        value - if true then the sample data gets output as well

      • getOutputSampleData

        public boolean getOutputSampleData()
        Returns whether to output eh sample data as well.
        Returns:
        true if the sample data is output as well

      • outputSampleDataTipText

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

      • setUseCompression

        public void setUseCompression​(boolean value)
        Sets whether to use compression.
        Specified by:
        setUseCompression in interface adams.data.CompressionSupporter
        Parameters:
        value - true if to use compression

      • getUseCompression

        public boolean getUseCompression()
        Returns whether compression is in use.
        Specified by:
        getUseCompression in interface adams.data.CompressionSupporter
        Returns:
        true if compression is used

      • useCompressionTipText

        public String useCompressionTipText()
        Returns the tip text for this property.
        Specified by:
        useCompressionTipText in interface adams.data.CompressionSupporter
        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<ThreeWayData>
        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<ThreeWayData>
        Returns:
        the extension(s) (without the dot!)

      • canWriteMultiple

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

      • writeData

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