java.lang.Object
- com.mindee.parsing.common.Prediction
- - com.mindee.product.passport.PassportV1Document

public class PassportV1Document
extends Prediction

Passport API version 1.1 document data.

Field Summary

Fields
Modifier and Type	Field	Description
`protected DateField`	`birthDate`	The date of birth of the passport holder.
`protected StringField`	`birthPlace`	The place of birth of the passport holder.
`protected StringField`	`country`	The country's 3 letter code (ISO 3166-1 alpha-3).
`protected DateField`	`expiryDate`	The expiry date of the passport.
`protected StringField`	`gender`	The gender of the passport holder.
`protected List<StringField>`	`givenNames`	The given name(s) of the passport holder.
`protected StringField`	`idNumber`	The passport's identification number.
`protected DateField`	`issuanceDate`	The date the passport was issued.
`protected StringField`	`mrz1`	Machine Readable Zone, first line
`protected StringField`	`mrz2`	Machine Readable Zone, second line
`protected StringField`	`surname`	The surname of the passport holder.

Constructor Summary

Constructors
Constructor Description

PassportV1Document()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`DateField`	`getBirthDate()`	The date of birth of the passport holder.
`StringField`	`getBirthPlace()`	The place of birth of the passport holder.
`StringField`	`getCountry()`	The country's 3 letter code (ISO 3166-1 alpha-3).
`DateField`	`getExpiryDate()`	The expiry date of the passport.
`StringField`	`getGender()`	The gender of the passport holder.
`List<StringField>`	`getGivenNames()`	The given name(s) of the passport holder.
`StringField`	`getIdNumber()`	The passport's identification number.
`DateField`	`getIssuanceDate()`	The date the passport was issued.
`StringField`	`getMrz1()`	Machine Readable Zone, first line
`StringField`	`getMrz2()`	Machine Readable Zone, second line
`StringField`	`getSurname()`	The surname of the passport holder.
`int`	`hashCode()`
`boolean`	`isEmpty()`	Returns `true` if there are no predictions values.
`String`	`toString()`

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

- Field Detail
  - birthDate
```
protected DateField birthDate
```
    The date of birth of the passport holder.
  - birthPlace
```
protected StringField birthPlace
```
    The place of birth of the passport holder.
  - country
```
protected StringField country
```
    The country's 3 letter code (ISO 3166-1 alpha-3).
  - expiryDate
```
protected DateField expiryDate
```
    The expiry date of the passport.
  - gender
```
protected StringField gender
```
    The gender of the passport holder.
  - givenNames
```
protected List<StringField> givenNames
```
    The given name(s) of the passport holder.
  - idNumber
```
protected StringField idNumber
```
    The passport's identification number.
  - issuanceDate
```
protected DateField issuanceDate
```
    The date the passport was issued.
  - mrz1
```
protected StringField mrz1
```
    Machine Readable Zone, first line
  - mrz2
```
protected StringField mrz2
```
    Machine Readable Zone, second line
  - surname
```
protected StringField surname
```
    The surname of the passport holder.
- Constructor Detail
  - PassportV1Document
```
public PassportV1Document()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from class: Prediction
    
    Returns true if there are no predictions values. Accessing prediction values when this is true may result in a NullPointerException
    
    Specified by:
    
    isEmpty in class Prediction
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getBirthDate
```
public DateField getBirthDate()
```
    The date of birth of the passport holder.
  - getBirthPlace
```
public StringField getBirthPlace()
```
    The place of birth of the passport holder.
  - getCountry
```
public StringField getCountry()
```
    The country's 3 letter code (ISO 3166-1 alpha-3).
  - getExpiryDate
```
public DateField getExpiryDate()
```
    The expiry date of the passport.
  - getGender
```
public StringField getGender()
```
    The gender of the passport holder.
  - getGivenNames
```
public List<StringField> getGivenNames()
```
    The given name(s) of the passport holder.
  - getIdNumber
```
public StringField getIdNumber()
```
    The passport's identification number.
  - getIssuanceDate
```
public DateField getIssuanceDate()
```
    The date the passport was issued.
  - getMrz1
```
public StringField getMrz1()
```
    Machine Readable Zone, first line
  - getMrz2
```
public StringField getMrz2()
```
    Machine Readable Zone, second line
  - getSurname
```
public StringField getSurname()
```
    The surname of the passport holder.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class PassportV1Document

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

birthDate

birthPlace

country

expiryDate

gender

givenNames

idNumber

issuanceDate

mrz1

mrz2

surname

Constructor Detail

PassportV1Document

Method Detail

isEmpty

toString

getBirthDate

getBirthPlace

getCountry

getExpiryDate

getGender

getGivenNames

getIdNumber

getIssuanceDate

getMrz1

getMrz2

getSurname

equals

canEqual

hashCode