Package adams.flow.transformer

Class PDFMetaData

  • 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 PDFMetaData
extends AbstractTransformer
    Actor for extracting the meta-data from a PDF.

    Input/output:
    - accepts:
       java.lang.String
       java.io.File
    - generates:
       adams.data.spreadsheet.SpreadSheet


    -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: PDFMetaData
 
    -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-type <SPREADSHEET|MAP> (property: outputType)
    How to output the meta-data.
    default: SPREADSHEET
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • PDFMetaData

        public PDFMetaData()

    • Method Detail

      • setOutputType

        public void setOutputType​(PDFMetaData.OutputType value)
        Sets how to output the meta-data.
        Parameters:
        value - the type

      • getOutputType

        public PDFMetaData.OutputType getOutputType()
        Returns how to output the meta-data.
        Returns:
        the type

      • outputTypeTipText

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

      • generates

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

      • addCell

        protected void addCell​(Row row,
                       String header,
                       Calendar content)
        Adds the cell content to the spreadsheet.
        Parameters:
        row - the row to add this to
        header - the column name
        content - the content for the cell

      • addCell

        protected void addCell​(Row row,
                       String header,
                       String content)
        Adds the cell content to the spreadsheet.
        Parameters:
        row - the row to add this to
        header - the column name
        content - the content for the cell

      • addMapValue

        public void addMapValue​(Map<String,​Object> map,
                        String key,
                        Object value)
        Adds the value to the map if not null.
        Parameters:
        map - the map to add to
        key - the key for the value
        value - the value to add

      • doExecute

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