Repository files navigation

This sample project helps you get started with the PDFTools extract SDK.

The sample classes illustrate how to perform PDF-related extraction (extracting content of PDF in user friendlystructured format) using the SDK.

The sample application has the following requirements:

• Java JDK : Version 8 or above.
• Build Tool: The application requires Maven to be installed. Maven installation instructions can be foundhere.

The api credentials file and corresponding private key file for the samples ispdftools-api-credentials.json andprivate.keyrespectively. Before the samples can be run, replace both the files with the ones present in the zip file receivedviaBeta Program Access workflow.

The SDK also supports providing the authentication credentials at runtime, without storing them in a config file. Pleaserefer thissection toknow more.

Run the following command to build the project:

mvn clean install

Note that the PDFTools Extract SDK is listed as a dependency in the pom.xml and will be downloaded automatically.

For logging, this SDK uses theslf4j API with a log4j2-slf4j binding. The logging configurationsare provided insrc/main/resources/log4j2.properties. Alternate bindings, if required, can be specified in pom.xml.

The output of SDK extract operation is Zip package. The Zip package consists of following:

• The structuredData.json file with the extracted content & PDF element structure. See theJSON schema.
• A renditions folder(s) containing renditions for each element type selected as input.The folder name is either “tables” or “figures” depending on your specified element type.Each folder contains renditions with filenames that correspond to the element information in the JSON file.

The following sub-sections describe how to run the samples. Prior to running the samples, check that the credentialsfile is set up as described above and that the project has been built.

The code itself is in thecom.adobe.platform.operation.samples.extractpdf package under thesrc/main/java/ folder. Testfiles used by the samples can be found insrc/main/resources/. When executed, all samples create anoutputchild folder under the working directory to store their results.

These samples illustrate how to extract PDF elements from PDF. Refer to the documentation ofExtractPDFOperation.javato see the list of inputs.

The sample class ExtractTextInfoFromPDF.java extracts text elements from PDF Document.

mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.extractpdf.ExtractTextInfoFromPDF

The sample class ExtractTextTableInfoFromPDF extracts text, table elements from PDF Document.

mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.extractpdf.ExtractTextTableInfoFromPDF

The sample class ExtractTextTableInfoWithRenditionsFromPDF extracts text, table elements along with table renditionsfrom PDF Document. Note that the output is a zip containing the structured information along with renditions as describedinsection.

mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.extractpdf.ExtractTextTableInfoWithRenditionsFromPDF

The sample class ExtractTextTableInfoWithFiguresTablesRenditionsFromPDF extracts text, table elements along with figureand table element's renditions from PDF Document. Note that the output is a zip containing the structured informationalong with renditions as described insection.

mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.extractpdf.ExtractTextTableInfoWithFiguresTablesRenditionsFromPDF

The sample class ExtractTextInfoFromPDFWithInMemoryAuthCredentials.java extracts text elements from PDF Document.This sample highlights how to provide in-memory auth credentials for performing an operation.This enables the clients to fetch the credentials from a secret server during runtime, instead of storing them in a file.

mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.extractpdf.ExtractTextInfoFromPDFWithInMemoryAuthCredentials

The sample class ExtractTextInfoWithCharBoundsFromPDF extracts text elements and bounding boxes for characters present in text blocks. Note that the output is a zip containing the structured informationalong with renditions as described insection.

mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.extractpdf.ExtractTextInfoWithCharBoundsFromPDF

The sample class ExtractTextTableInfoWithCharBoundsFromPDF extracts text, table elements, bounding boxes for characters present in text blocks andtable element's renditions from PDF Document. Note that the output is a zip containing the structured informationalong with renditions as described insection.

mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.extractpdf.ExtractTextTableInfoWithCharBoundsFromPDF

The sample class ExtractTextTableInfoWithTableStructureFromPdf extracts text, table elements, table structures as CSV andtable element's renditions from PDF Document. Note that the output is a zip containing the structured informationalong with renditions as described insection.

mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.extractpdf.ExtractTextTableInfoWithTableStructureFromPdf

Contributions are welcome! Read theContributing Guide for more information.

This project is licensed under the MIT License. SeeLICENSE for more information.