MrzRecord (MRZ Java Parser 0.6 API)

java.lang.Object
- com.innovatrics.mrz.MrzRecord

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MRP, MrzRecordOptional
```
public abstract class MrzRecord
extends Object
implements Serializable
```
An abstract MRZ record, contains basic information present in all MRZ record types.

Author:

Martin Vysny

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier Constructor and Description

protected MrzRecord(MrzFormat format, String recordName)

Constructors
Modifier	Constructor and Description
`protected`	`MrzRecord(MrzFormat format, String recordName)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`buildToString(StringBuilder sb)`
`void`	`fromMrz(String mrz)` Parses the MRZ record.
`MrzDocumentCode`	`getCode()`
`char`	`getCode1()`
`char`	`getCode2()`
`MrzDate`	`getDateOfBirth()`
`String`	`getDocumentNumber()`
`MrzDate`	`getExpirationDate()`
`MrzFormat`	`getFormat()`
`String`	`getGivenNames()`
`String`	`getIssuingCountry()`
`String`	`getNationality()`
`String`	`getRecordName()`
`MrzSex`	`getSex()`
`String`	`getSurname()`
`boolean`	`isValidComposite()`
`boolean`	`isValidDateOfBirth()`
`boolean`	`isValidDocumentNumber()`
`boolean`	`isValidExpirationDate()`
`void`	`setCode(MrzDocumentCode code)`
`void`	`setCode1(char code1)`
`void`	`setCode2(char code2)`
`void`	`setDateOfBirth(MrzDate dateOfBirth)`
`void`	`setDocumentNumber(String documentNumber)`
`void`	`setExpirationDate(MrzDate expirationDate)`
`void`	`setGivenNames(String givenNames)`
`void`	`setIssuingCountry(String issuingCountry)`
`protected void`	`setName(String[] name)` Helper method to set the full name.
`void`	`setNationality(String nationality)`
`void`	`setSex(MrzSex sex)`
`void`	`setSurname(String surname)`
`protected void`	`setValidComposite(boolean validComposite)`
`protected void`	`setValidDateOfBirth(boolean validDateOfBirth)`
`protected void`	`setValidDocumentNumber(boolean validDocumentNumber)`
`protected void`	`setValidExpirationDate(boolean validExpirationDate)`
`abstract String`	`toMrz()` Serializes this record to a valid MRZ record.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MrzRecord
```
protected MrzRecord(MrzFormat format,
                    String recordName)
```
    Parameters:
    
    format - the record format
    
    recordName - the record name
- Method Detail
  - getFormat
```
public final MrzFormat getFormat()
```
    Returns:
    
    the format
  - getRecordName
```
public final String getRecordName()
```
    Returns:
    
    the record name
  - fromMrz
```
public void fromMrz(String mrz)
             throws MrzParseException
```
    Parses the MRZ record.
    
    Parameters:
    
    mrz - the mrz record, not null, separated by \n
    
    Throws:
    
    MrzParseException - could not parse MRZ
  - setName
```
protected final void setName(String[] name)
```
    Helper method to set the full name. Changes both surname and givenNames.
    
    Parameters:
    
    name - expected array of length 2, in the form of [surname, first_name]. Must not be null.
  - toMrz
```
public abstract String toMrz()
```
    Serializes this record to a valid MRZ record.
    
    Returns:
    
    a valid MRZ record, not null, separated by \n
  - getCode
```
public MrzDocumentCode getCode()
```
    Returns:
    
    the document code
  - setCode
```
public void setCode(MrzDocumentCode code)
```
    Parameters:
    
    code - the document code
  - getCode1
```
public char getCode1()
```
    Returns:
    
    the document code1
  - setCode1
```
public void setCode1(char code1)
```
    Parameters:
    
    code1 - the document code1
  - getCode2
```
public char getCode2()
```
    Returns:
    
    the document code2
  - setCode2
```
public void setCode2(char code2)
```
    Parameters:
    
    code2 - the document code2
  - getIssuingCountry
```
public String getIssuingCountry()
```
    Returns:
    
    the issuing country
  - setIssuingCountry
```
public void setIssuingCountry(String issuingCountry)
```
    Parameters:
    
    issuingCountry - the issuing country
  - getDocumentNumber
```
public String getDocumentNumber()
```
    Returns:
    
    the document number
  - setDocumentNumber
```
public void setDocumentNumber(String documentNumber)
```
    Parameters:
    
    documentNumber - the document number
  - getSurname
```
public String getSurname()
```
    Returns:
    
    the surname
  - setSurname
```
public void setSurname(String surname)
```
    Parameters:
    
    surname - the surname
  - getGivenNames
```
public String getGivenNames()
```
    Returns:
    
    the given names
  - setGivenNames
```
public void setGivenNames(String givenNames)
```
    Parameters:
    
    givenNames - the given names
  - getDateOfBirth
```
public MrzDate getDateOfBirth()
```
    Returns:
    
    the date of birth
  - setDateOfBirth
```
public void setDateOfBirth(MrzDate dateOfBirth)
```
    Parameters:
    
    dateOfBirth - the date of birth
  - getSex
```
public MrzSex getSex()
```
    Returns:
    
    the sex
  - setSex
```
public void setSex(MrzSex sex)
```
    Parameters:
    
    sex - the sex
  - getExpirationDate
```
public MrzDate getExpirationDate()
```
    Returns:
    
    the expiration date
  - setExpirationDate
```
public void setExpirationDate(MrzDate expirationDate)
```
    Parameters:
    
    expirationDate - the expiration date
  - getNationality
```
public String getNationality()
```
    Returns:
    
    the nationality
  - setNationality
```
public void setNationality(String nationality)
```
    Parameters:
    
    nationality - the nationality
  - isValidDocumentNumber
```
public boolean isValidDocumentNumber()
```
    Returns:
    
    true if valid document number
  - setValidDocumentNumber
```
protected void setValidDocumentNumber(boolean validDocumentNumber)
```
    Parameters:
    
    validDocumentNumber - true if valid document number
  - isValidDateOfBirth
```
public boolean isValidDateOfBirth()
```
    Returns:
    
    true if valid date of birth
  - setValidDateOfBirth
```
protected void setValidDateOfBirth(boolean validDateOfBirth)
```
    Parameters:
    
    validDateOfBirth - true if valid date of birth
  - isValidExpirationDate
```
public boolean isValidExpirationDate()
```
    Returns:
    
    true if valid expiration date
  - setValidExpirationDate
```
protected void setValidExpirationDate(boolean validExpirationDate)
```
    Parameters:
    
    validExpirationDate - true if valid expiration date to set
  - isValidComposite
```
public boolean isValidComposite()
```
    Returns:
    
    true if valid composite
  - setValidComposite
```
protected void setValidComposite(boolean validComposite)
```
    Parameters:
    
    validComposite - true if valid composite
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - buildToString
```
protected void buildToString(StringBuilder sb)
```
    Parameters:
    
    sb - the string builder to hold the record details

Class MrzRecord

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MrzRecord

Method Detail

getFormat

getRecordName

fromMrz

setName

toMrz

getCode

setCode

getCode1

setCode1

getCode2

setCode2

getIssuingCountry

setIssuingCountry

getDocumentNumber

setDocumentNumber

getSurname

setSurname

getGivenNames

setGivenNames

getDateOfBirth

setDateOfBirth

getSex

setSex

getExpirationDate

setExpirationDate

getNationality

setNationality

isValidDocumentNumber

setValidDocumentNumber

isValidDateOfBirth

setValidDateOfBirth

isValidExpirationDate

setValidExpirationDate

isValidComposite

setValidComposite

toString

buildToString