Package adams.flow.transformer

Class PDFStamp

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class PDFStamp
extends AbstractTransformer
    Actor for stamping pages in a PDF with a custom overlay.

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


    -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: PDFStamp
 
    -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 gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console.
    default: false
 
    -stamper <adams.flow.transformer.pdfstamp.AbstractStamper> (property: stamper)
    The stamping algorithm to apply to the PDF.
    default: adams.flow.transformer.pdfstamp.PassThrough
 
    -output <adams.core.io.PlaceholderFile> (property: output)
    The PDF file to save the combined PDF to.
    default: ${CWD}
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • PDFStamp

        public PDFStamp()

    • Method Detail

      • setStamper

        public void setStamper​(AbstractStamper value)
        Sets the stamper to use.
        Parameters:
        value - the stamper

      • getStamper

        public AbstractStamper getStamper()
        Returns the stamper in use.
        Returns:
        the stamper

      • stamperTipText

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

      • setOutput

        public void setOutput​(PlaceholderFile value)
        Sets the output file.
        Parameters:
        value - the file

      • getOutput

        public PlaceholderFile getOutput()
        Returns the output file.
        Returns:
        the file

      • outputTipText

        public String outputTipText()
        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:
        java.lang.String.class, java.io.File.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        java.lang.String.class

      • doExecute

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