Serialized Form (MRZ Java Parser 0.8 API)

Package com.innovatrics.mrz
- Class com.innovatrics.mrz.MrzNotFoundException extends Exception implements Serializable
- Class com.innovatrics.mrz.MrzParseException extends Exception implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - mrz
```
String mrz
```
      The MRZ string being parsed.
    - range
```
MrzRange range
```
      Range containing problematic characters.
    - format
```
MrzFormat format
```
      Expected MRZ format.
- Class com.innovatrics.mrz.MrzRange extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - column
```
int column
```
      0-based index of first character in the range.
    - columnTo
```
int columnTo
```
      0-based index of a character after last character in the range.
    - row
```
int row
```
      0-based row.
- Class com.innovatrics.mrz.MrzRecord extends Object implements Serializable
  - Serialized Fields
    - format
```
MrzFormat format
```
      Detected MRZ format.
    - recordName
```
String recordName
```
      Name used for record type.
    - code
```
MrzDocumentCode code
```
      The document code.
    - code1
```
char code1
```
      Document code, see MrzDocumentCode for details on allowed values.
    - code2
```
char code2
```
      For MRTD: Type, at discretion of states, but 1-2 should be IP for passport card, AC for crew member and IV is not allowed. For MRP: Type (for countries that distinguish between different types of passports).
    - issuingCountry
```
String issuingCountry
```
      Issuing country. An ISO 3166-1 alpha-3 country code of issuing country, with additional allowed values (according to article on Wikipedia):
      D: Germany
      
      GBD: British dependent territories citizen(note: the country code of the overseas territory is presently used to indicate issuing authority and nationality of BOTC)
      
      GBN: British National (Overseas)
      
      GBO: British Overseas citizen
      
      GBP: British protected person
      
      GBS: British subject
      
      UNA: specialized agency of the United Nations
      
      UNK: resident of Kosovo to whom a travel document has been issued by the United Nations Interim Administration Mission in Kosovo (UNMIK)
      
      UNO: United Nations Organization
      
      XOM: Sovereign Military Order of Malta
      
      XXA: stateless person, as per the 1954 Convention Relating to the Status of Stateless Persons
      
      XXB: refugee, as per the 1951 Convention Relating to the Status of Refugees
      
      XXC: refugee, other than defined above
      
      XXX: unspecified nationality
    - documentNumber
```
String documentNumber
```
      Document number, e.g. passport number.
    - surname
```
String surname
```
      The surname in uppercase.
    - givenNames
```
String givenNames
```
      The given names in uppercase, separated by spaces.
    - dateOfBirth
```
MrzDate dateOfBirth
```
      Date of birth.
    - sex
```
MrzSex sex
```
      Sex.
    - expirationDate
```
MrzDate expirationDate
```
      Expiration date of passport.
    - nationality
```
String nationality
```
      An ISO 3166-1 alpha-3 country code of nationality. See MrzRecord.issuingCountry for additional allowed values.
    - validDocumentNumber
```
boolean validDocumentNumber
```
      Check digits, usually common in every document.
    - validDateOfBirth
```
boolean validDateOfBirth
```
    - validExpirationDate
```
boolean validExpirationDate
```
    - validComposite
```
boolean validComposite
```
- Class com.innovatrics.mrz.MrzRecordOptional extends MrzRecord implements Serializable
  - Serialized Fields
    - optional
```
String optional
```
      For use of the issuing State or organization.
Package com.innovatrics.mrz.records
- Class com.innovatrics.mrz.records.FrenchIdCard extends MrzRecordOptional implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.innovatrics.mrz.records.MRP extends MrzRecord implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - personalNumber
```
String personalNumber
```
    - validPersonalNumber
```
boolean validPersonalNumber
```
- Class com.innovatrics.mrz.records.MrtdTd1 extends MrzRecordOptional implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - optional2
```
String optional2
```
      Optional (for U.S. passport holders, 21-29 may be corresponding passport number).
- Class com.innovatrics.mrz.records.MrtdTd2 extends MrzRecordOptional implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.innovatrics.mrz.records.MrvA extends MrzRecordOptional implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.innovatrics.mrz.records.MrvB extends MrzRecordOptional implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.innovatrics.mrz.records.SlovakId2x34 extends MrzRecordOptional implements Serializable
  
  serialVersionUID:
  
  1L
Package com.innovatrics.mrz.types
- Class com.innovatrics.mrz.types.MrzDate extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - year
```
int year
```
      Year, 00-99.
      Note: I am unable to find a specification of conversion of this value to a full year value.
    - month
```
int month
```
      Month, 1-12.
    - day
```
int day
```
      Day, 1-31.
    - mrz
```
String mrz
```
    - dateValid
```
boolean dateValid
```
      Is the date valid or not.

Serialized Form

Package com.innovatrics.mrz

Class com.innovatrics.mrz.MrzNotFoundException extends Exception implements Serializable

Class com.innovatrics.mrz.MrzParseException extends Exception implements Serializable

Serialized Fields

mrz

range

format

Class com.innovatrics.mrz.MrzRange extends Object implements Serializable

Serialized Fields

column

columnTo

row

Class com.innovatrics.mrz.MrzRecord extends Object implements Serializable

Serialized Fields

format

recordName

code

code1

code2

issuingCountry

documentNumber

surname

givenNames

dateOfBirth

sex

expirationDate

nationality

validDocumentNumber

validDateOfBirth

validExpirationDate

validComposite

Class com.innovatrics.mrz.MrzRecordOptional extends MrzRecord implements Serializable

Serialized Fields

optional

Package com.innovatrics.mrz.records

Class com.innovatrics.mrz.records.FrenchIdCard extends MrzRecordOptional implements Serializable

Class com.innovatrics.mrz.records.MRP extends MrzRecord implements Serializable

Serialized Fields

personalNumber

validPersonalNumber

Class com.innovatrics.mrz.records.MrtdTd1 extends MrzRecordOptional implements Serializable

Serialized Fields

optional2

Class com.innovatrics.mrz.records.MrtdTd2 extends MrzRecordOptional implements Serializable

Class com.innovatrics.mrz.records.MrvA extends MrzRecordOptional implements Serializable

Class com.innovatrics.mrz.records.MrvB extends MrzRecordOptional implements Serializable

Class com.innovatrics.mrz.records.SlovakId2x34 extends MrzRecordOptional implements Serializable

Package com.innovatrics.mrz.types

Class com.innovatrics.mrz.types.MrzDate extends Object implements Serializable

Serialized Fields

year

month

day

mrz

dateValid