Package adams.flow.transformer

Class PDFExtract

  • 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 PDFExtract
extends AbstractTransformer
    Actor for extracting a range of pages from a PDF file.

    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: PDFExtract
 
    -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: output)
    The PDF file to output the extracted pages to.
    default: ${CWD}
 
    -pages <adams.core.UnorderedRange> (property: pages)
    The range of pages to extract; An unordered range is a comma-separated list
    of single 1-based indices or sub-ranges of indices ('start-end'); the following
    placeholders can be used as well: first, second, third, last_2, last_1,
    last
    default: first-last
    example: An unordered range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); the following placeholders can be used as well: first, second, third, last_2, last_1, last
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • PDFExtract

        public PDFExtract()

    • Method Detail

      • 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.

      • setPages

        public void setPages​(UnorderedRange value)
        Sets the page range.
        Parameters:
        value - the range

      • getPages

        public UnorderedRange getPages()
        Returns the page range.
        Returns:
        the range

      • pagesTipText

        public String pagesTipText()
        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