com.innovatrics.mrz

Class MrzParser

java.lang.Object

com.innovatrics.mrz.MrzParser

public class MrzParser
extends Object

Parses the MRZ records.

Author:

Martin Vysny

Field Summary

Fields

Modifier and Type	Field and Description
static char	FILLER The filler character, '<'.

Constructor Summary

Constructors

Constructor and Description
MrzParser(String mrz) Creates new parser which parses given MRZ record.

Method Summary

Modifier and Type	Method and Description
boolean	checkDigit(int col, int row, MrzRange strRange, String fieldName) Verifies the check digit.
boolean	checkDigit(int col, int row, String str, String fieldName) Verifies the check digit.
void	checkValidCharacters(MrzRange range) Checks that given range contains valid characters.
static int	computeCheckDigit(String str) Computes MRZ check digit for given string of characters.
static char	computeCheckDigitChar(String str) Computes MRZ check digit for given string of characters.
MrzFormat	getFormat()
String	getMrz()
String[]	getRows()
static String	nameToMrz(String surname, String givenNames, int length) Converts a surname and given names to a MRZ string, shortening them as per Doc 9303 Part 3 Vol 1 Section 6.7 of the MRZ specification when necessary.
static MrzRecord	parse(String mrz) Factory method, which parses the MRZ and returns appropriate record class.
MrzDate	parseDate(MrzRange range) Parses MRZ date.
String[]	parseName(MrzRange range) Parses the MRZ name in form of SURNAME <<FIRSTNAME<.
MrzSex	parseSex(int col, int row) Parses the "sex" value from given column/row.
String	parseString(MrzRange range) Parses a string in given range.
String	rawValue(MrzRange... range) Returns a raw MRZ value from given range.
static String	toMrz(String input, int length) Converts given string to a MRZ string: removes all accents, converts the string to upper-case and replaces all spaces and invalid characters with '<'.

Methods inherited from class java.lang.Object

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

Field Detail

FILLER

public static final char FILLER

The filler character, '<'.

See Also:

Constant Field Values

Constructor Detail

MrzParser

public MrzParser(String mrz)
          throws MrzParseException

Creates new parser which parses given MRZ record.

Parameters:

mrz - the MRZ record, not null.

Throws:

MrzParseException - could not parse MRZ

Method Detail

getMrz

public String getMrz()

Returns:

the MRZ record

getRows

public String[] getRows()

Returns:

the MRZ rows

getFormat

public MrzFormat getFormat()

Returns:

the MRZ format

parseName

public String[] parseName(MrzRange range)
                   throws MrzParseException

Parses the MRZ name in form of SURNAME <<FIRSTNAME<.

Parameters:

range - the range

Returns:

array of [surname, first_name], never null, always with a length of 2.

Throws:

MrzParseException - could not parse range

rawValue

public String rawValue(MrzRange... range)

Returns a raw MRZ value from given range. If multiple ranges are specified, the value is concatenated.

Parameters:

range - the ranges, not null.

Returns:

raw value, never null, may be empty.

checkValidCharacters

public void checkValidCharacters(MrzRange range)
                          throws MrzParseException

Checks that given range contains valid characters.

Parameters:

range - the range to check.

Throws:

MrzParseException - could not parse range

parseString

public String parseString(MrzRange range)
                   throws MrzParseException

Parses a string in given range. << are replaced with ", ", < is replaced by space.

Parameters:

range - the range

Returns:

parsed string.

Throws:

MrzParseException - could not parse range

checkDigit

public boolean checkDigit(int col,
                          int row,
                          MrzRange strRange,
                          String fieldName)

Verifies the check digit.

Parameters:

col - the 0-based column of the check digit.

row - the 0-based column of the check digit.

strRange - the range for which the check digit is computed.

fieldName - (optional) field name. Used only when validity check fails.

Returns:

true if check digit is valid, false if not

checkDigit

public boolean checkDigit(int col,
                          int row,
                          String str,
                          String fieldName)

Verifies the check digit.

Parameters:

col - the 0-based column of the check digit.

row - the 0-based column of the check digit.

str - the raw MRZ substring.

fieldName - (optional) field name. Used only when validity check fails.

Returns:

true if check digit is valid, false if not

parseDate

public MrzDate parseDate(MrzRange range)

Parses MRZ date.

Parameters:

range - the range containing the date, in the YYMMDD format. The range must be 6 characters long.

Returns:

parsed date

Throws:

IllegalArgumentException - if the range is not 6 characters long.

parseSex

public MrzSex parseSex(int col,
                       int row)

Parses the "sex" value from given column/row.

Parameters:

col - the 0-based column

row - the 0-based row

Returns:

sex, never null.

computeCheckDigit

public static int computeCheckDigit(String str)

Computes MRZ check digit for given string of characters.

Parameters:

str - the string

Returns:

check digit in range of 0..9, inclusive. See MRTD documentation part 15 for details.

computeCheckDigitChar

public static char computeCheckDigitChar(String str)

Computes MRZ check digit for given string of characters.

Parameters:

str - the string

Returns:

check digit in range of 0..9, inclusive. See MRTD documentation part 15 for details.

parse

public static MrzRecord parse(String mrz)
                       throws MrzParseException

Factory method, which parses the MRZ and returns appropriate record class.

Parameters:

mrz - MRZ to parse.

Returns:

record class.

Throws:

MrzParseException - could not parse MRZ

toMrz

public static String toMrz(String input,
                           int length)

Converts given string to a MRZ string: removes all accents, converts the string to upper-case and replaces all spaces and invalid characters with '<'.

Several characters are expanded:

Expanded characters

Character	Expand to
Ä	AE
Å	AA
Æ	AE
IJ	IJ
IJ	IJ
Ö	OE
Ø	OE
Ü	UE
ß	SS

Examples:

• toMrz("Sedím na konári", 20) yields "SEDIM<NA<KONARI<<<<<"
• toMrz("Pat, Mat", 8) yields "PAT<<MAT"
• toMrz("foo/bar baz", 4) yields "FOO<"
• toMrz("*$()&/\", 8) yields "<<<<<<<<"

Parameters:

input - the string to convert. Passing null is the same as passing in an empty string.

length - required length of the string. If given string is longer, it is truncated. If given string is shorter than given length, '<' characters are appended at the end. If -1, the string is neither truncated nor enlarged.

Returns:

MRZ-valid string.

nameToMrz

public static String nameToMrz(String surname,
                               String givenNames,
                               int length)

Converts a surname and given names to a MRZ string, shortening them as per Doc 9303 Part 3 Vol 1 Section 6.7 of the MRZ specification when necessary.

Parameters:

surname - the surname, not blank.

givenNames - given names, not blank.

length - required length of the string. If given string is longer, it is shortened. If given string is shorter than given length, '<' characters are appended at the end.

Returns:

name, properly converted to MRZ format of SURNAME<<GIVENNAMES<..., with the exact length of given length.