com.itextpdf.pdf2data.result

Class ParsingResult

java.lang.Object

com.itextpdf.pdf2data.result.ParsingResult

public class ParsingResult
extends Object

An object that contains results of recognition.

There are recognized data for each data field, messages for unrecognized data field (if it wasn't recognized due to some error) and some stats: number of correctly recognized data fields, number of data fields recognized with warnings and number of data fields recognized with errors.

Constructor Summary

Constructors

Constructor and Description
ParsingResult(com.itextpdf.pdf2data.template.Template template, Map<String,List<List>> recognizedElements)

Method Summary

Modifier and Type	Method and Description
Map<String,List<List<ResultElement>>>	getAllResults() Returns a map with recognition results.
int	getCorrectNumber() Returns a number of data fields that were recognized correctly.
int	getErrorsNumber() Returns a number of data fields that were recognized with errors.
ResultImage	getFirstResultAsImage(String dataFieldName) Checks if recognized elements for specified datafield are images and returns first of them.
ResultTable	getFirstResultAsTable(String dataFieldName) Checks if recognized elements for specified data field are tables and returns first of them.
ResultText	getFirstResultAsText(String dataFieldName) Checks if recognized elements for specified datafield aren't tables and returns first of them.
String	getMessage(String dataFieldName) Return an error or warning message for datafield.
Map<String,List<List>>	getRawResults() Returns raw recognition results.
List<ResultElement>	getResults(String dataFieldName) Returns list of recognized objects.
int	getWarningsNumber() Returns a number of data fields that were recognized with warnings.
void	saveToJson(File outputJson) Saves parsing results to provided json file.
void	saveToJson(File outputJson, SerializationProperties properties) Saves parsing results to provided json file.
void	saveToJson(OutputStream jsonOutputStream) Saves parsing results to output stream in json form.
void	saveToJson(OutputStream jsonOutputStream, SerializationProperties properties) Saves parsing results to output stream in json form.
void	saveToXml(File outputXml) Saves parsing results to provided xml file.
void	saveToXml(File outputXml, SerializationProperties properties) Saves parsing results to provided xml file.
void	saveToXml(OutputStream xmlOutputStream) Saves parsing results to output stream in xml form.
void	saveToXML(OutputStream xmlOutputStream) Deprecated. use saveToXml(OutputStream) instead.
void	saveToXML(OutputStream xmlOutputStream, RecognitionProperties properties) Deprecated. saveToXml(OutputStream, SerializationProperties) instead.
void	saveToXml(OutputStream xmlOutputStream, SerializationProperties properties) Saves parsing results to output stream in xml form.
void	saveToXML(String outputXML) Deprecated. use saveToXml(File) instead.
void	saveToXML(String outputXML, RecognitionProperties properties) Deprecated. use saveToXml(File, SerializationProperties) instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParsingResult

public ParsingResult(com.itextpdf.pdf2data.template.Template template,
                     Map<String,List<List>> recognizedElements)

Method Detail

getMessage

public String getMessage(String dataFieldName)

Return an error or warning message for datafield.

Parameters:

dataFieldName - datafield name

Returns:

The message if datafield wasn't recognized or null otherwise.

saveToXML

@Deprecated
public void saveToXML(String outputXML)

Deprecated. use saveToXml(File) instead.

Saves parsing results to xml file.

Parameters:

outputXML - path to xml file

saveToXML

@Deprecated
public void saveToXML(String outputXML,
                                   RecognitionProperties properties)

Deprecated. use saveToXml(File, SerializationProperties) instead.

Saves parsing results to xml file.

Parameters:

outputXML - path to xml file

properties - a RecognitionProperties instance

saveToXML

@Deprecated
public void saveToXML(OutputStream xmlOutputStream)

Deprecated. use saveToXml(OutputStream) instead.

Saves parsing results to output stream in xml form.

Parameters:

xmlOutputStream - output stream

saveToXML

@Deprecated
public void saveToXML(OutputStream xmlOutputStream,
                                   RecognitionProperties properties)

Deprecated. saveToXml(OutputStream, SerializationProperties) instead.

Saves parsing results to output stream in xml form.

Parameters:

xmlOutputStream - output stream

properties - a RecognitionProperties instance

saveToJson

public void saveToJson(File outputJson)
                throws IOException

Saves parsing results to provided json file.

Parameters:

outputJson - outputJson xml file

Throws:

IOException - if any I/O exception occurs

saveToJson

public void saveToJson(File outputJson,
                       SerializationProperties properties)
                throws IOException

Saves parsing results to provided json file.

Parameters:

outputJson - output stream

properties - a SerializationProperties instance

Throws:

IOException - if any I/O exception occurs

saveToJson

public void saveToJson(OutputStream jsonOutputStream)

Saves parsing results to output stream in json form.

Parameters:

jsonOutputStream - output stream

saveToJson

public void saveToJson(OutputStream jsonOutputStream,
                       SerializationProperties properties)

Saves parsing results to output stream in json form.

Parameters:

jsonOutputStream - output stream

properties - a SerializationProperties instance

saveToXml

public void saveToXml(File outputXml)
               throws IOException

Saves parsing results to provided xml file.

Parameters:

outputXml - xml file

Throws:

IOException - if any I/O exception occurs

saveToXml

public void saveToXml(File outputXml,
                      SerializationProperties properties)
               throws IOException

Saves parsing results to provided xml file.

Parameters:

outputXml - output stream

properties - a SerializationProperties instance

Throws:

IOException - if any I/O exception occurs

saveToXml

public void saveToXml(OutputStream xmlOutputStream)

Saves parsing results to output stream in xml form.

Parameters:

xmlOutputStream - output stream

saveToXml

public void saveToXml(OutputStream xmlOutputStream,
                      SerializationProperties properties)

Saves parsing results to output stream in xml form.

Parameters:

xmlOutputStream - output stream

properties - a SerializationProperties instance

getResults

public List<ResultElement> getResults(String dataFieldName)

Returns list of recognized objects.

Parameters:

dataFieldName - data field name

Returns:

list of corresponding recognized objects or null if recognition was aborted or there is no data field with specific name

getAllResults

public Map<String,List<List<ResultElement>>> getAllResults()

Returns a map with recognition results.

Returns:

Map with datafield name as key and list with recognition elements as value.

getRawResults

public Map<String,List<List>> getRawResults()

Returns raw recognition results.

Returns:

raw recognition results structure

getFirstResultAsTable

public ResultTable getFirstResultAsTable(String dataFieldName)

Checks if recognized elements for specified data field are tables and returns first of them.

Parameters:

dataFieldName - data field name

Returns:

first table or null if there are no recognized tables or null if recognition was aborted or there is no data field with specific name

Throws:

ClassCastException - if results for specified datafield aren't tables

getFirstResultAsImage

public ResultImage getFirstResultAsImage(String dataFieldName)

Checks if recognized elements for specified datafield are images and returns first of them.

Parameters:

dataFieldName - datafield name

Returns:

first image or null if there are no recognized images or null if recognition was aborted or there is no data field with specific name

Throws:

ClassCastException - if results for specified datafield aren't images

getFirstResultAsText

public ResultText getFirstResultAsText(String dataFieldName)

Checks if recognized elements for specified datafield aren't tables and returns first of them.

Parameters:

dataFieldName - datafield name

Returns:

first result as string or null if there are no recognized elements or null if recognition was aborted or there is no data field with specific name

Throws:

ClassCastException - if results for specified datafield are tables

getWarningsNumber

public int getWarningsNumber()

Returns a number of data fields that were recognized with warnings.

Returns:

the number of data fields that were recognized with warnings

getErrorsNumber

public int getErrorsNumber()

Returns a number of data fields that were recognized with errors.

Returns:

the number of data fields that were recognized with errors

getCorrectNumber

public int getCorrectNumber()

Returns a number of data fields that were recognized correctly.

Returns:

the number of data fields that were recognized correctly