Class IdBarcodeRecognizer.Result
- java.lang.Object
-
- com.microblink.entities.Entity.Result
-
- com.microblink.entities.recognizers.Recognizer.Result
-
- com.microblink.entities.recognizers.blinkid.idbarcode.IdBarcodeRecognizer.Result
-
- All Implemented Interfaces:
android.os.Parcelable
- Enclosing class:
- IdBarcodeRecognizer
public static final class IdBarcodeRecognizer.Result extends Recognizer.Result
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microblink.entities.recognizers.Recognizer.Result
Recognizer.Result.State
-
-
Field Summary
Fields Modifier and Type Field Description static android.os.Parcelable.Creator<IdBarcodeRecognizer.Result>
CREATOR
-
Fields inherited from class com.microblink.entities.Entity.Result
mOwner
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
Result(long nativeResult)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IdBarcodeRecognizer.Result
clone()
Create a copy of the result.protected void
deserializeFromByteArray(byte[] arr)
java.lang.String
getAdditionalNameInformation()
The additional name information of the document owner.java.lang.String
getAddress()
The address of the document owner.int
getAge()
The current age of the document owner in years.AgeLimitStatus
getAgeLimitStatus(int ageLimit)
Calculates whether the document owner is older than the givenageLimit
in years or not.BarcodeType
getBarcodeType()
The format of the scanned barcode.java.lang.String
getCity()
The city address portion of the document owner.DateResult
getDateOfBirth()
The date of birth of the document owner.DateResult
getDateOfExpiry()
The date of expiry of the document.DateResult
getDateOfIssue()
The date of issue of the document.java.lang.String
getDocumentAdditionalNumber()
The additional number of the document.java.lang.String
getDocumentNumber()
The document number.IdBarcodeDocumentType
getDocumentType()
The document type deduced from the recognized barcodejava.lang.String
getEmployer()
The employer of the document owner.java.lang.String
getEndorsements()
The additional privileges granted to the driver license owner.BarcodeElements
getExtendedElements()
Document specific extended elements that contain all barcode fields in their original form.java.lang.String
getFirstName()
The first name of the document owner.java.lang.String
getFullName()
The full name of the document owner.java.lang.String
getIssuingAuthority()
The issuing authority of the document.java.lang.String
getJurisdiction()
The jurisdiction code address portion of the document owner.java.lang.String
getLastName()
The last name of the document owner.java.lang.String
getMaritalStatus()
The marital status of the document owner.java.lang.String
getMiddleName()
The middle name of the document owner.java.lang.String
getNationality()
The nationality of the documet owner.java.lang.String
getPersonalIdNumber()
The personal identification number.java.lang.String
getPlaceOfBirth()
The place of birth of the document owner.java.lang.String
getPostalCode()
The postal code address portion of the document owner.java.lang.String
getProfession()
The profession of the document owner.java.lang.String
getRace()
The race of the document owner.byte[]
getRawData()
The raw bytes contained inside barcode.java.lang.String
getReligion()
The religion of the document owner.java.lang.String
getResidentialStatus()
The residential status of the document owner.java.lang.String
getRestrictions()
The restrictions to driving privileges for the driver license owner.java.lang.String
getSex()
The sex of the document owner.java.lang.String
getStreet()
The street address portion of the document owner.java.lang.String
getStringData()
String representation of data inside barcode.java.lang.String
getVehicleClass()
The type of vehicle the driver license owner has privilege to drive.boolean
isExpired()
Checks whether the document has expired or not by comparing the current time on the device with the date of expiry.boolean
isUncertain()
True if returned result is uncertain, i.e.protected byte[]
serializeToByteArray()
protected void
terminateNative(long nativeContext)
java.lang.String
toString()
-
Methods inherited from class com.microblink.entities.recognizers.Recognizer.Result
getResultState, isEmpty
-
Methods inherited from class com.microblink.entities.Entity.Result
describeContents, finalize, getNativeContext, readFromParcel, writeToParcel
-
-
-
-
Field Detail
-
CREATOR
public static final android.os.Parcelable.Creator<IdBarcodeRecognizer.Result> CREATOR
-
-
Method Detail
-
getLastName
@NonNull public java.lang.String getLastName()
The last name of the document owner.
-
getExtendedElements
@NonNull public BarcodeElements getExtendedElements()
Document specific extended elements that contain all barcode fields in their original form. Currently this is only filled for AAMVACompliant documents.
-
getDocumentType
@NonNull public IdBarcodeDocumentType getDocumentType()
The document type deduced from the recognized barcode
-
getCity
@NonNull public java.lang.String getCity()
The city address portion of the document owner.
-
getDocumentNumber
@NonNull public java.lang.String getDocumentNumber()
The document number.
-
getPersonalIdNumber
@NonNull public java.lang.String getPersonalIdNumber()
The personal identification number.
-
getBarcodeType
@NonNull public BarcodeType getBarcodeType()
The format of the scanned barcode.
-
getJurisdiction
@NonNull public java.lang.String getJurisdiction()
The jurisdiction code address portion of the document owner.
-
getPostalCode
@NonNull public java.lang.String getPostalCode()
The postal code address portion of the document owner.
-
getRawData
@NonNull public byte[] getRawData()
The raw bytes contained inside barcode.
-
isUncertain
public boolean isUncertain()
True if returned result is uncertain, i.e. if scanned barcode was incomplete (i.e. (has parts of it missing).
-
getStreet
@NonNull public java.lang.String getStreet()
The street address portion of the document owner.
-
getResidentialStatus
@NonNull public java.lang.String getResidentialStatus()
The residential status of the document owner.
-
getEmployer
@NonNull public java.lang.String getEmployer()
The employer of the document owner.
-
getVehicleClass
@NonNull public java.lang.String getVehicleClass()
The type of vehicle the driver license owner has privilege to drive.
-
getProfession
@NonNull public java.lang.String getProfession()
The profession of the document owner.
-
getDateOfExpiry
@NonNull public DateResult getDateOfExpiry()
The date of expiry of the document.
-
getPlaceOfBirth
@NonNull public java.lang.String getPlaceOfBirth()
The place of birth of the document owner.
-
getAddress
@NonNull public java.lang.String getAddress()
The address of the document owner.
-
getRace
@NonNull public java.lang.String getRace()
The race of the document owner.
-
getSex
@NonNull public java.lang.String getSex()
The sex of the document owner.
-
getFullName
@NonNull public java.lang.String getFullName()
The full name of the document owner.
-
getRestrictions
@NonNull public java.lang.String getRestrictions()
The restrictions to driving privileges for the driver license owner.
-
getDateOfBirth
@NonNull public DateResult getDateOfBirth()
The date of birth of the document owner.
-
getDocumentAdditionalNumber
@NonNull public java.lang.String getDocumentAdditionalNumber()
The additional number of the document.
-
getDateOfIssue
@NonNull public DateResult getDateOfIssue()
The date of issue of the document.
-
getStringData
@NonNull public java.lang.String getStringData()
String representation of data inside barcode.
-
getReligion
@NonNull public java.lang.String getReligion()
The religion of the document owner.
-
getFirstName
@NonNull public java.lang.String getFirstName()
The first name of the document owner.
-
getIssuingAuthority
@NonNull public java.lang.String getIssuingAuthority()
The issuing authority of the document.
-
getNationality
@NonNull public java.lang.String getNationality()
The nationality of the documet owner.
-
getAdditionalNameInformation
@NonNull public java.lang.String getAdditionalNameInformation()
The additional name information of the document owner.
-
getEndorsements
@NonNull public java.lang.String getEndorsements()
The additional privileges granted to the driver license owner.
-
getMiddleName
@NonNull public java.lang.String getMiddleName()
The middle name of the document owner.
-
getMaritalStatus
@NonNull public java.lang.String getMaritalStatus()
The marital status of the document owner.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
- Returns:
- string version of this result
-
getAge
public int getAge()
The current age of the document owner in years. It is calculated difference between now and date of birth. Now is current time on the device.- Returns:
- current age of the document owner in years or
-1
if date of birth is unknown.
-
getAgeLimitStatus
public AgeLimitStatus getAgeLimitStatus(int ageLimit)
Calculates whether the document owner is older than the givenageLimit
in years or not. Status is calculated by using the date of birth and the current time on the device.- Parameters:
ageLimit
- age limit in years- Returns:
- age limit status for the document owner:
-
AgeLimitStatus.OverAgeLimit
: age is greater than or equal to the given age limit -
AgeLimitStatus.BelowAgeLimit
: age is less than the given age limit -
AgeLimitStatus.NotAvailable
: date of birth is unknown
-
-
isExpired
public boolean isExpired()
Checks whether the document has expired or not by comparing the current time on the device with the date of expiry.- Returns:
true
if the document has expired,false
if the document has not expired or date of expiry is unknown.
-
serializeToByteArray
@Nullable protected byte[] serializeToByteArray()
- Specified by:
serializeToByteArray
in classEntity.Result
-
deserializeFromByteArray
protected void deserializeFromByteArray(@NonNull byte[] arr)
- Specified by:
deserializeFromByteArray
in classEntity.Result
-
clone
public IdBarcodeRecognizer.Result clone()
Description copied from class:Entity.Result
Create a copy of the result. This is required in order to retain the result even after owning entity has mutated it.- Specified by:
clone
in classRecognizer.Result
- Returns:
- a copy of the result
-
terminateNative
protected void terminateNative(long nativeContext)
- Specified by:
terminateNative
in classEntity.Result
-
-