java.lang.Object
- com.mindee.parsing.common.Prediction
- - com.mindee.product.fr.idcard.IdCardV2Document

Direct Known Subclasses:

IdCardV2Page
```
public class IdCardV2Document
extends Prediction
```
Carte Nationale d'Identité API version 2.0 document data.

Field Summary

Fields
Modifier and Type	Field	Description
`protected StringField`	`alternateName`	The alternate name of the card holder.
`protected StringField`	`authority`	The name of the issuing authority.
`protected DateField`	`birthDate`	The date of birth of the card holder.
`protected StringField`	`birthPlace`	The place of birth of the card holder.
`protected StringField`	`cardAccessNumber`	The card access number (CAN).
`protected StringField`	`documentNumber`	The document number.
`protected DateField`	`expiryDate`	The expiry date of the identification card.
`protected StringField`	`gender`	The gender of the card holder.
`protected List<StringField>`	`givenNames`	The given name(s) of the card holder.
`protected DateField`	`issueDate`	The date of issue of the identification card.
`protected StringField`	`mrz1`	The Machine Readable Zone, first line.
`protected StringField`	`mrz2`	The Machine Readable Zone, second line.
`protected StringField`	`mrz3`	The Machine Readable Zone, third line.
`protected StringField`	`nationality`	The nationality of the card holder.
`protected StringField`	`surname`	The surname of the card holder.

Constructor Summary

Constructors
Constructor Description

IdCardV2Document()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`StringField`	`getAlternateName()`	The alternate name of the card holder.
`StringField`	`getAuthority()`	The name of the issuing authority.
`DateField`	`getBirthDate()`	The date of birth of the card holder.
`StringField`	`getBirthPlace()`	The place of birth of the card holder.
`StringField`	`getCardAccessNumber()`	The card access number (CAN).
`StringField`	`getDocumentNumber()`	The document number.
`DateField`	`getExpiryDate()`	The expiry date of the identification card.
`StringField`	`getGender()`	The gender of the card holder.
`List<StringField>`	`getGivenNames()`	The given name(s) of the card holder.
`DateField`	`getIssueDate()`	The date of issue of the identification card.
`StringField`	`getMrz1()`	The Machine Readable Zone, first line.
`StringField`	`getMrz2()`	The Machine Readable Zone, second line.
`StringField`	`getMrz3()`	The Machine Readable Zone, third line.
`StringField`	`getNationality()`	The nationality of the card holder.
`StringField`	`getSurname()`	The surname of the card 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
  - alternateName
```
protected StringField alternateName
```
    The alternate name of the card holder.
  - authority
```
protected StringField authority
```
    The name of the issuing authority.
  - birthDate
```
protected DateField birthDate
```
    The date of birth of the card holder.
  - birthPlace
```
protected StringField birthPlace
```
    The place of birth of the card holder.
  - cardAccessNumber
```
protected StringField cardAccessNumber
```
    The card access number (CAN).
  - documentNumber
```
protected StringField documentNumber
```
    The document number.
  - expiryDate
```
protected DateField expiryDate
```
    The expiry date of the identification card.
  - gender
```
protected StringField gender
```
    The gender of the card holder.
  - givenNames
```
protected List<StringField> givenNames
```
    The given name(s) of the card holder.
  - issueDate
```
protected DateField issueDate
```
    The date of issue of the identification card.
  - mrz1
```
protected StringField mrz1
```
    The Machine Readable Zone, first line.
  - mrz2
```
protected StringField mrz2
```
    The Machine Readable Zone, second line.
  - mrz3
```
protected StringField mrz3
```
    The Machine Readable Zone, third line.
  - nationality
```
protected StringField nationality
```
    The nationality of the card holder.
  - surname
```
protected StringField surname
```
    The surname of the card holder.
- Constructor Detail
  - IdCardV2Document
```
public IdCardV2Document()
```
- 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
  - getAlternateName
```
public StringField getAlternateName()
```
    The alternate name of the card holder.
  - getAuthority
```
public StringField getAuthority()
```
    The name of the issuing authority.
  - getBirthDate
```
public DateField getBirthDate()
```
    The date of birth of the card holder.
  - getBirthPlace
```
public StringField getBirthPlace()
```
    The place of birth of the card holder.
  - getCardAccessNumber
```
public StringField getCardAccessNumber()
```
    The card access number (CAN).
  - getDocumentNumber
```
public StringField getDocumentNumber()
```
    The document number.
  - getExpiryDate
```
public DateField getExpiryDate()
```
    The expiry date of the identification card.
  - getGender
```
public StringField getGender()
```
    The gender of the card holder.
  - getGivenNames
```
public List<StringField> getGivenNames()
```
    The given name(s) of the card holder.
  - getIssueDate
```
public DateField getIssueDate()
```
    The date of issue of the identification card.
  - getMrz1
```
public StringField getMrz1()
```
    The Machine Readable Zone, first line.
  - getMrz2
```
public StringField getMrz2()
```
    The Machine Readable Zone, second line.
  - getMrz3
```
public StringField getMrz3()
```
    The Machine Readable Zone, third line.
  - getNationality
```
public StringField getNationality()
```
    The nationality of the card holder.
  - getSurname
```
public StringField getSurname()
```
    The surname of the card 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 IdCardV2Document

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

alternateName

authority

birthDate

birthPlace

cardAccessNumber

documentNumber

expiryDate

gender

givenNames

issueDate

mrz1

mrz2

mrz3

nationality

surname

Constructor Detail

IdCardV2Document

Method Detail

isEmpty

toString

getAlternateName

getAuthority

getBirthDate

getBirthPlace

getCardAccessNumber

getDocumentNumber

getExpiryDate

getGender

getGivenNames

getIssueDate

getMrz1

getMrz2

getMrz3

getNationality

getSurname

equals

canEqual

hashCode