Package adams.data.io.output

Class SimpleTrailWriter

  • 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, Serializable, Comparable
    public class SimpleTrailWriter
extends AbstractTrailWriter
    Writes trails in the simple CSV-like format.
    The report and trail image come before the actual trail data.
    The report data is prefixed with '# ' and the background is prefixed with '% '.
    The background data are the gzipped RGBA bytes of the image (obtained row-by-row from image). 

    -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
 
    -store-background <boolean> (property: storeBackground)
    If enabled, the background gets stored in the file as well.
    default: true
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String BACKGROUND
      the background prefix.
      static String COMMENT
      the comment prefix.
      protected boolean m_StoreBackground
      whether to save the background as well.

      • 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.
      boolean getStoreBackground()
      Returns whether to store the background as well.
      String globalInfo()
      Returns a string describing the object.
      void setStoreBackground​(boolean value)
      Sets whether to store the background as well.
      String storeBackgroundTipText()
      Returns the tip text for this property.
      protected boolean writeData​(List<Trail> 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, 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.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_StoreBackground

        protected boolean m_StoreBackground
        whether to save the background as well.

    • Constructor Detail

      • SimpleTrailWriter

        public SimpleTrailWriter()

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

      • setStoreBackground

        public void setStoreBackground​(boolean value)
        Sets whether to store the background as well.
        Parameters:
        value - true if to store background

      • getStoreBackground

        public boolean getStoreBackground()
        Returns whether to store the background as well.
        Returns:
        ture if to store background

      • storeBackgroundTipText

        public String storeBackgroundTipText()
        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<Trail>
        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<Trail>
        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<Trail>
        Returns:
        true if multiple containers are supported

      • writeData

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