Package adams.flow.standalone.rats.output

Class TextWriter

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractRatOutput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.event.VariableChangeListener, RatOutput, Serializable
    public class TextWriter
extends AbstractRatOutput
    Writes incoming textual data to a text file. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -content-name <java.lang.String> (property: contentName)
    The name of the content, might be used in the filename of the output.
    default: 
 
    -writer <adams.data.io.output.AbstractTextWriter> (property: writer)
    The writer to use for ouputting the textual data.
    default: adams.data.io.output.NullWriter
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_ContentName

        protected String m_ContentName
        the name of the content (e.g., can be used in the filename).

      • m_Writer

        protected adams.data.io.output.AbstractTextWriter m_Writer
        the writer to use.

    • Constructor Detail

      • TextWriter

        public TextWriter()

    • 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.core.option.AbstractOptionHandler

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractRatOutput
        Returns:
        null if no info available, otherwise short string

      • setContentName

        public void setContentName​(String value)
        Sets name of the content.
        Parameters:
        value - the content name

      • getContentName

        public String getContentName()
        Returns the name of the content.
        Returns:
        the content name

      • contentNameTipText

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

      • setWriter

        public void setWriter​(adams.data.io.output.AbstractTextWriter value)
        Sets whether to append to the file or not.
        Parameters:
        value - true if appending to file instead of rewriting it

      • getWriter

        public adams.data.io.output.AbstractTextWriter getWriter()
        Returns whether files gets only appended or not.
        Returns:
        true if appending is turned on

      • writerTipText

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

      • doTransmit

        protected String doTransmit()
        Performs the actual transmission.
        Specified by:
        doTransmit in class AbstractRatOutput
        Returns:
        null if successful, otherwise error message