Pr22.Processing

Class Document

java.lang.Object

Pr22.Processing.Document

public class Document
extends java.lang.Object

Stores the results of analyzing tasks.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Document.FileFormat Document data file formats.

Method Summary

Modifier and Type	Method and Description
Field	getField(FieldReference fieldCode) Returns a Field of the Document.
Field	getField(FieldSource source, FieldId id) Returns a Field of the Document.
Field	getField(FieldSource source, FieldId id, int index) Returns a Field of the Document.
java.util.ArrayList<FieldCompare>	getFieldCompareList() Returns the results of field value comparisons.
java.util.ArrayList<FieldReference>	getFields() Returns a list of FieldReferences from the Document.
java.util.ArrayList<FieldReference>	getFields(EngineTask filter) Returns a list of FieldReferences from the Document.
Document	getPart(int index) Returns a simple document data of a "Root Document".
Status	getStatus() Returns the overall Status of the document.
static Document	merge(Document one, Document other) Generates a summary Document.
BinData	save(Document.FileFormat fileFormat) Saves the document to the memory in a specific file format.
Variant	toVariant() Returns the internal variant data to access rarely requested information.

Methods inherited from class java.lang.Object

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

Method Detail

toVariant

public Variant toVariant()
                  throws General

Returns the internal variant data to access rarely requested information.

Returns:

The data.

Throws:

General

getFields

public java.util.ArrayList<FieldReference> getFields()
                                              throws General

Returns a list of FieldReferences from the Document.

Returns:

List of FieldReferences.

Throws:

General

getFields

public java.util.ArrayList<FieldReference> getFields(EngineTask filter)
                                              throws General

Returns a list of FieldReferences from the Document.

Parameters:

filter - Filter for the list.

Returns:

List of FieldReferences.

Throws:

General

getPart

public Document getPart(int index)
                 throws General

Returns a simple document data of a "Root Document". It represents the result of one analyzer method called for the document before. The Engine.getRootDocument() method returns a so called Root Document that contains the results of all methods called for the current document.

Parameters:

index - The ordinal number of the document part.

Returns:

The document part.

Throws:

General

getField

public Field getField(FieldSource source,
                      FieldId id)
               throws General

Returns a Field of the Document.

Parameters:

source - Id of the FieldSource.

id - FieldId.

Returns:

Field data.

Throws:

General

getField

public Field getField(FieldSource source,
                      FieldId id,
                      int index)
               throws General

Returns a Field of the Document.

Parameters:

source - Id of the FieldSource.

id - FieldId.

index - Index of the fields having the same Ids.

Returns:

Field data.

Throws:

General

getField

public Field getField(FieldReference fieldCode)
               throws General

Returns a Field of the Document.

Parameters:

fieldCode - A FieldReference returned by the getFields(Pr22.Task.EngineTask) method.

Returns:

Field data.

Throws:

General

getStatus

public Status getStatus()
                 throws General

Returns the overall Status of the document.

Returns:

A Status value.

Throws:

General

save

public BinData save(Document.FileFormat fileFormat)
             throws General

Saves the document to the memory in a specific file format. Only "Root Documents" returned by the Engine.getRootDocument() method can be loaded back to the system.

Parameters:

fileFormat - The file format.

Returns:

Output raw memory data.

Throws:

General

merge

public static Document merge(Document one,
                             Document other)
                      throws General

Generates a summary Document. Currently, only the comparison of passport VIZ photo and RFID photo is supported.

Parameters:

one - A Document.

other - Other Document.

Returns:

The summary Document.

Throws:

General

getFieldCompareList

public java.util.ArrayList<FieldCompare> getFieldCompareList()
                                                      throws General

Returns the results of field value comparisons.

Returns:

Results of field value comparisons.

Throws:

General