Package adams.flow.transformer

Class PDFAppendDocument

  • All Implemented Interfaces:
    AdditionalInformationHandler, ClassCrossReference, CleanUpHandler, CrossReference, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, StorageUser, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class PDFAppendDocument
extends AbstractTransformer
implements ClassCrossReference, StorageUser
    Modifies the incoming PDF document generated by adams.flow.source.PDFNewDocument using the PDF processors on either the specified input file or storage item.
    Needs to be finalized with adams.flow.sink.PDFCloseDocument.
    If a file name is received as input, it is assumed that this is an existing PDF file and gets appended.

    See also:
    adams.flow.source.PDFNewDocument
    adams.flow.sink.PDFCloseDocument

    Input/output:
    - accepts:
       adams.flow.transformer.pdfproclet.PDFGenerator
       java.lang.String
       java.io.File
    - generates:
       adams.flow.transformer.pdfproclet.PDFGenerator


    -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: PDFAppendDocument
 
    -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
 
    -proclet <adams.flow.transformer.pdfproclet.PdfProclet> [-proclet ...] (property: proclets)
    The processors for processing the data (file or storage item).
    default: 
 
    -type <FILE|STORAGE> (property: type)
    The type of data to process.
    default: FILE
 
    -input-file <adams.core.io.PlaceholderFile> (property: inputFile)
    The file to process by the PDF processors.
    default: ${CWD}
 
    -storage-name <adams.flow.control.StorageName> (property: storageName)
    The name of the storage item to retrieve.
    default: storage
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • PDFAppendDocument

        public PDFAppendDocument()

    • Method Detail

      • setProclets

        public void setProclets​(PdfProclet[] value)
        Sets the processors to use.
        Parameters:
        value - the processors to use

      • getProclets

        public PdfProclet[] getProclets()
        Returns the processors in use.
        Returns:
        the processors in use

      • procletsTipText

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

      • typeTipText

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

      • setInputFile

        public void setInputFile​(PlaceholderFile value)
        Sets the input file to process.
        Parameters:
        value - the file

      • getInputFile

        public PlaceholderFile getInputFile()
        Returns the input file to process.
        Returns:
        the file

      • inputFileTipText

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

      • setStorageName

        public void setStorageName​(StorageName value)
        Sets the name of the storage item to retrieve.
        Parameters:
        value - the storage item

      • getStorageName

        public StorageName getStorageName()
        Returns the name of the storage item to retrieve.
        Returns:
        the storage item

      • storageNameTipText

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

      • isUsingStorage

        public boolean isUsingStorage()
        Returns whether storage items are being used.
        Specified by:
        isUsingStorage in interface StorageUser
        Returns:
        true if storage items are used

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        the Class of the generated tokens

      • doExecute

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