com.itextpdf.pdf2data

Class Pdf2DataExtractor

java.lang.Object

com.itextpdf.pdf2data.Pdf2DataExtractor

public class Pdf2DataExtractor
extends Object

Pdf2DataExtractor is a class for extracting templates and data from PDF files.

To create instance of Pdf2DataExtractor, use create(File p2dFile).

To extract data from PDF file use recognize(File) method.

Constructor Summary

Constructors

Constructor and Description
Pdf2DataExtractor(com.itextpdf.pdf2data.template.Template template) Deprecated. To create an instance use create(File).

Method Summary

Modifier and Type	Method and Description
static Pdf2DataExtractor	create(File p2dFile) Creates instance of Pdf2DataExtractor from pdf2data template file.
com.itextpdf.pdf2data.template.Template	getTemplate() Gets current template instance.
static com.itextpdf.pdf2data.template.Template	parseTemplateFromPDF(InputStream templateInputStream) Deprecated. To work with Pdf2DataExtractor class use create(File). If you have PDF template, XML template or P2DTA which is not ready for sdk, then first use an appropriate method(s) from Pdf2DataTemplateConverter.
static void	parseTemplateFromPDF(InputStream templateInputStream, OutputStream xmlStream) Deprecated. To obtain P2D ready for SDK template from PDF template, XML template or P2DTA which is not ready for sdk, use an appropriate method(s) from Pdf2DataTemplateConverter.
static com.itextpdf.pdf2data.template.Template	parseTemplateFromPDF(String templatePDF) Deprecated. To work with Pdf2DataExtractor class use create(File). If you have PDF template, XML template or P2DTA which is not ready for sdk, then first use an appropriate method(s) from Pdf2DataTemplateConverter.
static void	parseTemplateFromPDF(String templatePDF, String outXML) Deprecated. To obtain P2D ready for SDK template from PDF template, XML template or P2DTA which is not ready for sdk, use an appropriate method(s) from Pdf2DataTemplateConverter.
static com.itextpdf.pdf2data.template.Template	parseTemplateFromXML(InputStream xmlInputStream) Deprecated. To parse ready for SDK template use create(File). If you have PDF template, XML template or P2DTA which is not ready for sdk, then first use an appropriate method(s) from Pdf2DataTemplateConverter.
static com.itextpdf.pdf2data.template.Template	parseTemplateFromXML(String templateXML) Deprecated. To work with Pdf2DataExtractor class use create(File). If you have PDF template, XML template or P2DTA which is not ready for sdk, then first use an appropriate method(s) from Pdf2DataTemplateConverter.
ParsingResult	recognize(File targetPDF) Recognize a pdf file.
ParsingResult	recognize(File targetPDF, RecognitionProperties properties) Recognize a pdf file.
ParsingResult	recognize(InputStream targetInputStream) Recognize a pdf file.
ParsingResult	recognize(InputStream targetInputStream, OutputStream pdfOutputStream) Deprecated. use recognize(File) instead.
ParsingResult	recognize(InputStream targetInputStream, RecognitionProperties properties) Recognize a pdf file.
ParsingResult	recognize(String targetPDF) Deprecated. use recognize(File) instead.
ParsingResult	recognize(String targetPDF, String outputPDF) Deprecated. use recognize(File) instead.
static ParsingResult	recognize(com.itextpdf.pdf2data.template.Template template, InputStream targetInputStream) Deprecated. use recognize(InputStream) instead.
static ParsingResult	recognize(com.itextpdf.pdf2data.template.Template template, InputStream targetInputStream, OutputStream pdfOutputStream) Deprecated. use recognize(InputStream) instead.
static ParsingResult	recognize(com.itextpdf.pdf2data.template.Template template, InputStream targetInputStream, OutputStream pdfOutputStream, RecognitionProperties properties) Deprecated. use recognize(InputStream, RecognitionProperties) instead.
static ParsingResult	recognize(com.itextpdf.pdf2data.template.Template template, String targetPDF) Deprecated. use recognize(File) instead.
static ParsingResult	recognize(com.itextpdf.pdf2data.template.Template template, String targetPDF, String outputPDF) Deprecated. use recognize(File) instead.
static void	recognizeToJson(com.itextpdf.pdf2data.template.Template template, InputStream targetInputStream, OutputStream jsonOutputStream, RecognitionProperties properties) Deprecated. use recognize(InputStream, RecognitionProperties) with ParsingResult.saveToJson(OutputStream, SerializationProperties) instead.
static void	recognizeToJson(com.itextpdf.pdf2data.template.Template template, String targetPDF, String outputJson, RecognitionProperties properties) Deprecated. use recognize(File, RecognitionProperties) with ParsingResult.saveToJson(OutputStream, SerializationProperties) instead.
void	recognizeToXML(InputStream targetInputStream, OutputStream pdfOutputStream, OutputStream xmlOutputStream) Deprecated. use recognize(InputStream) with ParsingResult.saveToXml(OutputStream) instead.
void	recognizeToXML(InputStream targetInputStream, OutputStream pdfOutputStream, OutputStream xmlOutputStream, RecognitionProperties properties) Deprecated. use recognize(InputStream, RecognitionProperties) with ParsingResult.saveToXml(OutputStream, SerializationProperties) instead.
void	recognizeToXML(String targetPDF, String outputPDF, String outputXML) Deprecated. use recognize(File) with ParsingResult.saveToXml(File) instead.
void	recognizeToXML(String targetPDF, String outputPDF, String outputXML, RecognitionProperties properties) Deprecated. use recognize(File, RecognitionProperties) with ParsingResult.saveToXml(File, SerializationProperties) instead.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, InputStream targetInputStream, OutputStream xmlOutputStream) Deprecated. use recognize(InputStream) with ParsingResult.saveToXml(OutputStream) instead.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, InputStream targetInputStream, OutputStream pdfOutputStream, OutputStream xmlOutputStream) Deprecated. use recognize(InputStream) with ParsingResult.saveToXml(OutputStream) instead.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, InputStream targetInputStream, OutputStream pdfOutputStream, OutputStream xmlOutputStream, RecognitionProperties properties) Deprecated. use recognize(InputStream, RecognitionProperties) with ParsingResult.saveToXml(OutputStream, SerializationProperties) instead.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, InputStream targetInputStream, OutputStream xmlOutputStream, RecognitionProperties properties) Deprecated. use recognize(InputStream, RecognitionProperties) with ParsingResult.saveToXml(OutputStream, SerializationProperties) instead.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, String targetPDF, String outputXML) Deprecated. use recognize(File) with ParsingResult.saveToXml(File) instead.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, String targetPDF, String outputXML, RecognitionProperties properties) Deprecated. use recognize(File, RecognitionProperties) with ParsingResult.saveToXml(File, SerializationProperties) instead.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, String targetPDF, String outputPDF, String outputXML) Deprecated. use recognize(File) with ParsingResult.saveToXml(File) instead.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, String targetPDF, String outputPDF, String outputXML, RecognitionProperties properties) Deprecated. use recognize(File, RecognitionProperties) with ParsingResult.saveToXml(File, SerializationProperties) instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

Pdf2DataExtractor

@Deprecated
public Pdf2DataExtractor(com.itextpdf.pdf2data.template.Template template)

Deprecated. To create an instance use create(File).

Creates instance of Pdf2DataExtractor with passed template entity.

Parameters:

template - template, which will be used in recognition.

Method Detail

create

public static Pdf2DataExtractor create(File p2dFile)
                                throws IOException

Creates instance of Pdf2DataExtractor from pdf2data template file. Note that template should be processed.

Parameters:

p2dFile - pdf2data template archive

Returns:

a Pdf2DataExtractor instance.

Throws:

IOException - if any I/O exception occurs

com.itextpdf.pdf2data.exceptions.TemplateConversionException - if it's impossible to extract template from passed archive

parseTemplateFromPDF

@Deprecated
public static com.itextpdf.pdf2data.template.Template parseTemplateFromPDF(String templatePDF)
                                                                                 throws IOException

Deprecated. To work with Pdf2DataExtractor class use create(File). If you have PDF template, XML template or P2DTA which is not ready for sdk, then first use an appropriate method(s) from Pdf2DataTemplateConverter.

Parses the template from pdf file.

Parameters:

templatePDF - a path to pdf file

Returns:

A template instance.

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

parseTemplateFromPDF

@Deprecated
public static void parseTemplateFromPDF(String templatePDF,
                                                     String outXML)
                                              throws IOException

Deprecated. To obtain P2D ready for SDK template from PDF template, XML template or P2DTA which is not ready for sdk, use an appropriate method(s) from Pdf2DataTemplateConverter.

Parses the template from pdf file and save it into xml file.

Parameters:

templatePDF - a path to pdf file

outXML - a path to xml file

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

parseTemplateFromPDF

@Deprecated
public static com.itextpdf.pdf2data.template.Template parseTemplateFromPDF(InputStream templateInputStream)
                                                                                 throws IOException

Deprecated. To work with Pdf2DataExtractor class use create(File). If you have PDF template, XML template or P2DTA which is not ready for sdk, then first use an appropriate method(s) from Pdf2DataTemplateConverter.

Parses the template from input stream.

Parameters:

templateInputStream - pdf input stream with template

Returns:

A template instance.

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

parseTemplateFromPDF

@Deprecated
public static void parseTemplateFromPDF(InputStream templateInputStream,
                                                     OutputStream xmlStream)
                                              throws IOException

Deprecated. To obtain P2D ready for SDK template from PDF template, XML template or P2DTA which is not ready for sdk, use an appropriate method(s) from Pdf2DataTemplateConverter.

Parses the template from pdf input stream and save it into output stream in xml form.

Parameters:

templateInputStream - input stream with template

xmlStream - output stream for saving template

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

parseTemplateFromXML

@Deprecated
public static com.itextpdf.pdf2data.template.Template parseTemplateFromXML(String templateXML)
                                                                                 throws IOException

Deprecated. To work with Pdf2DataExtractor class use create(File). If you have PDF template, XML template or P2DTA which is not ready for sdk, then first use an appropriate method(s) from Pdf2DataTemplateConverter.

Gets the template from xml file.

Parameters:

templateXML - a path to xml file

Returns:

Template instance.

Throws:

IOException - if any I/O issue occurs

parseTemplateFromXML

@Deprecated
public static com.itextpdf.pdf2data.template.Template parseTemplateFromXML(InputStream xmlInputStream)
                                                                                 throws IOException

Deprecated. To parse ready for SDK template use create(File). If you have PDF template, XML template or P2DTA which is not ready for sdk, then first use an appropriate method(s) from Pdf2DataTemplateConverter.

Gets the template from input stream.

Parameters:

xmlInputStream - input stream that contains template in xml form

Returns:

Template instance.

Throws:

IOException - if any I/O issue occurs

recognize

@Deprecated
public static ParsingResult recognize(com.itextpdf.pdf2data.template.Template template,
                                                   String targetPDF)
                                            throws IOException

Deprecated. use recognize(File) instead.

Recognizes a pdf file using template instance.

Parameters:

template - template instance

targetPDF - path to pdf file for recognition

Returns:

Result of recognition.

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

recognize

@Deprecated
public static ParsingResult recognize(com.itextpdf.pdf2data.template.Template template,
                                                   String targetPDF,
                                                   String outputPDF)
                                            throws IOException

Deprecated. use recognize(File) instead.

Recognize a pdf file using template instance and write results to pdf file.

Parameters:

template - template instance

targetPDF - path to pdf file for recognition

outputPDF - path to pdf file with recognition results (annotation type)

Returns:

Result of recognition.

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

com.itextpdf.pdf2data.exceptions.DocumentAnnotationsDeniedException - if pdf document is encrypted and creating/modifying annotations is not permitted

recognize

@Deprecated
public static ParsingResult recognize(com.itextpdf.pdf2data.template.Template template,
                                                   InputStream targetInputStream)
                                            throws IOException

Deprecated. use recognize(InputStream) instead.

Recognizes a pdf file using template instance.

Parameters:

template - template instance

targetInputStream - input stream from pdf file for recognition

Returns:

Result of recognition.

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

recognize

@Deprecated
public static ParsingResult recognize(com.itextpdf.pdf2data.template.Template template,
                                                   InputStream targetInputStream,
                                                   OutputStream pdfOutputStream)
                                            throws IOException

Deprecated. use recognize(InputStream) instead.

Recognizes a pdf file using template instance and write results to pdf file.

Parameters:

template - template instance

targetInputStream - input stream from pdf file for recognition

pdfOutputStream - output stream for writing recognition results (pdf annotation type)

Returns:

Result of recognition.

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

com.itextpdf.pdf2data.exceptions.DocumentAnnotationsDeniedException - if pdf document is encrypted and creating/modifying annotations is not permitted

recognize

@Deprecated
public static ParsingResult recognize(com.itextpdf.pdf2data.template.Template template,
                                                   InputStream targetInputStream,
                                                   OutputStream pdfOutputStream,
                                                   RecognitionProperties properties)
                                            throws IOException

Deprecated. use recognize(InputStream, RecognitionProperties) instead.

Recognizes a pdf file using template instance and write results to pdf file.

Parameters:

template - template instance

targetInputStream - input stream from pdf file for recognition

pdfOutputStream - output stream for writing recognition results (pdf annotation type)

properties - a RecognitionProperties instance

Returns:

Result of recognition.

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

com.itextpdf.pdf2data.exceptions.DocumentAnnotationsDeniedException - if pdf document is encrypted and creating/modifying annotations is not permitted

recognizeToXML

@Deprecated
public static void recognizeToXML(com.itextpdf.pdf2data.template.Template template,
                                               String targetPDF,
                                               String outputXML)
                                        throws IOException

Deprecated. use recognize(File) with ParsingResult.saveToXml(File) instead.

Recognize a pdf file using template instance and save results to xml file.

Parameters:

template - template instance

targetPDF - path to pdf file for recognition

outputXML - path to xml file with recognition results

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

recognizeToXML

@Deprecated
public static void recognizeToXML(com.itextpdf.pdf2data.template.Template template,
                                               String targetPDF,
                                               String outputXML,
                                               RecognitionProperties properties)
                                        throws IOException

Deprecated. use recognize(File, RecognitionProperties) with ParsingResult.saveToXml(File, SerializationProperties) instead.

Recognize a pdf file using template instance and save results to xml file.

Parameters:

template - template instance

targetPDF - path to pdf file for recognition

outputXML - path to xml file with recognition results

properties - a RecognitionProperties instance

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

recognizeToXML

@Deprecated
public static void recognizeToXML(com.itextpdf.pdf2data.template.Template template,
                                               String targetPDF,
                                               String outputPDF,
                                               String outputXML)
                                        throws IOException

Deprecated. use recognize(File) with ParsingResult.saveToXml(File) instead.

Recognize a pdf file using template instance and save results to xml and pdf files.

Parameters:

template - template instance

targetPDF - path to pdf file for recognition

outputPDF - path to pdf file with recognition results (annotation type)

outputXML - path to xml file with recognition results

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

com.itextpdf.pdf2data.exceptions.DocumentAnnotationsDeniedException - if pdf document is encrypted and creating/modifying annotations is not permitted

recognizeToXML

@Deprecated
public static void recognizeToXML(com.itextpdf.pdf2data.template.Template template,
                                               String targetPDF,
                                               String outputPDF,
                                               String outputXML,
                                               RecognitionProperties properties)
                                        throws IOException

Deprecated. use recognize(File, RecognitionProperties) with ParsingResult.saveToXml(File, SerializationProperties) instead.

Recognize a pdf file using template instance and save results to xml and pdf files.

Parameters:

template - template instance

targetPDF - path to pdf file for recognition

outputPDF - path to pdf file with recognition results (annotation type)

outputXML - path to xml file with recognition results

properties - a RecognitionProperties instance

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

com.itextpdf.pdf2data.exceptions.DocumentAnnotationsDeniedException - if pdf document is encrypted and creating/modifying annotations is not permitted

recognizeToJson

@Deprecated
public static void recognizeToJson(com.itextpdf.pdf2data.template.Template template,
                                                String targetPDF,
                                                String outputJson,
                                                RecognitionProperties properties)
                                         throws IOException

Deprecated. use recognize(File, RecognitionProperties) with ParsingResult.saveToJson(OutputStream, SerializationProperties) instead.

Recognize a pdf file using template instance and save results to json file.

Parameters:

template - template instance

targetPDF - path to pdf file for recognition

outputJson - path to json file with recognition results

properties - a RecognitionProperties instance

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

com.itextpdf.pdf2data.exceptions.DocumentAnnotationsDeniedException - if pdf document is encrypted and creating/modifying annotations is not permitted

recognizeToXML

@Deprecated
public static void recognizeToXML(com.itextpdf.pdf2data.template.Template template,
                                               InputStream targetInputStream,
                                               OutputStream xmlOutputStream)
                                        throws IOException

Deprecated. use recognize(InputStream) with ParsingResult.saveToXml(OutputStream) instead.

Recognize a pdf file using template instance and save results to xml file.

Parameters:

template - template instance

targetInputStream - input stream from pdf file for recognition

xmlOutputStream - output stream for writing recognition results (xml type)

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

recognizeToXML

@Deprecated
public static void recognizeToXML(com.itextpdf.pdf2data.template.Template template,
                                               InputStream targetInputStream,
                                               OutputStream xmlOutputStream,
                                               RecognitionProperties properties)
                                        throws IOException

Deprecated. use recognize(InputStream, RecognitionProperties) with ParsingResult.saveToXml(OutputStream, SerializationProperties) instead.

Recognize a pdf file using template instance and save results to xml file.

Parameters:

template - template instance

targetInputStream - input stream from pdf file for recognition

xmlOutputStream - output stream for writing recognition results (xml type)

properties - a RecognitionProperties instance

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

recognizeToXML

@Deprecated
public static void recognizeToXML(com.itextpdf.pdf2data.template.Template template,
                                               InputStream targetInputStream,
                                               OutputStream pdfOutputStream,
                                               OutputStream xmlOutputStream)
                                        throws IOException

Deprecated. use recognize(InputStream) with ParsingResult.saveToXml(OutputStream) instead.

Recognize a pdf file using template instance and save results to xml and pdf files.

Parameters:

template - template instance

targetInputStream - input stream from pdf file for recognition

pdfOutputStream - output stream for writing recognition results (pdf annotation type)

xmlOutputStream - output stream for writing recognition results (xml type)

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

com.itextpdf.pdf2data.exceptions.DocumentAnnotationsDeniedException - if pdf document is encrypted and creating/modifying annotations is not permitted

recognizeToXML

@Deprecated
public static void recognizeToXML(com.itextpdf.pdf2data.template.Template template,
                                               InputStream targetInputStream,
                                               OutputStream pdfOutputStream,
                                               OutputStream xmlOutputStream,
                                               RecognitionProperties properties)
                                        throws IOException

Deprecated. use recognize(InputStream, RecognitionProperties) with ParsingResult.saveToXml(OutputStream, SerializationProperties) instead.

Recognize a pdf file using template instance and save results to xml and pdf files.

Parameters:

template - template instance

targetInputStream - input stream from pdf file for recognition

pdfOutputStream - output stream for writing recognition results (pdf annotation type)

xmlOutputStream - output stream for writing recognition results (xml type)

properties - a RecognitionProperties instance

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

com.itextpdf.pdf2data.exceptions.DocumentAnnotationsDeniedException - if pdf document is encrypted and creating/modifying annotations is not permitted

recognizeToJson

@Deprecated
public static void recognizeToJson(com.itextpdf.pdf2data.template.Template template,
                                                InputStream targetInputStream,
                                                OutputStream jsonOutputStream,
                                                RecognitionProperties properties)
                                         throws IOException

Deprecated. use recognize(InputStream, RecognitionProperties) with ParsingResult.saveToJson(OutputStream, SerializationProperties) instead.

Recognize a pdf file using template instance and save results to json and pdf files.

Parameters:

template - template instance

targetInputStream - input stream from pdf file for recognition

jsonOutputStream - output stream for writing recognition results (json type)

properties - a RecognitionProperties instance

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

com.itextpdf.pdf2data.exceptions.DocumentAnnotationsDeniedException - if pdf document is encrypted and creating/modifying annotations is not permitted

recognize

@Deprecated
public ParsingResult recognize(String targetPDF)
                                     throws IOException

Deprecated. use recognize(File) instead.

Recognize a pdf file using template instance.

Parameters:

targetPDF - path to pdf file for recognition

Returns:

Result of recognition.

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

recognize

@Deprecated
public ParsingResult recognize(String targetPDF,
                                            String outputPDF)
                                     throws IOException

Deprecated. use recognize(File) instead.

Recognize a pdf file using template instance and write results to pdf file.

Parameters:

targetPDF - path to pdf file for recognition

outputPDF - path to pdf file with recognition results (annotation type)

Returns:

Result of recognition.

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

com.itextpdf.pdf2data.exceptions.DocumentAnnotationsDeniedException - if pdf document is encrypted and creating/modifying annotations is not permitted

recognize

@Deprecated
public ParsingResult recognize(InputStream targetInputStream,
                                            OutputStream pdfOutputStream)
                                     throws IOException

Deprecated. use recognize(File) instead.

Recognize a pdf file using template instance and write results to pdf file.

Parameters:

targetInputStream - input stream from pdf file for recognition

pdfOutputStream - output stream for writing recognition results (pdf annotation type)

Returns:

Result of recognition.

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

com.itextpdf.pdf2data.exceptions.DocumentAnnotationsDeniedException - if pdf document is encrypted and creating/modifying annotations is not permitted

recognizeToXML

@Deprecated
public void recognizeToXML(String targetPDF,
                                        String outputPDF,
                                        String outputXML)
                                 throws IOException

Deprecated. use recognize(File) with ParsingResult.saveToXml(File) instead.

Recognize a pdf file using template instance and save results to xml and pdf files.

Parameters:

targetPDF - path to pdf file for recognition

outputPDF - path to pdf file with recognition results (annotation type)

outputXML - path to xml file with recognition results

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

com.itextpdf.pdf2data.exceptions.DocumentAnnotationsDeniedException - if pdf document is encrypted and creating/modifying annotations is not permitted

recognizeToXML

@Deprecated
public void recognizeToXML(String targetPDF,
                                        String outputPDF,
                                        String outputXML,
                                        RecognitionProperties properties)
                                 throws IOException

Deprecated. use recognize(File, RecognitionProperties) with ParsingResult.saveToXml(File, SerializationProperties) instead.

Recognize a pdf file using template instance and save results to xml and pdf files.

Parameters:

targetPDF - path to pdf file for recognition

outputPDF - path to pdf file with recognition results (annotation type)

outputXML - path to xml file with recognition results

properties - a RecognitionProperties instance

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

com.itextpdf.pdf2data.exceptions.DocumentAnnotationsDeniedException - if pdf document is encrypted and creating/modifying annotations is not permitted

recognizeToXML

@Deprecated
public void recognizeToXML(InputStream targetInputStream,
                                        OutputStream pdfOutputStream,
                                        OutputStream xmlOutputStream)
                                 throws IOException

Deprecated. use recognize(InputStream) with ParsingResult.saveToXml(OutputStream) instead.

Recognize a pdf file using template instance and save results to xml and pdf files.

Parameters:

targetInputStream - input stream from pdf file for recognition

pdfOutputStream - output stream for writing recognition results (pdf annotation type)

xmlOutputStream - output stream for writing recognition results (xml type)

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

com.itextpdf.pdf2data.exceptions.DocumentAnnotationsDeniedException - if pdf document is encrypted and creating/modifying annotations is not permitted

recognizeToXML

@Deprecated
public void recognizeToXML(InputStream targetInputStream,
                                        OutputStream pdfOutputStream,
                                        OutputStream xmlOutputStream,
                                        RecognitionProperties properties)
                                 throws IOException

Deprecated. use recognize(InputStream, RecognitionProperties) with ParsingResult.saveToXml(OutputStream, SerializationProperties) instead.

Recognize a pdf file using template instance and save results to xml and pdf files.

Parameters:

targetInputStream - input stream from pdf file for recognition

pdfOutputStream - output stream for writing recognition results (pdf annotation type)

xmlOutputStream - output stream for writing recognition results (xml type)

properties - a RecognitionProperties instance

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

com.itextpdf.pdf2data.exceptions.DocumentAnnotationsDeniedException - if pdf document is encrypted and creating/modifying annotations is not permitted

getTemplate

public com.itextpdf.pdf2data.template.Template getTemplate()

Gets current template instance.

Returns:

current template instance

recognize

public ParsingResult recognize(File targetPDF)
                        throws IOException

Recognize a pdf file.

Parameters:

targetPDF - pdf file for recognition

Returns:

ParsingResult instance

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

recognize

public ParsingResult recognize(File targetPDF,
                               RecognitionProperties properties)
                        throws IOException

Recognize a pdf file.

Parameters:

targetPDF - pdf file for recognition

properties - a RecognitionProperties instance

Returns:

ParsingResult instance

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

recognize

public ParsingResult recognize(InputStream targetInputStream)
                        throws IOException

Recognize a pdf file.

Parameters:

targetInputStream - input stream from pdf file for recognition

Returns:

ParsingResult instance

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted

recognize

public ParsingResult recognize(InputStream targetInputStream,
                               RecognitionProperties properties)
                        throws IOException

Recognize a pdf file.

Parameters:

targetInputStream - input stream from pdf file for recognition

properties - a RecognitionProperties instance

Returns:

ParsingResult instance

Throws:

IOException - if any I/O issue occurs

com.itextpdf.pdf2data.exceptions.DocumentExtractionDeniedException - if pdf document is encrypted and extracting text is not permitted