Package adams.flow.sink

Class FlowFileWriter

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, FileWriter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, Serializable, Comparable
    public class FlowFileWriter
extends AbstractFileWriter
    Writes the incoming actor(s) to a file.
    A custom flow writer can be specified.

    Input/output:
    - accepts:
       adams.flow.core.Actor


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: FlowFileWriter
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -output <adams.core.io.PlaceholderFile> (property: outputFile)
    The file to write the actor to.
    default: ${CWD}
 
    -use-custom-writer <boolean> (property: useCustomWriter)
    If enabled, the specified writer will be used instead of auto-detection.
    default: false
 
    -custom-writer <adams.data.io.output.FlowWriter> (property: customWriter)
    The writer to use if a custom writer is to be used.
    default: adams.data.io.output.DefaultFlowWriter
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_UseCustomWriter

        protected boolean m_UseCustomWriter
        whether to use a custom writer.

      • m_CustomWriter

        protected FlowWriter m_CustomWriter
        the custom writer to use.

    • Constructor Detail

      • FlowFileWriter

        public FlowFileWriter()

    • Method Detail

      • setUseCustomWriter

        public void setUseCustomWriter​(boolean value)
        Sets whether to use a custom writer.
        Parameters:
        value - true if to use a custom writer

      • getUseCustomWriter

        public boolean getUseCustomWriter()
        Returns whether to use a custom writer.
        Returns:
        true if to use a custom writer

      • useCustomWriterTipText

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

      • setCustomWriter

        public void setCustomWriter​(FlowWriter value)
        Sets the custom writer to use.
        Parameters:
        value - the writer

      • getCustomWriter

        public FlowWriter getCustomWriter()
        Returns the custom writer to use.
        Returns:
        the writer

      • customWriterTipText

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

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        the Class of objects that can be processed

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message