java.lang.Object
- com.mindee.parsing.common.Prediction
- - com.mindee.product.ind.indianpassport.IndianPassportV1Document

public class IndianPassportV1Document
extends Prediction

Passport - India API version 1.2 document data.

Field Summary

Fields
Modifier and Type	Field	Description
`protected StringField`	`address1`	The first line of the address of the passport holder.
`protected StringField`	`address2`	The second line of the address of the passport holder.
`protected StringField`	`address3`	The third line of the address of the passport holder.
`protected DateField`	`birthDate`	The birth date of the passport holder, ISO format: YYYY-MM-DD.
`protected StringField`	`birthPlace`	The birth place of the passport holder.
`protected StringField`	`country`	ISO 3166-1 alpha-3 country code (3 letters format).
`protected DateField`	`expiryDate`	The date when the passport will expire, ISO format: YYYY-MM-DD.
`protected StringField`	`fileNumber`	The file number of the passport document.
`protected ClassificationField`	`gender`	The gender of the passport holder.
`protected StringField`	`givenNames`	The given names of the passport holder.
`protected StringField`	`idNumber`	The identification number of the passport document.
`protected DateField`	`issuanceDate`	The date when the passport was issued, ISO format: YYYY-MM-DD.
`protected StringField`	`issuancePlace`	The place where the passport was issued.
`protected StringField`	`legalGuardian`	The name of the legal guardian of the passport holder (if applicable).
`protected StringField`	`mrz1`	The first line of the machine-readable zone (MRZ) of the passport document.
`protected StringField`	`mrz2`	The second line of the machine-readable zone (MRZ) of the passport document.
`protected StringField`	`nameOfMother`	The name of the mother of the passport holder.
`protected StringField`	`nameOfSpouse`	The name of the spouse of the passport holder (if applicable).
`protected DateField`	`oldPassportDateOfIssue`	The date of issue of the old passport (if applicable), ISO format: YYYY-MM-DD.
`protected StringField`	`oldPassportNumber`	The number of the old passport (if applicable).
`protected StringField`	`oldPassportPlaceOfIssue`	The place of issue of the old passport (if applicable).
`protected ClassificationField`	`pageNumber`	The page number of the passport document.
`protected StringField`	`surname`	The surname of the passport holder.

Constructor Summary

Constructors
Constructor Description

IndianPassportV1Document()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`StringField`	`getAddress1()`	The first line of the address of the passport holder.
`StringField`	`getAddress2()`	The second line of the address of the passport holder.
`StringField`	`getAddress3()`	The third line of the address of the passport holder.
`DateField`	`getBirthDate()`	The birth date of the passport holder, ISO format: YYYY-MM-DD.
`StringField`	`getBirthPlace()`	The birth place of the passport holder.
`StringField`	`getCountry()`	ISO 3166-1 alpha-3 country code (3 letters format).
`DateField`	`getExpiryDate()`	The date when the passport will expire, ISO format: YYYY-MM-DD.
`StringField`	`getFileNumber()`	The file number of the passport document.
`ClassificationField`	`getGender()`	The gender of the passport holder.
`StringField`	`getGivenNames()`	The given names of the passport holder.
`StringField`	`getIdNumber()`	The identification number of the passport document.
`DateField`	`getIssuanceDate()`	The date when the passport was issued, ISO format: YYYY-MM-DD.
`StringField`	`getIssuancePlace()`	The place where the passport was issued.
`StringField`	`getLegalGuardian()`	The name of the legal guardian of the passport holder (if applicable).
`StringField`	`getMrz1()`	The first line of the machine-readable zone (MRZ) of the passport document.
`StringField`	`getMrz2()`	The second line of the machine-readable zone (MRZ) of the passport document.
`StringField`	`getNameOfMother()`	The name of the mother of the passport holder.
`StringField`	`getNameOfSpouse()`	The name of the spouse of the passport holder (if applicable).
`DateField`	`getOldPassportDateOfIssue()`	The date of issue of the old passport (if applicable), ISO format: YYYY-MM-DD.
`StringField`	`getOldPassportNumber()`	The number of the old passport (if applicable).
`StringField`	`getOldPassportPlaceOfIssue()`	The place of issue of the old passport (if applicable).
`ClassificationField`	`getPageNumber()`	The page number of the passport document.
`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
  - address1
```
protected StringField address1
```
    The first line of the address of the passport holder.
  - address2
```
protected StringField address2
```
    The second line of the address of the passport holder.
  - address3
```
protected StringField address3
```
    The third line of the address of the passport holder.
  - birthDate
```
protected DateField birthDate
```
    The birth date of the passport holder, ISO format: YYYY-MM-DD.
  - birthPlace
```
protected StringField birthPlace
```
    The birth place of the passport holder.
  - country
```
protected StringField country
```
    ISO 3166-1 alpha-3 country code (3 letters format).
  - expiryDate
```
protected DateField expiryDate
```
    The date when the passport will expire, ISO format: YYYY-MM-DD.
  - fileNumber
```
protected StringField fileNumber
```
    The file number of the passport document.
  - gender
```
protected ClassificationField gender
```
    The gender of the passport holder.
  - givenNames
```
protected StringField givenNames
```
    The given names of the passport holder.
  - idNumber
```
protected StringField idNumber
```
    The identification number of the passport document.
  - issuanceDate
```
protected DateField issuanceDate
```
    The date when the passport was issued, ISO format: YYYY-MM-DD.
  - issuancePlace
```
protected StringField issuancePlace
```
    The place where the passport was issued.
  - legalGuardian
```
protected StringField legalGuardian
```
    The name of the legal guardian of the passport holder (if applicable).
  - mrz1
```
protected StringField mrz1
```
    The first line of the machine-readable zone (MRZ) of the passport document.
  - mrz2
```
protected StringField mrz2
```
    The second line of the machine-readable zone (MRZ) of the passport document.
  - nameOfMother
```
protected StringField nameOfMother
```
    The name of the mother of the passport holder.
  - nameOfSpouse
```
protected StringField nameOfSpouse
```
    The name of the spouse of the passport holder (if applicable).
  - oldPassportDateOfIssue
```
protected DateField oldPassportDateOfIssue
```
    The date of issue of the old passport (if applicable), ISO format: YYYY-MM-DD.
  - oldPassportNumber
```
protected StringField oldPassportNumber
```
    The number of the old passport (if applicable).
  - oldPassportPlaceOfIssue
```
protected StringField oldPassportPlaceOfIssue
```
    The place of issue of the old passport (if applicable).
  - pageNumber
```
protected ClassificationField pageNumber
```
    The page number of the passport document.
  - surname
```
protected StringField surname
```
    The surname of the passport holder.
- Constructor Detail
  - IndianPassportV1Document
```
public IndianPassportV1Document()
```
- 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
  - getAddress1
```
public StringField getAddress1()
```
    The first line of the address of the passport holder.
  - getAddress2
```
public StringField getAddress2()
```
    The second line of the address of the passport holder.
  - getAddress3
```
public StringField getAddress3()
```
    The third line of the address of the passport holder.
  - getBirthDate
```
public DateField getBirthDate()
```
    The birth date of the passport holder, ISO format: YYYY-MM-DD.
  - getBirthPlace
```
public StringField getBirthPlace()
```
    The birth place of the passport holder.
  - getCountry
```
public StringField getCountry()
```
    ISO 3166-1 alpha-3 country code (3 letters format).
  - getExpiryDate
```
public DateField getExpiryDate()
```
    The date when the passport will expire, ISO format: YYYY-MM-DD.
  - getFileNumber
```
public StringField getFileNumber()
```
    The file number of the passport document.
  - getGender
```
public ClassificationField getGender()
```
    The gender of the passport holder.
  - getGivenNames
```
public StringField getGivenNames()
```
    The given names of the passport holder.
  - getIdNumber
```
public StringField getIdNumber()
```
    The identification number of the passport document.
  - getIssuanceDate
```
public DateField getIssuanceDate()
```
    The date when the passport was issued, ISO format: YYYY-MM-DD.
  - getIssuancePlace
```
public StringField getIssuancePlace()
```
    The place where the passport was issued.
  - getLegalGuardian
```
public StringField getLegalGuardian()
```
    The name of the legal guardian of the passport holder (if applicable).
  - getMrz1
```
public StringField getMrz1()
```
    The first line of the machine-readable zone (MRZ) of the passport document.
  - getMrz2
```
public StringField getMrz2()
```
    The second line of the machine-readable zone (MRZ) of the passport document.
  - getNameOfMother
```
public StringField getNameOfMother()
```
    The name of the mother of the passport holder.
  - getNameOfSpouse
```
public StringField getNameOfSpouse()
```
    The name of the spouse of the passport holder (if applicable).
  - getOldPassportDateOfIssue
```
public DateField getOldPassportDateOfIssue()
```
    The date of issue of the old passport (if applicable), ISO format: YYYY-MM-DD.
  - getOldPassportNumber
```
public StringField getOldPassportNumber()
```
    The number of the old passport (if applicable).
  - getOldPassportPlaceOfIssue
```
public StringField getOldPassportPlaceOfIssue()
```
    The place of issue of the old passport (if applicable).
  - getPageNumber
```
public ClassificationField getPageNumber()
```
    The page number of the passport document.
  - 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 IndianPassportV1Document

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

address1

address2

address3

birthDate

birthPlace

country

expiryDate

fileNumber

gender

givenNames

idNumber

issuanceDate

issuancePlace

legalGuardian

mrz1

mrz2

nameOfMother

nameOfSpouse

oldPassportDateOfIssue

oldPassportNumber

oldPassportPlaceOfIssue

pageNumber

surname

Constructor Detail

IndianPassportV1Document

Method Detail

isEmpty

toString

getAddress1

getAddress2

getAddress3

getBirthDate

getBirthPlace

getCountry

getExpiryDate

getFileNumber

getGender

getGivenNames

getIdNumber

getIssuanceDate

getIssuancePlace

getLegalGuardian

getMrz1

getMrz2

getNameOfMother

getNameOfSpouse

getOldPassportDateOfIssue

getOldPassportNumber

getOldPassportPlaceOfIssue

getPageNumber

getSurname

equals

canEqual

hashCode