Class UsdlCombinedRecognizer.Result
java.lang.Object
com.microblink.blinkid.entities.Entity.Result
com.microblink.blinkid.entities.recognizers.Recognizer.Result
com.microblink.blinkid.entities.recognizers.blinkid.usdl.UsdlCombinedRecognizer.Result
- All Implemented Interfaces:
android.os.Parcelable
,CombinedDataMatchResult
,CombinedResult
,EncodedFaceImageResult
,EncodedFullDocumentImageResult
,FaceImageResult
,FullDocumentImageResult
- Enclosing class:
- UsdlCombinedRecognizer
public static final class UsdlCombinedRecognizer.Result
extends Recognizer.Result
implements FullDocumentImageResult, EncodedFullDocumentImageResult, FaceImageResult, EncodedFaceImageResult, CombinedResult, CombinedDataMatchResult
-
Nested Class Summary
Nested classes/interfaces inherited from class com.microblink.blinkid.entities.recognizers.Recognizer.Result
Recognizer.Result.State
-
Field Summary
Modifier and TypeFieldDescriptionstatic final android.os.Parcelable.Creator<UsdlCombinedRecognizer.Result>
Fields inherited from class com.microblink.blinkid.entities.Entity.Result
mOwner
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.CombinedDataMatchResult
CLASS_NAME
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.CombinedResult
CLASS_NAME
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.imageresult.EncodedFaceImageResult
CLASS_NAME
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.imageresult.EncodedFullDocumentImageResult
CLASS_NAME
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.imageresult.FaceImageResult
CLASS_NAME
Fields inherited from interface com.microblink.blinkid.entities.recognizers.blinkid.imageresult.FullDocumentImageResult
CLASS_NAME
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Create a copy of the result.protected void
deserializeFromByteArray
(byte[] arr) The full address of the United States driver license owner.int
getAge()
The current age of the document owner in years.getAgeLimitStatus
(int ageLimit) Calculates whether the document owner is older than the givenageLimit
in years or not.The date of birth of the United States driver license owner.The date of expiry of the United States driver license.The date of issue of the United States driver license.Returns result of the data matching algorithm for scanned parts/sides of the document.The document number of the United States driver license.byte[]
byte[]
The additional privileges granted to the United States driver license owner.Returns a field inside US Driver's licence.The first name of the United States driver license owner.The full name of the United States driver license owner.The last name of the United States driver license owner.The middle name of the United States driver license owner.The name suffix of the United States driver license owner.String[]
Deprecated.byte[]
The raw bytes contained inside 2D barcode.Raw string inside 2D barcode.The restrictions to driving privileges for the United States driver license owner.getSex()
The sex of the United States driver license owner.The type of vehicle the driver license owner has privilege to drive.boolean
boolean
True if returned result is uncertain, i.e.protected byte[]
protected void
terminateNative
(long nativeContext) toString()
Methods inherited from class com.microblink.blinkid.entities.recognizers.Recognizer.Result
getResultState, isEmpty
Methods inherited from class com.microblink.blinkid.entities.Entity.Result
describeContents, finalize, getNativeContext, readFromParcel, writeToParcel
-
Field Details
-
CREATOR
-
-
Constructor Details
-
Result
protected Result(long nativeResult)
-
-
Method Details
-
getDocumentDataMatch
Description copied from interface:CombinedDataMatchResult
Returns result of the data matching algorithm for scanned parts/sides of the document. For example if date of expiry is scanned from the front and back side of the document and values do not match, this method will returnDataMatchState.Failed
. Result will beDataMatchState.Success
only if scanned values for all fields that are compared are the same. If data matching has not been performed, result will beDataMatchState.NotPerformed
.- Specified by:
getDocumentDataMatch
in interfaceCombinedDataMatchResult
- Returns:
- result of the data matching algorithm for scanned parts/sides of the document.
-
getLastName
The last name of the United States driver license owner. -
getDateOfExpiry
The date of expiry of the United States driver license. -
getAddress
The full address of the United States driver license owner. -
getDocumentNumber
The document number of the United States driver license. -
getSex
The sex of the United States driver license owner. -
getEncodedFullDocumentImage
@NonNull public byte[] getEncodedFullDocumentImage()- Specified by:
getEncodedFullDocumentImage
in interfaceEncodedFullDocumentImageResult
- Returns:
- encoded full document image in JPEG format if enabled with
EncodeFullDocumentImagesOptions.setEncodeFullDocumentImage(boolean)
, elsenull
-
getFullName
The full name of the United States driver license owner. -
getNameSuffix
The name suffix of the United States driver license owner. -
getRestrictions
The restrictions to driving privileges for the United States driver license owner. -
getEncodedFaceImage
@NonNull public byte[] getEncodedFaceImage()- Specified by:
getEncodedFaceImage
in interfaceEncodedFaceImageResult
- Returns:
- encoded face image in JPEG from the document if enabled with
EncodeFaceImageOptions.setEncodeFaceImage(boolean)
, elsenull
-
getDateOfBirth
The date of birth of the United States driver license owner. -
getRawData
@NonNull public byte[] getRawData()The raw bytes contained inside 2D barcode. -
getDateOfIssue
The date of issue of the United States driver license. -
getFaceImage
- Specified by:
getFaceImage
in interfaceFaceImageResult
- Returns:
- face image from the document if enabled with
FaceImageOptions.setReturnFaceImage(boolean)
, elsenull
-
isUncertain
public boolean isUncertain()True if returned result is uncertain, i.e. if scanned barcode was incomplete (i.e. (has parts of it missing). -
getFirstName
The first name of the United States driver license owner. -
getFullDocumentImage
- Specified by:
getFullDocumentImage
in interfaceFullDocumentImageResult
- Returns:
- image of the full document if enabled with
FullDocumentImageOptions.setReturnFullDocumentImage(boolean)
, elsenull
-
isScanningFirstSideDone
public boolean isScanningFirstSideDone()- Specified by:
isScanningFirstSideDone
in interfaceCombinedResult
- Returns:
true
if recognizer has finished scanning first side and is now scanning back side,false
if it's still scanning first side.
-
getEndorsements
The additional privileges granted to the United States driver license owner. -
getVehicleClass
The type of vehicle the driver license owner has privilege to drive. -
getMiddleName
The middle name of the United States driver license owner. -
getRawStringData
Raw string inside 2D barcode. -
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
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
-
-
getOptionalElements
Deprecated.Array of elements that are not part of AAMVA standard and are specific to each US state. If no specific elements existed inside 2D barcode, this is an empty array. Otherwise, this array contains list of state-specific elements in the same order as given inside barcode. NOTE: Size of this array is both state-specific and barcode-specific. Each US state has ability to arbitrarily define size and contents of these elements. You can obtain the US state withgetField(com.microblink.blinkid.entities.recognizers.blinkbarcode.usdl.UsdlKeys)
and usingUsdlKeys.IssuingJurisdictionName
as a parameter. -
getField
Returns a field inside US Driver's licence. Available Keys are listed inUsdlKeys
enum.- Parameters:
key
- Key representing the required information.- Returns:
- required information (if it exists), or empty string if it does not
-
toString
-
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
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
-