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 extract templates, use parseTemplateFromPDF(String pdfFile) or parseTemplateFromXML(String xmlFile).

To perform a single data extraction, use recognize(Template template, String sourcePdf).

To perform a batch extraction, it is recommended to create an instance of Pdf2DataExctractor and then use recognize(String sourcePdf) method for each pdf file.

Constructor Summary

Constructors

Constructor and Description
Pdf2DataExtractor(com.itextpdf.pdf2data.template.Template template)

Method Summary

Modifier and Type	Method and Description
static com.itextpdf.pdf2data.template.Template	parseTemplateFromPDF(InputStream templateInputStream) Parses the template from input stream.
static void	parseTemplateFromPDF(InputStream templateInputStream, OutputStream xmlStream) Parses the template from pdf input stream and save it into output stream in xml form.
static com.itextpdf.pdf2data.template.Template	parseTemplateFromPDF(String templatePDF) Parses the template from pdf file.
static void	parseTemplateFromPDF(String templatePDF, String outXML) Parses the template from pdf file and save it into xml file.
static com.itextpdf.pdf2data.template.Template	parseTemplateFromXML(InputStream xmlInputStream) Gets the template from input stream.
static com.itextpdf.pdf2data.template.Template	parseTemplateFromXML(String templateXML) Gets the template from xml file.
ParsingResult	recognize(InputStream targetInputStream) Recognize a pdf file using template instance.
ParsingResult	recognize(InputStream targetInputStream, OutputStream pdfOutputStream) Recognize a pdf file using template instance and write results to pdf file.
ParsingResult	recognize(String targetPDF) Recognize a pdf file using template instance.
ParsingResult	recognize(String targetPDF, String outputPDF) Recognize a pdf file using template instance and write results to pdf file.
static ParsingResult	recognize(com.itextpdf.pdf2data.template.Template template, InputStream targetInputStream) Recognizes a pdf file using template instance.
static ParsingResult	recognize(com.itextpdf.pdf2data.template.Template template, InputStream targetInputStream, OutputStream pdfOutputStream) Recognizes a pdf file using template instance and write results to pdf file.
static ParsingResult	recognize(com.itextpdf.pdf2data.template.Template template, String targetPDF) Recognizes a pdf file using template instance.
static ParsingResult	recognize(com.itextpdf.pdf2data.template.Template template, String targetPDF, String outputPDF) Recognize a pdf file using template instance and write results to pdf file.
void	recognizeToXML(InputStream targetInputStream, OutputStream pdfOutputStream, OutputStream xmlOutputStream) Recognize a pdf file using template instance and save results to xml and pdf files.
void	recognizeToXML(InputStream targetInputStream, OutputStream pdfOutputStream, OutputStream xmlOutputStream, RecognitionProperties properties) Recognize a pdf file using template instance and save results to xml and pdf files.
void	recognizeToXML(String targetPDF, String outputPDF, String outputXML) Recognize a pdf file using template instance and save results to xml and pdf files.
void	recognizeToXML(String targetPDF, String outputPDF, String outputXML, RecognitionProperties properties) Recognize a pdf file using template instance and save results to xml and pdf files.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, InputStream targetInputStream, OutputStream xmlOutputStream) Recognize a pdf file using template instance and save results to xml file.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, InputStream targetInputStream, OutputStream pdfOutputStream, OutputStream xmlOutputStream) Recognize a pdf file using template instance and save results to xml and pdf files.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, InputStream targetInputStream, OutputStream pdfOutputStream, OutputStream xmlOutputStream, RecognitionProperties properties) Recognize a pdf file using template instance and save results to xml and pdf files.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, InputStream targetInputStream, OutputStream xmlOutputStream, RecognitionProperties properties) Recognize a pdf file using template instance and save results to xml file.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, String targetPDF, String outputXML) Recognize a pdf file using template instance and save results to xml file.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, String targetPDF, String outputXML, RecognitionProperties properties) Recognize a pdf file using template instance and save results to xml file.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, String targetPDF, String outputPDF, String outputXML) Recognize a pdf file using template instance and save results to xml and pdf files.
static void	recognizeToXML(com.itextpdf.pdf2data.template.Template template, String targetPDF, String outputPDF, String outputXML, RecognitionProperties properties) Recognize a pdf file using template instance and save results to xml and pdf files.

Methods inherited from class java.lang.Object

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

Constructor Detail

Pdf2DataExtractor

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

Method Detail

parseTemplateFromPDF

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

Parses the template from pdf file.

Parameters:

templatePDF - a path to pdf file

Returns:

A template instance.

Throws:

IOException

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

parseTemplateFromPDF

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

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

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

parseTemplateFromPDF

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

Parses the template from input stream.

Parameters:

templateInputStream - pdf input stream with template

Returns:

A template instance.

Throws:

IOException

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

parseTemplateFromPDF

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

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

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

parseTemplateFromXML

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

Gets the template from xml file.

Parameters:

templateXML - a path to xml file

Returns:

Template instance.

Throws:

IOException

parseTemplateFromXML

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

Gets the template from input stream.

Parameters:

xmlInputStream - input stream that contains template in xml form

Returns:

Template instance.

Throws:

IOException

recognize

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

Recognizes a pdf file using template instance.

Parameters:

template - template instance

targetPDF - path to pdf file for recognition

Returns:

Result of recognition.

Throws:

IOException

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

recognize

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

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

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

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

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

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

recognize

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

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

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

public ParsingResult recognize(String targetPDF)
                        throws IOException

Recognize a pdf file using template instance.

Parameters:

targetPDF - path to pdf file for recognition

Returns:

Result of recognition.

Throws:

IOException

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

recognize

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

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

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

public ParsingResult recognize(InputStream targetInputStream)
                        throws IOException

Recognize a pdf file using template instance.

Parameters:

targetInputStream - input stream from pdf file for recognition

Returns:

Result of recognition.

Throws:

IOException

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

recognize

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

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

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

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

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

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

recognizeToXML

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

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

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

recognizeToXML

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

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

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

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

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

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

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

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

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

recognizeToXML

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

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

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

recognizeToXML

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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