Package adams.flow.sink

Class MergeFiles

  • All Implemented Interfaces:
    AdditionalInformationHandler, ClassCrossReference, CleanUpHandler, CrossReference, Destroyable, GlobalInfoSupporter, FileWriter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, Serializable, Comparable
    public class MergeFiles
extends AbstractFileWriter
implements ClassCrossReference
    Combines the incoming files in a single one.

    See also:
    adams.flow.transformer.SplitFile

    Input/output:
    - accepts:
       java.lang.String[]
       java.io.File[]


    -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
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: MergeFiles
 
    -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
    min-user-mode: Expert
 
    -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
    min-user-mode: Expert
 
    -output <adams.core.io.PlaceholderFile> (property: outputFile)
    The output file containing the combined content.
    default: ${CWD}
 
    -file-type <TEXT|BINARY> (property: fileType)
    Defines how to treat the file(s).
    default: TEXT
 
    -buffer-size <int> (property: bufferSize)
    The size of byte-buffer used for reading the content.
    default: 1024
    minimum: 1
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_FileType

        protected FileType m_FileType
        the file type.

      • m_BufferSize

        protected int m_BufferSize
        the buffer size to use.

    • Constructor Detail

      • MergeFiles

        public MergeFiles()

    • Method Detail

      • fileTypeTipText

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

      • setFileType

        public void setFileType​(FileType value)
        Sets how to process the files.
        Parameters:
        value - the type of file

      • getFileType

        public FileType getFileType()
        Returns how to process the files.
        Returns:
        the type of file

      • setBufferSize

        public void setBufferSize​(int value)
        Sets the size of the buffer.
        Parameters:
        value - the size

      • getBufferSize

        public int getBufferSize()
        Get output file.
        Returns:
        file

      • bufferSizeTipText

        public String bufferSizeTipText()
        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.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the accepted input

      • mergeText

        protected String mergeText​(PlaceholderFile[] files)
        Merges the text files.
        Parameters:
        files - the files to merge
        Returns:
        null if successful, otherwise error message

      • mergeBinary

        protected String mergeBinary​(PlaceholderFile[] files)
        Merges the binary files.
        Parameters:
        files - the files to merge
        Returns:
        null if successful, otherwise error message

      • doExecute

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