eu.id3.document

Class MrzHelper

java.lang.Object

eu.id3.document.MrzHelper

public class MrzHelper
extends java.lang.Object

Provides functionalities to decode and check a MRZ.

Constructor Summary

Constructors

Constructor and Description
MrzHelper()

Method Summary

Modifier and Type	Method and Description
static boolean	check(java.lang.String text, MrzType type) Checks the validity of a single line of an MRZ of a given type by checking the check digits.
static StringDict	decode(java.lang.String text, MrzType type) Decodes an MRZ of a given type and returns the values of the various fields.

Methods inherited from class java.lang.Object

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

Constructor Detail

MrzHelper

public MrzHelper()

Method Detail

check

public static boolean check(java.lang.String text,
                            MrzType type)
                     throws DocumentException

Checks the validity of a single line of an MRZ of a given type by checking the check digits.

Parameters:

text - The input MRZ line.

type - The input MRZ type according to ICAO-9303 standard.

Returns:

The result of the verification.

Throws:

DocumentException - An error has occurred during Document Library execution.

decode

public static StringDict decode(java.lang.String text,
                                MrzType type)
                         throws DocumentException

Decodes an MRZ of a given type and returns the values of the various fields.

Parameters:

text - The input MRZ.

type - The input MRZ type according to ICAO-9303 standard.

Returns:

A dictionary containing the fields and values decoded in the MRZ.

Throws:

DocumentException - An error has occurred during Document Library execution.