Pr22.Processing

Class Field

java.lang.Object

Pr22.Processing.Field

public class Field
extends java.lang.Object

The Field is the base element of document analyzing results. The Field always contains an Id to give meaning for the data, the read data that can be binary or textual (or numeric values can be handled as textual data), and the status information of checking algorithms. If the Field is image-related then image data or image frame can be requested.

Field Summary

Fields

Modifier and Type	Field and Description
FieldReference	fieldRef Field identification data.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBasicStringValue() Returns the string data of the Field in the least modified format.
java.lang.String	getBestStringValue() Returns the string data of the Field in the most convenient format.
byte[]	getBinaryValue() Returns the binary data of the Field.
java.util.ArrayList<Checking>	getDetailedStatus() Returns a list of detailed status information of checking algorithms for the Field.
java.lang.String	getFormattedStringValue() Returns the formatted string data of the Field.
Frame	getFrame() Returns the geometric location of the Field.
RawImage	getImage() Returns the image of the Field.
java.lang.String	getRawStringValue() Returns the string data of the Field as it is read, with separator characters, including checksum.
java.lang.String	getStandardizedStringValue() Returns the data of the Field converted to a standard format.
Status	getStatus() Returns the Status information of checking algorithms for the Field.
Variant	toVariant() Returns the internal variant data to query special Field information.

Methods inherited from class java.lang.Object

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

Field Detail

fieldRef

public final FieldReference fieldRef

Field identification data.

Method Detail

getImage

public RawImage getImage()
                  throws General

Returns the image of the Field.

Returns:

The image of the Field.

Throws:

General

getStatus

public Status getStatus()
                 throws General

Returns the Status information of checking algorithms for the Field.

Returns:

The Status information.

Throws:

General

getDetailedStatus

public java.util.ArrayList<Checking> getDetailedStatus()

Returns a list of detailed status information of checking algorithms for the Field.

Returns:

List of detailed status information.

getRawStringValue

public java.lang.String getRawStringValue()
                                   throws General

Returns the string data of the Field as it is read, with separator characters, including checksum.

Returns:

The raw string value.

Throws:

General

getFormattedStringValue

public java.lang.String getFormattedStringValue()
                                         throws General

Returns the formatted string data of the Field. The separator characters are replaced with spaces and checksum values are not included.

Returns:

The formatted string value.

Throws:

General

getStandardizedStringValue

public java.lang.String getStandardizedStringValue()
                                            throws General

Returns the data of the Field converted to a standard format. Even the whole value can be replaced. E.g. converted from inches to centimeters.

Returns:

The standardized string value.

Throws:

General

getBasicStringValue

public java.lang.String getBasicStringValue()
                                     throws General

Returns the string data of the Field in the least modified format.

Returns:

The basic string value.

Throws:

General

getBestStringValue

public java.lang.String getBestStringValue()
                                    throws General

Returns the string data of the Field in the most convenient format.

Returns:

The best string value.

Throws:

General

getBinaryValue

public byte[] getBinaryValue()
                      throws General

Returns the binary data of the Field.

Returns:

The binary value.

Throws:

General

getFrame

public Frame getFrame()
               throws General

Returns the geometric location of the Field.

Returns:

The Frame of the Field.

Throws:

General

toVariant

public Variant toVariant()
                  throws General

Returns the internal variant data to query special Field information.

Returns:

The data.

Throws:

General