org.jmrtd.lds

Class MRZInfo

java.lang.Object

org.jmrtd.lds.MRZInfo

All Implemented Interfaces:

java.io.Serializable, LDSElement

public class MRZInfo
extends java.lang.Object

Data structure for storing the MRZ information as found in DG1. Based on ICAO Doc 9303 part 1 and 3.

Version:

$Revision: 1578 $

Author:

The JMRTD team ([email protected])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOC_TYPE_ID1 ID1 document type for credit card sized identity cards.
static int	DOC_TYPE_ID2 ID2 document type.
static int	DOC_TYPE_ID3 ID3 document type for passport booklets.
static int	DOC_TYPE_UNSPECIFIED Unspecified document type (do not use, choose ID1 or ID3).

Constructor Summary

Constructors

Constructor and Description
MRZInfo(java.io.InputStream inputStream, int length) Creates a new MRZ based on an input stream.
MRZInfo(java.lang.String str) Creates a new MRZ based on the text input.
MRZInfo(java.lang.String documentCode, java.lang.String issuingState, java.lang.String documentNumber, java.lang.String optionalData1, java.lang.String dateOfBirth, net.sf.scuba.data.Gender gender, java.lang.String dateOfExpiry, java.lang.String nationality, java.lang.String optionalData2, java.lang.String primaryIdentifier, java.lang.String secondaryIdentifier) Creates a new 3-line MRZ compliant with ICAO Doc 9303 part 3 vol 1.
MRZInfo(java.lang.String documentCode, java.lang.String issuingState, java.lang.String primaryIdentifier, java.lang.String secondaryIdentifier, java.lang.String documentNumber, java.lang.String nationality, java.lang.String dateOfBirth, net.sf.scuba.data.Gender gender, java.lang.String dateOfExpiry, java.lang.String personalNumber) Creates a new 2-line MRZ compliant with ICAO Doc 9303 part 1 vol 1.

Method Summary

Modifier and Type	Method and Description
static char	checkDigit(java.lang.String str) Computes the 7-3-1 check digit for part of the MRZ.
boolean	equals(java.lang.Object obj) Whether this MRZ info is identical to the other one.
static boolean	equalsModuloFillerChars(java.lang.String str1, java.lang.String str2) Tests equality of two MRZ string while ignoring extra filler characters.
java.lang.String	getDateOfBirth() Gets the date of birth of the passport holder.
java.lang.String	getDateOfExpiry() Gets the date of expiry
java.lang.String	getDocumentCode() Gets the document type.
java.lang.String	getDocumentNumber() Gets the document number.
int	getDocumentType() Gets the document type.
byte[]	getEncoded() Gets the encoded contents of this LDS info.
net.sf.scuba.data.Gender	getGender() Gets the passport holder's gender.
java.lang.String	getIssuingState() Gets the issuing state as a 3 letter code
java.lang.String	getNationality() Gets the passport holder's nationality as a 3 digit code.
java.lang.String	getOptionalData1() Gets the contents of the first optional data field for ID-1 and ID-3 style MRZs.
java.lang.String	getOptionalData2() Gets the contents of the second optional data field for ID-1 style MRZs.
java.lang.String	getPersonalNumber() Gets the personal number (if a personal number is encoded in optional data 1).
java.lang.String	getPrimaryIdentifier() Gets the passport holder's last name.
java.lang.String	getSecondaryIdentifier() Gets the document holder's first names.
java.lang.String[]	getSecondaryIdentifierComponents() Gets the document holder's first names.
int	hashCode() Gets a hash code for this MRZ info.
void	setDateOfBirth(java.lang.String dateOfBirth) Sets the date of birth.
void	setDateOfExpiry(java.lang.String dateOfExpiry) Sets the date of expiry.
void	setDocumentCode(java.lang.String documentCode)
void	setDocumentNumber(java.lang.String documentNumber) Sets the document number.
void	setGender(net.sf.scuba.data.Gender gender) Sets the gender.
void	setIssuingState(java.lang.String issuingState) Sets the issuing state.
void	setNationality(java.lang.String nationality) Sets the passport holder's nationality.
void	setOptionalData2(java.lang.String optionalData2) Sets the contents for the second optional data field for ID-1 style MRZs.
void	setPersonalNumber(java.lang.String personalNumber) Sets the personal number.
void	setPrimaryIdentifier(java.lang.String primaryIdentifier) Sets the passport holder's last name.
void	setSecondaryIdentifierComponents(java.lang.String[] secondaryIdentifiers) Sets the passport holder's first names.
void	setSecondaryIdentifiers(java.lang.String secondaryIdentifiers) Sets the passport holder's first names.
java.lang.String	toString() Creates a textual representation of this MRZ.
void	writeObject(java.io.OutputStream outputStream) Writes the MRZ to an output stream.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DOC_TYPE_UNSPECIFIED

public static final int DOC_TYPE_UNSPECIFIED

Unspecified document type (do not use, choose ID1 or ID3).

See Also:

Constant Field Values

DOC_TYPE_ID1

public static final int DOC_TYPE_ID1

ID1 document type for credit card sized identity cards. Specifies a 3-line MRZ, 30 characters wide.

See Also:

Constant Field Values

DOC_TYPE_ID2

public static final int DOC_TYPE_ID2

ID2 document type. Specifies a 2-line MRZ, 36 characters wide.

See Also:

Constant Field Values

DOC_TYPE_ID3

public static final int DOC_TYPE_ID3

ID3 document type for passport booklets. Specifies a 2-line MRZ, 44 characters wide.

See Also:

Constant Field Values

Constructor Detail

MRZInfo

public MRZInfo(java.lang.String documentCode,
               java.lang.String issuingState,
               java.lang.String primaryIdentifier,
               java.lang.String secondaryIdentifier,
               java.lang.String documentNumber,
               java.lang.String nationality,
               java.lang.String dateOfBirth,
               net.sf.scuba.data.Gender gender,
               java.lang.String dateOfExpiry,
               java.lang.String personalNumber)

Creates a new 2-line MRZ compliant with ICAO Doc 9303 part 1 vol 1.

Parameters:

documentCode - document code (1 or 2 digit, has to start with "P" or "V")

issuingState - issuing state as 3 digit string

primaryIdentifier - card holder last name

secondaryIdentifier - card holder first name(s)

documentNumber - document number

nationality - nationality as 3 digit string

dateOfBirth - date of birth

gender - gender

dateOfExpiry - date of expiry

personalNumber - either empty, or a personal number of maximum length 14, or other optional data of exact length 15

MRZInfo

public MRZInfo(java.lang.String documentCode,
               java.lang.String issuingState,
               java.lang.String documentNumber,
               java.lang.String optionalData1,
               java.lang.String dateOfBirth,
               net.sf.scuba.data.Gender gender,
               java.lang.String dateOfExpiry,
               java.lang.String nationality,
               java.lang.String optionalData2,
               java.lang.String primaryIdentifier,
               java.lang.String secondaryIdentifier)

Creates a new 3-line MRZ compliant with ICAO Doc 9303 part 3 vol 1.

Parameters:

documentCode - document code (1 or 2 digit, has to start with "I", "C", or "A")

issuingState - issuing state as 3 digit string

primaryIdentifier - card holder last name

secondaryIdentifier - card holder first name(s)

documentNumber - document number

nationality - nationality as 3 digit string

dateOfBirth - date of birth in YYMMDD format

gender - gender

dateOfExpiry - date of expiry in YYMMDD format

optionalData1 - optional data in line 1 of maximum length 15

optionalData2 - optional data in line 2 of maximum length 11

MRZInfo

public MRZInfo(java.io.InputStream inputStream,
               int length)

Creates a new MRZ based on an input stream.

Parameters:

inputStream - contains the contents (value) of DG1 (without the tag and length)

length - the length of the MRZInfo structure

MRZInfo

public MRZInfo(java.lang.String str)

Creates a new MRZ based on the text input. The text input may contain newlines, which will be ignored.

Parameters:

str - input text

Method Detail

writeObject

public void writeObject(java.io.OutputStream outputStream)
                 throws java.io.IOException

Writes the MRZ to an output stream. This just outputs the MRZ characters, and does not add newlines.

Parameters:

outputStream - the output stream to write to

Throws:

java.io.IOException

getDateOfBirth

public java.lang.String getDateOfBirth()

Gets the date of birth of the passport holder.

Returns:

date of birth

setDateOfBirth

public void setDateOfBirth(java.lang.String dateOfBirth)

Sets the date of birth.

Parameters:

dateOfBirth - new date of birth

getDateOfExpiry

public java.lang.String getDateOfExpiry()

Gets the date of expiry

Returns:

date of expiry

setDateOfExpiry

public void setDateOfExpiry(java.lang.String dateOfExpiry)

Sets the date of expiry.

Parameters:

dateOfExpiry - new date of expiry

getDocumentNumber

public java.lang.String getDocumentNumber()

Gets the document number.

Returns:

document number

setDocumentNumber

public void setDocumentNumber(java.lang.String documentNumber)

Sets the document number.

Parameters:

documentNumber - new document number

getDocumentType

public int getDocumentType()

Gets the document type.

Returns:

document type

getDocumentCode

public java.lang.String getDocumentCode()

Gets the document type.

Returns:

document type

setDocumentCode

public void setDocumentCode(java.lang.String documentCode)

getIssuingState

public java.lang.String getIssuingState()

Gets the issuing state as a 3 letter code

Returns:

issuing state

setIssuingState

public void setIssuingState(java.lang.String issuingState)

Sets the issuing state.

Parameters:

issuingState - new issuing state

getPrimaryIdentifier

public java.lang.String getPrimaryIdentifier()

Gets the passport holder's last name.

Returns:

name

setPrimaryIdentifier

public void setPrimaryIdentifier(java.lang.String primaryIdentifier)

Sets the passport holder's last name.

Parameters:

primaryIdentifier - new primary identifier

getSecondaryIdentifier

public java.lang.String getSecondaryIdentifier()

Gets the document holder's first names.

Returns:

the secondary identifier

getSecondaryIdentifierComponents

public java.lang.String[] getSecondaryIdentifierComponents()

Gets the document holder's first names.

Returns:

first names

setSecondaryIdentifierComponents

public void setSecondaryIdentifierComponents(java.lang.String[] secondaryIdentifiers)

Sets the passport holder's first names.

Parameters:

secondaryIdentifiers - new secondary identifiers

setSecondaryIdentifiers

public void setSecondaryIdentifiers(java.lang.String secondaryIdentifiers)

Sets the passport holder's first names.

Parameters:

secondaryIdentifiers - new secondary identifiers

getNationality

public java.lang.String getNationality()

Gets the passport holder's nationality as a 3 digit code.

Returns:

a country

setNationality

public void setNationality(java.lang.String nationality)

Sets the passport holder's nationality.

Parameters:

nationality - new nationality

getPersonalNumber

public java.lang.String getPersonalNumber()

Gets the personal number (if a personal number is encoded in optional data 1).

Returns:

personal number

setPersonalNumber

public void setPersonalNumber(java.lang.String personalNumber)

Sets the personal number.

Parameters:

personalNumber - new personal number

getOptionalData1

public java.lang.String getOptionalData1()

Gets the contents of the first optional data field for ID-1 and ID-3 style MRZs.

Returns:

optional data 1

getOptionalData2

public java.lang.String getOptionalData2()

Gets the contents of the second optional data field for ID-1 style MRZs.

Returns:

optional data 2

setOptionalData2

public void setOptionalData2(java.lang.String optionalData2)

Sets the contents for the second optional data field for ID-1 style MRZs.

Parameters:

optionalData2 - optional data 2

getGender

public net.sf.scuba.data.Gender getGender()

Gets the passport holder's gender.

Returns:

gender

setGender

public void setGender(net.sf.scuba.data.Gender gender)

Sets the gender.

Parameters:

gender - new gender

toString

public java.lang.String toString()

Creates a textual representation of this MRZ. This is the 2 or 3 line representation (depending on the document type) as it appears in the document. All lines end in a newline char.

Overrides:

toString in class java.lang.Object

Returns:

the MRZ as text

See Also:

Object.toString()

hashCode

public int hashCode()

Gets a hash code for this MRZ info.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code

equals

public boolean equals(java.lang.Object obj)

Whether this MRZ info is identical to the other one.

Overrides:

equals in class java.lang.Object

Returns:

a boolean

checkDigit

public static char checkDigit(java.lang.String str)

Computes the 7-3-1 check digit for part of the MRZ.

Parameters:

str - a part of the MRZ.

Returns:

the resulting check digit (in '0' - '9')

equalsModuloFillerChars

public static boolean equalsModuloFillerChars(java.lang.String str1,
                                              java.lang.String str2)

Tests equality of two MRZ string while ignoring extra filler characters.

Parameters:

str1 - an MRZ string

str2 - another MRZ string

Returns:

a boolean indicating whether the strings are equal modulo filler characters

getEncoded

public byte[] getEncoded()

Description copied from interface: LDSElement

Gets the encoded contents of this LDS info.

Specified by:

getEncoded in interface LDSElement

Returns:

a byte array containing the encoding of this LDS info