com.adobe.platform.operation.pdfops

Class ExtractPDFOperation

java.lang.Object

com.adobe.platform.operation.pdfops.ExtractPDFOperation

All Implemented Interfaces:

Operation

public class ExtractPDFOperation
extends Object
implements Operation

An Operation that extracts pdf elements such as text, images, tables in a structured format from a PDF.

Method Summary

Modifier and Type	Method and Description
ExtractPDFOperation	addCharInfo(Boolean charInfo) Boolean to get bounding boxes for characters present in text blocks(paragraphs, list, headings).
ExtractPDFOperation	addElementsToExtract(List<PDFElementType> elementsToExtract) Add pdf element types for extracting structured information.
ExtractPDFOperation	addElementsToExtractRenditions(List<PDFElementType> elementsToExtractRenditions) Add pdf element types for extracting renditions.
ExtractPDFOperation	addElementToExtract(PDFElementType elementToExtract) Adds a pdf element type for extracting structured information.
ExtractPDFOperation	addElementToExtractRenditions(PDFElementType elementToExtractRenditions) Adds a pdf element type for extracting rendition.
ExtractPDFOperation	addTableStructureFormat(TableStructureType tableStructure) Specifies the format for extracting table data information.
static ExtractPDFOperation	createNew() Constructs a ExtractPDFOperation instance.
FileRef	execute(ExecutionContext context) Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting Zip file.
ExtractPDFOperation	setInputFile(FileRef sourceFileRef) Sets an input file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createNew

public static ExtractPDFOperation createNew()

Constructs a ExtractPDFOperation instance.

Returns:

a new ExtractPDFOperation instance

setInputFile

public ExtractPDFOperation setInputFile(FileRef sourceFileRef)

Sets an input file.

Parameters:

sourceFileRef - an input file

Returns:

current ExtractPDFOperation instance

addElementToExtract

public ExtractPDFOperation addElementToExtract(PDFElementType elementToExtract)

Adds a pdf element type for extracting structured information.

Parameters:

elementToExtract - list of pdf elements to be extracted

Returns:

current ExtractPDFOperation instance

addTableStructureFormat

public ExtractPDFOperation addTableStructureFormat(TableStructureType tableStructure)

Specifies the format for extracting table data information.

Parameters:

tableStructure - type of format to output table data

Returns:

current ExtractPDFOperation instance

addCharInfo

public ExtractPDFOperation addCharInfo(Boolean charInfo)

Boolean to get bounding boxes for characters present in text blocks(paragraphs, list, headings).

Parameters:

charInfo - boolean

Returns:

current ExtractPDFOperation instance

addElementToExtractRenditions

public ExtractPDFOperation addElementToExtractRenditions(PDFElementType elementToExtractRenditions)

Adds a pdf element type for extracting rendition.

Parameters:

elementToExtractRenditions - list of pdf elements to be extracted

Returns:

current ExtractPDFOperation instance

addElementsToExtract

public ExtractPDFOperation addElementsToExtract(List<PDFElementType> elementsToExtract)

Add pdf element types for extracting structured information.

Parameters:

elementsToExtract - list of pdf elements to be extracted

Returns:

current ExtractPDFOperation instance

addElementsToExtractRenditions

public ExtractPDFOperation addElementsToExtractRenditions(List<PDFElementType> elementsToExtractRenditions)

Add pdf element types for extracting renditions.

Parameters:

elementsToExtractRenditions - list of pdf elements for extracting renditions

Returns:

current ExtractPDFOperation instance

execute

public FileRef execute(ExecutionContext context)
                throws ServiceApiException,
                       IOException,
                       ServiceUsageException

Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting Zip file.

The resulting file may be stored in the system temporary directory (per java.io.tmpdir System property). See FileRef for how temporary resources are cleaned up.

Specified by:

execute in interface Operation

Parameters:

context - the context in which to execute the operation

Returns:

the resulting Zip file containing elements information and renditions

Throws:

ServiceApiException - if an API call results in an error response

IOException - if there is an error in reading either the input source or the resulting Zip file

ServiceUsageException - if service usage limits have been reached or credentials quota has been exhausted.