com.adobe.pdfservices.operation.pdfops

Class OCROperation

java.lang.Object

com.adobe.pdfservices.operation.pdfops.OCROperation

All Implemented Interfaces:

Operation

public class OCROperation
extends Object
implements Operation

Convert a PDF file into a searchable PDF file. Allows specifying locale(OCRSupportedLocale) and OCR Type (OCRSupportedType) for performing OCR (Optical Character Recognition)

Sample Usage:

   OCROperation ocrOperation = OCROperation.createNew();
   ocrOperation.setInput(FileRef.createFromLocalFile("~/Documents/ocrOperationInput.pdf",
                                                      OCROperation.SupportedSourceFormat.PDF.getMediaType()));
   Credentials credentials = Credentials.serviceAccountCredentialsBuilder().fromFile("pdfservices-api-credentials.json").build();
   FileRef result = ocrOperation.execute(ExecutionContext.create(credentials));
   result.saveAs("output/ocrOperationOutput.pdf");
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OCROperation.SupportedSourceFormat Supported source file formats for OCROperation.

Method Summary

Modifier and Type	Method and Description
static OCROperation	createNew() Constructs a OCROperation instance.
FileRef	execute(ExecutionContext context) Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
void	setInput(FileRef sourceFileRef) Sets an input file.
void	setOptions(OCROptions ocrOptions) Sets the options for this operation.

Methods inherited from class java.lang.Object

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

Method Detail

createNew

public static OCROperation createNew()

Constructs a OCROperation instance.

Returns:

a new OCROperation instance

setInput

public void setInput(FileRef sourceFileRef)

Sets an input file.

Parameters:

sourceFileRef - an input file

setOptions

public void setOptions(OCROptions ocrOptions)

Sets the options for this operation. See OCROptions for how to specify the options for the different locales and ocr types.

Parameters:

ocrOptions - optional parameters; use null for default values

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 PDF 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 PDF file

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 PDF file

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