com.innovatrics.mrz.types

Enum MrzFormat

java.lang.Object

java.lang.Enum<MrzFormat>

com.innovatrics.mrz.types.MrzFormat

All Implemented Interfaces:

Serializable, Comparable<MrzFormat>

public enum MrzFormat
extends Enum<MrzFormat>

Lists all supported MRZ formats. Note that the order of the enum constants are important, see for example FRENCH_ID.

Author:

Martin Vysny, Pierrick Martin

Enum Constant Summary

Enum Constants

Enum Constant and Description
FRENCH_ID French 2 line/36 characters per line format, used with French ID cards.
MRTD_TD1 MRTD td1 format: A three line long, 30 characters per line format.
MRTD_TD2 MRTD td2 format: A two line long, 36 characters per line format.
MRV_VISA_A MRV type-A format: A two lines long, 44 characters per line format Need to occur before PASSPORT constant because of the same values for row/column.
MRV_VISA_B MRV type-B format: A two lines long, 36 characters per line format.
PASSPORT MRP Passport format: A two line long, 44 characters per line format.
SLOVAK_ID_234 Unknown 2 line/34 characters per line format, used with old Slovak ID cards.

Method Summary

Modifier and Type	Method and Description
static MrzFormat	get(String mrz) Detects given MRZ format.
int	getColumns()
Class<? extends MrzRecord>	getRecordClass()
int	getRows()
boolean	isFormatOf(String[] mrzRows) Checks if this format is able to parse given serialized MRZ record.
MrzRecord	newRecord() Creates new record instance with this type.
static MrzFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static MrzFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MRTD_TD1

public static final MrzFormat MRTD_TD1

MRTD td1 format: A three line long, 30 characters per line format.

FRENCH_ID

public static final MrzFormat FRENCH_ID

French 2 line/36 characters per line format, used with French ID cards. Need to occur before the MRTD_TD2 enum constant because of the same values for row/column. See below for the "if" test.

MRV_VISA_B

public static final MrzFormat MRV_VISA_B

MRV type-B format: A two lines long, 36 characters per line format. Need to occur before the MRTD_TD2 enum constant because of the same values for row/column. See below for the "if" test.

MRTD_TD2

public static final MrzFormat MRTD_TD2

MRTD td2 format: A two line long, 36 characters per line format.

MRV_VISA_A

public static final MrzFormat MRV_VISA_A

MRV type-A format: A two lines long, 44 characters per line format Need to occur before PASSPORT constant because of the same values for row/column. See below for the "if" test.

PASSPORT

public static final MrzFormat PASSPORT

MRP Passport format: A two line long, 44 characters per line format.

SLOVAK_ID_234

public static final MrzFormat SLOVAK_ID_234

Unknown 2 line/34 characters per line format, used with old Slovak ID cards.

Method Detail

values

public static MrzFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MrzFormat c : MrzFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MrzFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getRows

public final int getRows()

Returns:

the rows

getColumns

public final int getColumns()

Returns:

the columns

getRecordClass

public final Class<? extends MrzRecord> getRecordClass()

Returns:

the recordClass

isFormatOf

public boolean isFormatOf(String[] mrzRows)

Checks if this format is able to parse given serialized MRZ record.

Parameters:

mrzRows - MRZ record, separated into rows.

Returns:

true if given MRZ record is of this type, false otherwise.

get

public static final MrzFormat get(String mrz)
                           throws MrzParseException

Detects given MRZ format.

Parameters:

mrz - the MRZ string.

Returns:

the format, never null.

Throws:

MrzParseException - could not parse MRZ

newRecord

public final MrzRecord newRecord()

Creates new record instance with this type.

Returns:

never null record instance.