USDLScanResult (LibPdf417Mobi API)

java.lang.Object
- com.microblink.recognizers.BaseRecognitionResult
- - com.microblink.recognizers.blinkbarcode.usdl.USDLScanResult

All Implemented Interfaces:

android.os.Parcelable
```
public class USDLScanResult
extends BaseRecognitionResult
```
Created by dodo on 16/09/14.

Nested Class Summary
- Nested classes/interfaces inherited from interface android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields
Modifier and Type	Field and Description
`static android.os.Parcelable.Creator<USDLScanResult>`	`CREATOR` Parcelable creator object
`static java.lang.String`	`kAddressCity` Mandatory on all AAMVA and Magnetic barcodes.
`static java.lang.String`	`kAddressJurisdictionCode` Mandatory on all AAMVA and Magnetic barcodes.
`static java.lang.String`	`kAddressPostalCode` Mandatory on all AAMVA and Magnetic barcodes.
`static java.lang.String`	`kAddressStreet` Mandatory on all AAMVA and Magnetic barcodes.
`static java.lang.String`	`kAddressStreet2` Optional on all AAMVA barcodes On Compact barcodes, use kFullAddress Second line of street portion of the cardholder address.
`static java.lang.String`	`kAKADateOfBirth` Optional on AAMVA 01.
`static java.lang.String`	`kAKAFamilyName` Optional on all AAMVA and Compact barcodes.
`static java.lang.String`	`kAKAFullName` Optional on all AAMVA and Compact barcodes.
`static java.lang.String`	`kAKAGivenName` Optional on all AAMVA and Compact barcodes.
`static java.lang.String`	`kAKAMiddleName` Optional on AAMVA 01 ALTERNATIVE MIDDLE NAME(s) or INITIALS of the individual holding the Driver License or ID.
`static java.lang.String`	`kAKAPrefixName` Optional on AAMVA 01 ALTERNATIVE PREFIX to Driver Name.
`static java.lang.String`	`kAKASocialSecurityNumber` Optional on AAMVA version 01.
`static java.lang.String`	`kAKASuffixName` Optional on all AAMVA and Compact barcodes.
`static java.lang.String`	`kAuditInformation` Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes A string of letters and/or numbers that identifies when, where, and by whom a driver license/ID card was made.
`static java.lang.String`	`kCardRevisionDate` Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes DHS required field that indicates date of the most recent version change or modification to the visible format of the DL/ID (MMDDCCYY format)
`static java.lang.String`	`kComplianceType` Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes DHS required field that indicates compliance: "M" = materially compliant; "F" = fully compliant; and, "N" = non-compliant.
`static java.lang.String`	`kCountryIdentification` Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes.
`static java.lang.String`	`kCustomerFamilyName` Mandatory on all AAMVA, Magnetic and Compact barcodes.
`static java.lang.String`	`kCustomerFirstName` Mandatory on all AAMVA, Magnetic and Compact barcodes.
`static java.lang.String`	`kCustomerFullName` Mandatory on all AAMVA, Magnetic and Compact barcodes.
`static java.lang.String`	`kCustomerIdNumber` Mandatory on all AAMVA and Compact barcodes The number assigned or calculated by the issuing authority.
`static java.lang.String`	`kCustomerMiddleName` Mandatory on AAMVA 04, 05, 06, 07, 08.
`static java.lang.String`	`kDataDiscriminator` Optional on compact encoding.
`static java.lang.String`	`kDateOfBirth` Mandatory on all AAMVA, Magentic and Compact barcodes.
`static java.lang.String`	`kDocumentDiscriminator` Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Magnetic barcodes.
`static java.lang.String`	`kDocumentExpirationDate` Mandatory on all AAMVA, Magnetic and Compact barcodes.
`static java.lang.String`	`kDocumentExpirationMonth` Optional on Magnetic barcodes.
`static java.lang.String`	`kDocumentIssueDate` Mandatory on all AAMVA and Compact barcodes.
`static java.lang.String`	`kDocumentNonexpiring` Optional on Magnetic barcodes.
`static java.lang.String`	`kDocumentType` Mandatory on all driver's licenses.
`static java.lang.String`	`kEyeColor` Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 barcodes.
`static java.lang.String`	`kFamilyNameTruncation` Mandatory on AAMVA 04, 05, 06, 07, 08 barcodes.
`static java.lang.String`	`kFederalCommercialVehicleCodes` Mandatory on AAMVA versions 02 and 03.
`static java.lang.String`	`kFirstNameTruncation` Mandatory on AAMVA 04, 05, 06, 07, 08 barcodes.
`static java.lang.String`	`kFullAddress` Mandatory on all AAMVA and Magnetic barcodes.
`static java.lang.String`	`kHairColor` Optional on all AAMVA, Magnetic and Compact barcodes.
`static java.lang.String`	`kHAZMATExpirationDate` Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes Date on which the hazardous material endorsement granted by the document is no longer valid.
`static java.lang.String`	`kHeight` Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 Height of cardholder.
`static java.lang.String`	`kHeightCm` Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 Compact barcodes.
`static java.lang.String`	`kHeightIn` Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes.
`static java.lang.String`	`kInventoryControlNumber` Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 A string of letters and/or numbers that is affixed to the raw materials (card stock, laminate, etc.) used in producing driver licenses and ID cards.
`static java.lang.String`	`kIssuerIdentificationNumber` Mandatory on all AAMVA, Magnetic and Compact barcodes.
`static java.lang.String`	`kIssueTimestamp` Optional on AAMVA version 01.
`static java.lang.String`	`kIssuingJurisdiction` Optional on all AAMVA barcodes.
`static java.lang.String`	`kIssuingJurisdictionName` Optional on all AAMVA and Magnetic barcodes.
`static java.lang.String`	`kJurisdictionEndorsementCodes` Mandatory on all AAMVA barcodes.
`static java.lang.String`	`kJurisdictionEndorsmentCodeDescription` Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes Text that explains the jurisdiction-specific code(s) that indicates additional driving privileges granted to the cardholder beyond the vehicle class.
`static java.lang.String`	`kJurisdictionRestrictionCodeDescription` Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes Text describing the jurisdiction-specific restriction code(s) that curtail driving privileges.
`static java.lang.String`	`kJurisdictionRestrictionCodes` Mandatory on all AAMVA barcodes.
`static java.lang.String`	`kJurisdictionVehicleClass` Mandatory on all AAMVA and Magnetic barcodes.
`static java.lang.String`	`kJurisdictionVehicleClassificationDescription` Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes Text that explains the jurisdiction-specific code(s) for classifications of vehicles cardholder is authorized to drive.
`static java.lang.String`	`kJurisdictionVersionNumber` Mandatory on all AAMVA and Compact barcodes.
`static java.lang.String`	`kLimitedDurationDocument` Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes DHS required field that indicates that the cardholder has temporary lawful status = "1".
`static java.lang.String`	`kMedicalIndicator` Optional on AAMVA version 01.
`static java.lang.String`	`kMiddleNameTruncation` Mandatory on AAMVA 04, 05, 06, 07, 08 A code that indicates whether a field has been truncated (T), has not been truncated (N), or – unknown whether truncated (U).
`static java.lang.String`	`kNamePrefix` Optional on AAMVA 01 PREFIX to Driver Name.
`static java.lang.String`	`kNameSuffix` Mandatory on AAMVA 02 barcodes.
`static java.lang.String`	`kNonResident` Optional on AAMVA version 01.
`static java.lang.String`	`kNumberOfDuplicates` Optional on AAMVA version 01.
`static java.lang.String`	`kOrganDonor` Optional on AAMVA 06, 07, 08 Field that indicates that the cardholder is an organ donor = "1".
`static java.lang.String`	`kPermitExpirationDate` Optional on AAMVA version 01.
`static java.lang.String`	`kPermitIdentifier` Optional on AAMVA version 01.
`static java.lang.String`	`kPermitIssueDate` Optional on AAMVA version 01.
`static java.lang.String`	`kPlaceOfBirth` Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes Country and municipality and/or state/province
`static java.lang.String`	`kRaceEthnicity` Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes Codes for race or ethnicity of the cardholder, as defined in ANSI D20.
`static java.lang.String`	`kResidenceCity` Optional on AAMVA version 01.
`static java.lang.String`	`kResidenceFullAddress` Optional on AAMVA 01 barcodes.
`static java.lang.String`	`kResidenceJurisdictionCode` Optional on AAMVA version 01.
`static java.lang.String`	`kResidencePostalCode` Optional on AAMVA version 01.
`static java.lang.String`	`kResidenceStreetAddress` Optional on AAMVA version 01.
`static java.lang.String`	`kResidenceStreetAddress2` Optional on AAMVA version 01.
`static java.lang.String`	`kSecurityVersion` Optional on Magnetic barcodes.
`static java.lang.String`	`kSex` Mandatory on all AAMVA, Magentic barcodes.
`static java.lang.String`	`kSocialSecurityNumber` Optional on AAMVA version 01.
`static java.lang.String`	`kStandardEndorsementCode` Optional on all AAMVA barcodes.
`static java.lang.String`	`kStandardRestrictionCode` Optional on all AAMVA barcodes Standard restriction code(s) for cardholder.
`static java.lang.String`	`kStandardVehicleClassification` Optional on all AAMVA barcodes.
`static java.lang.String`	`kStandardVersionNumber` Mandatory on all driver's licenses.
`static java.lang.String`	`kUnder18` Optional on AAMVA 05, 06, 07, 08 Date on which the cardholder turns 18 years old.
`static java.lang.String`	`kUnder19` Optional on AAMVA 05, 06, 07, 08 Date on which the cardholder turns 19 years old.
`static java.lang.String`	`kUnder21` Optional on AAMVA 05, 06, 07, 08 Date on which the cardholder turns 21 years old.
`static java.lang.String`	`kUniqueCustomerId` Optional on AAMVA version 01.
`static java.lang.String`	`kVeteran` Optional on AAMVA 07, 08 Field that indicates that the cardholder is a veteran = "1"
`static java.lang.String`	`kWeightKilograms` Mandatory on AAMVA 02 barcodes.
`static java.lang.String`	`kWeightPounds` Mandatory on AAMVA 02 barcodes.
`static java.lang.String`	`kWeightRange` Mandatory on AAMVA 02 barcodes.

Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors
Modifier	Constructor and Description
	`USDLScanResult(long data, boolean empty, boolean valid)`
`protected`	`USDLScanResult(android.os.Parcel in)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getField(java.lang.String key)` Returns a field inside US Driver's licence.
`BarcodeDetailedData`	`getRawData()` Returns the raw barcode data.
`java.lang.String`	`getStringData()` Returns the string representation of barcode data (not parsed).
`java.lang.String`	`getTitle()`
`boolean`	`isUncertain()` Returns true if returned data is uncertain, only applicable if used with Pdf417RecognizerSettings.setUncertainScanning(true)
`java.lang.String`	`toString()`
`void`	`writeToParcel(android.os.Parcel dest, int flags)` Method serializes the object to android Parcel.

Methods inherited from class com.microblink.recognizers.BaseRecognitionResult
describeContents, getIntElement, getResultHolder, getStringElement, isEmpty, isValid, log

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

- Field Detail
  - kDocumentType
```
public static final java.lang.String kDocumentType
```
    Mandatory on all driver's licenses. All barcodes which are using 3-track magnetic stripe encoding used in the interest of smoothing a transition from legacy documents shall be designated as "Magnetic". All barcodes which are using compact encoding compliant with ISO/IEC 18013-2 shall be designated as "Compact". All barcodes (majority) compliant with Mandatory PDF417 Bar Code of the American Association of Motor Vehicle Administrators (AAMVA) Card Design Standard from AAMVA DL/ID-2000 standard to DL/ID-2013 shall be designated as "AAMVA".
    
    See Also:
    
    Constant Field Values
  - kStandardVersionNumber
```
public static final java.lang.String kStandardVersionNumber
```
    Mandatory on all driver's licenses. AAMVA Version Number: This is a decimal value between 0 and 99 that specifies the version level of the PDF417 bar code format. Version "0" and "00" is reserved for bar codes printed to the specification of the American Association of Motor Vehicle Administrators (AAMVA) prior to the adoption of the AAMVA DL/ID-2000 standard. All bar codes compliant with the AAMVA DL/ID-2000 standard are designated Version "01." All barcodes compliant with AAMVA Card Design Specification version 1.0, dated 09-2003 shall be designated Version "02." All barcodes compliant with AAMVA Card Design Specification version 2.0, dated 03-2005 shall be designated Version "03." All barcodes compliant with AAMVA Card Design Standard version 1.0, dated 07-2009 shall be designated Version "04." All barcodes compliant with AAMVA Card Design Standard version 1.0, dated 07-2010 shall be designated Version "05." All barcodes compliant with AAMVA Card Design Standard version 1.0, dated 07- 2011 shall be designated Version "06". All barcodes compliant with AAMVA Card Design Standard version 1.0, dated 06-2012 shall be designated Version "07". All barcodes compliant with this current AAMVA standard shall be designated "08". Should a need arise requiring major revision to the format, this field provides the means to accommodate additional revision. If document type is not "AAMVA", this field defines version number of the given document type's standard.
    
    See Also:
    
    Constant Field Values
  - kCustomerFamilyName
```
public static final java.lang.String kCustomerFamilyName
```
    Mandatory on all AAMVA, Magnetic and Compact barcodes. Family name of the cardholder. (Family name is sometimes also called "last name" or "surname.") Collect full name for record, print as many characters as possible on portrait side of DL/ID.
    
    See Also:
    
    Constant Field Values
  - kCustomerFirstName
```
public static final java.lang.String kCustomerFirstName
```
    Mandatory on all AAMVA, Magnetic and Compact barcodes. First name of the cardholder.
    
    See Also:
    
    Constant Field Values
  - kCustomerFullName
```
public static final java.lang.String kCustomerFullName
```
    Mandatory on all AAMVA, Magnetic and Compact barcodes. Full name of the individual holding the Driver License or ID. The Name field contains up to four portions, separated with the "," delimiter: Last Name (required) , (required) First Name (required) , (required if other name portions follow, otherwise optional) Middle Name(s) (optional) , (required if other name portions follow, otherwise optional) Suffix (optional) , (optional) If indvidual has more than one middle name they are separated with space.
    
    See Also:
    
    Constant Field Values
  - kDateOfBirth
```
public static final java.lang.String kDateOfBirth
```
    Mandatory on all AAMVA, Magentic and Compact barcodes. Date on which the cardholder was born. (MMDDCCYY format)
    
    See Also:
    
    Constant Field Values
  - kSex
```
public static final java.lang.String kSex
```
    Mandatory on all AAMVA, Magentic barcodes. Optional on Compact barcodes. Gender of the cardholder. 1 = male, 2 = female.
    
    See Also:
    
    Constant Field Values
  - kEyeColor
```
public static final java.lang.String kEyeColor
```
    Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 barcodes. Optional on AAMVA 01, Magnetic and Compact barcodes. Color of cardholder's eyes. (ANSI D-20 codes) Code Description BLK Black BLU Blue BRO Brown GRY Gray GRN Green HAZ Hazel MAR Maroon PNK Pink DIC Dichromatic UNK Unknown
    
    See Also:
    
    Constant Field Values
  - kAddressStreet
```
public static final java.lang.String kAddressStreet
```
    Mandatory on all AAMVA and Magnetic barcodes. On compact barcodes, use kFullAddress. Street portion of the cardholder address. The place where the registered driver of a vehicle (individual or corporation) may be contacted such as a house number, street address etc.
    
    See Also:
    
    Constant Field Values
  - kAddressCity
```
public static final java.lang.String kAddressCity
```
    Mandatory on all AAMVA and Magnetic barcodes. On compact barcodes, use kFullAddress. City portion of the cardholder address.
    
    See Also:
    
    Constant Field Values
  - kAddressJurisdictionCode
```
public static final java.lang.String kAddressJurisdictionCode
```
    Mandatory on all AAMVA and Magnetic barcodes. On compact barcodes, use kFullAddress. State portion of the cardholder address.
    
    See Also:
    
    Constant Field Values
  - kAddressPostalCode
```
public static final java.lang.String kAddressPostalCode
```
    Mandatory on all AAMVA and Magnetic barcodes. On compact barcodes, use kFullAddress. Postal code portion of the cardholder address in the U.S. and Canada. If the trailing portion of the postal code in the U.S. is not known, zeros can be used to fill the trailing set of numbers up to nine (9) digits.
    
    See Also:
    
    Constant Field Values
  - kFullAddress
```
public static final java.lang.String kFullAddress
```
    Mandatory on all AAMVA and Magnetic barcodes. Optional on Compact barcodes. Full address of the individual holding the Driver License or ID. The full address field contains up to four portions, separated with the "," delimiter: Street Address (required) , (required if other address portions follow, otherwise optional) City (optional) , (required if other address portions follow, otherwise optional) Jurisdiction Code (optional) , (required if other address portions follow, otherwise optional) ZIP - Postal Code (optional)
    
    See Also:
    
    Constant Field Values
  - kHeight
```
public static final java.lang.String kHeight
```
    Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 Height of cardholder. Inches (in): number of inches followed by " in" example. 6'1'' = "073 in" Centimeters (cm): number of centimeters followed by " cm" example. 181 centimeters="181 cm"
    
    See Also:
    
    Constant Field Values
  - kHeightIn
```
public static final java.lang.String kHeightIn
```
    Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes. Optional on AAMVA 01 and Magnetic barcodes. Height of cardholder in Inches. Example: 5'9'' = "69".
    
    See Also:
    
    Constant Field Values
  - kHeightCm
```
public static final java.lang.String kHeightCm
```
    Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 Compact barcodes. Optional on AAMVA 01 and Magnetic barcodes. Height of cardholder in Centimeters. Example: 180 Centimeters = "180".
    
    See Also:
    
    Constant Field Values
  - kCustomerMiddleName
```
public static final java.lang.String kCustomerMiddleName
```
    Mandatory on AAMVA 04, 05, 06, 07, 08. Optional on AAMVA 01, 02, 03, Magnetic and Compcat barcodes. Middle name(s) of the cardholder. In the case of multiple middle names they shall be separated by space " ".
    
    See Also:
    
    Constant Field Values
  - kHairColor
```
public static final java.lang.String kHairColor
```
    Optional on all AAMVA, Magnetic and Compact barcodes. Bald, black, blonde, brown, gray, red/auburn, sandy, white, unknown. If the issuing jurisdiction wishes to abbreviate colors, the three-character codes provided in ANSI D20 must be used. Code Description BAL Bald BLK Black BLN Blond BRO Brown GRY Grey RED Red/Auburn SDY Sandy WHI White UNK Unknown
    
    See Also:
    
    Constant Field Values
  - kNameSuffix
```
public static final java.lang.String kNameSuffix
```
    Mandatory on AAMVA 02 barcodes. Optional on AAMVA 01, 03, 04, 05, 06, 07, 08, Magnetic and Compact barcodes. Name Suffix (If jurisdiction participates in systems requiring name suffix (PDPS, CDLIS, etc.), the suffix must be collected and displayed on the DL/ID and in the MRT). - JR (Junior) - SR (Senior) - 1ST or I (First) - 2ND or II (Second) - 3RD or III (Third) - 4TH or IV (Fourth) - 5TH or V (Fifth) - 6TH or VI (Sixth) - 7TH or VII (Seventh) - 8TH or VIII (Eighth) - 9TH or IX (Ninth)
    
    See Also:
    
    Constant Field Values
  - kAKAFullName
```
public static final java.lang.String kAKAFullName
```
    Optional on all AAMVA and Compact barcodes. Other name by which cardholder is known. ALTERNATIVE NAME(S) of the individual holding the Driver License or ID. The Name field contains up to four portions, separated with the "," delimiter: AKA Last Name (required) , (required) AKA First Name (required) , (required if other name portions follow, otherwise optional) AKA Middle Name(s) (optional) , (required if other name portions follow, otherwise optional) AKA Suffix (optional) , (optional) If indvidual has more than one AKA middle name they are separated with space.
    
    See Also:
    
    Constant Field Values
  - kAKAFamilyName
```
public static final java.lang.String kAKAFamilyName
```
    Optional on all AAMVA and Compact barcodes. Other family name by which cardholder is known.
    
    See Also:
    
    Constant Field Values
  - kAKAGivenName
```
public static final java.lang.String kAKAGivenName
```
    Optional on all AAMVA and Compact barcodes. Other given name by which cardholder is known
    
    See Also:
    
    Constant Field Values
  - kAKASuffixName
```
public static final java.lang.String kAKASuffixName
```
    Optional on all AAMVA and Compact barcodes. Other suffix by which cardholder is known. The Suffix Code Portion, if submitted, can contain only the Suffix Codes shown in the following table (e.g., Andrew Johnson, III = JOHNSON@ANDREW@@3RD): Suffix Meaning or Synonym JR Junior SR Senior or Esquire 1ST First 2ND Second 3RD Third 4TH Fourth 5TH Fifth 6TH Sixth 7TH Seventh 8TH Eighth 9TH Ninth
    
    See Also:
    
    Constant Field Values
  - kWeightRange
```
public static final java.lang.String kWeightRange
```
    Mandatory on AAMVA 02 barcodes. Optional on AAMVA 01, 03, 04, 05, 06, 07, 08, Magnetic and Compact barcodes. Indicates the approximate weight range of the cardholder: 0 = up to 31 kg (up to 70 lbs) 1 = 32 – 45 kg (71 – 100 lbs) 2 = 46 - 59 kg (101 – 130 lbs) 3 = 60 - 70 kg (131 – 160 lbs) 4 = 71 - 86 kg (161 – 190 lbs) 5 = 87 - 100 kg (191 – 220 lbs) 6 = 101 - 113 kg (221 – 250 lbs) 7 = 114 - 127 kg (251 – 280 lbs) 8 = 128 – 145 kg (281 – 320 lbs) 9 = 146+ kg (321+ lbs)
    
    See Also:
    
    Constant Field Values
  - kWeightPounds
```
public static final java.lang.String kWeightPounds
```
    Mandatory on AAMVA 02 barcodes. Optional on AAMVA 01, 03, 04, 05, 06, 07, 08, Magnetic and Compact barcodes. Cardholder weight in pounds Example: 185 lb = "185"
    
    See Also:
    
    Constant Field Values
  - kWeightKilograms
```
public static final java.lang.String kWeightKilograms
```
    Mandatory on AAMVA 02 barcodes. Optional on AAMVA 01, 03, 04, 05, 06, 07, 08, Magnetic and Compact barcodes. Cardholder weight in kilograms Example: 84 kg = "084"
    
    See Also:
    
    Constant Field Values
  - kCustomerIdNumber
```
public static final java.lang.String kCustomerIdNumber
```
    Mandatory on all AAMVA and Compact barcodes The number assigned or calculated by the issuing authority.
    
    See Also:
    
    Constant Field Values
  - kFamilyNameTruncation
```
public static final java.lang.String kFamilyNameTruncation
```
    Mandatory on AAMVA 04, 05, 06, 07, 08 barcodes. Optional on Compact barcodes. A code that indicates whether a field has been truncated (T), has not been truncated (N), or – unknown whether truncated (U).
    
    See Also:
    
    Constant Field Values
  - kFirstNameTruncation
```
public static final java.lang.String kFirstNameTruncation
```
    Mandatory on AAMVA 04, 05, 06, 07, 08 barcodes. Optional on Compact barcodes. A code that indicates whether a field has been truncated (T), has not been truncated (N), or – unknown whether truncated (U).
    
    See Also:
    
    Constant Field Values
  - kMiddleNameTruncation
```
public static final java.lang.String kMiddleNameTruncation
```
    Mandatory on AAMVA 04, 05, 06, 07, 08 A code that indicates whether a field has been truncated (T), has not been truncated (N), or – unknown whether truncated (U).
    
    See Also:
    
    Constant Field Values
  - kPlaceOfBirth
```
public static final java.lang.String kPlaceOfBirth
```
    Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes Country and municipality and/or state/province
    
    See Also:
    
    Constant Field Values
  - kAddressStreet2
```
public static final java.lang.String kAddressStreet2
```
    Optional on all AAMVA barcodes On Compact barcodes, use kFullAddress Second line of street portion of the cardholder address.
    
    See Also:
    
    Constant Field Values
  - kRaceEthnicity
```
public static final java.lang.String kRaceEthnicity
```
    Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes Codes for race or ethnicity of the cardholder, as defined in ANSI D20. Race: Code Description AI Alaskan or American Indian (Having Origins in Any of The Original Peoples of North America, and Maintaining Cultural Identification Through Tribal Affiliation of Community Recognition) AP Asian or Pacific Islander (Having Origins in Any of the Original Peoples of the Far East, Southeast Asia, or Pacific Islands. This Includes China, India, Japan, Korea, the Philippines Islands, and Samoa) BK Black (Having Origins in Any of the Black Racial Groups of Africa) W White (Having Origins in Any of The Original Peoples of Europe, North Africa, or the Middle East) Ethnicity: Code Description H Hispanic Origin (A Person of Mexican, Puerto Rican, Cuban, Central or South American or Other Spanish Culture or Origin, Regardless of Race) O Not of Hispanic Origin (Any Person Other Than Hispanic) U Unknown
    
    See Also:
    
    Constant Field Values
  - kNamePrefix
```
public static final java.lang.String kNamePrefix
```
    Optional on AAMVA 01 PREFIX to Driver Name. Freeform as defined by issuing jurisdiction.
    
    See Also:
    
    Constant Field Values
  - kCountryIdentification
```
public static final java.lang.String kCountryIdentification
```
    Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes. Country in which DL/ID is issued. U.S. = USA, Canada = CAN.
    
    See Also:
    
    Constant Field Values
  - kResidenceStreetAddress
```
public static final java.lang.String kResidenceStreetAddress
```
    Optional on AAMVA version 01. Driver Residence Street Address 1.
    
    See Also:
    
    Constant Field Values
  - kResidenceStreetAddress2
```
public static final java.lang.String kResidenceStreetAddress2
```
    Optional on AAMVA version 01. Driver Residence Street Address 2.
    
    See Also:
    
    Constant Field Values
  - kResidenceCity
```
public static final java.lang.String kResidenceCity
```
    Optional on AAMVA version 01. Driver Residence City
    
    See Also:
    
    Constant Field Values
  - kResidenceJurisdictionCode
```
public static final java.lang.String kResidenceJurisdictionCode
```
    Optional on AAMVA version 01. Driver Residence Jurisdiction Code.
    
    See Also:
    
    Constant Field Values
  - kResidencePostalCode
```
public static final java.lang.String kResidencePostalCode
```
    Optional on AAMVA version 01. Driver Residence Postal Code.
    
    See Also:
    
    Constant Field Values
  - kResidenceFullAddress
```
public static final java.lang.String kResidenceFullAddress
```
    Optional on AAMVA 01 barcodes. Full residence address of the individual holding the Driver License or ID. The full address field contains up to four portions, separated with the "," delimiter: Residence Street Address (required) , (required if other address portions follow, otherwise optional) Residence City (optional) , (required if other address portions follow, otherwise optional) Residence Jurisdiction Code (optional) , (required if other address portions follow, otherwise optional) Residence ZIP - Residence Postal Code (optional)
    
    See Also:
    
    Constant Field Values
  - kUnder18
```
public static final java.lang.String kUnder18
```
    Optional on AAMVA 05, 06, 07, 08 Date on which the cardholder turns 18 years old. (MMDDCCYY format)
    
    See Also:
    
    Constant Field Values
  - kUnder19
```
public static final java.lang.String kUnder19
```
    Optional on AAMVA 05, 06, 07, 08 Date on which the cardholder turns 19 years old. (MMDDCCYY format)
    
    See Also:
    
    Constant Field Values
  - kUnder21
```
public static final java.lang.String kUnder21
```
    Optional on AAMVA 05, 06, 07, 08 Date on which the cardholder turns 21 years old. (MMDDCCYY format)
    
    See Also:
    
    Constant Field Values
  - kSocialSecurityNumber
```
public static final java.lang.String kSocialSecurityNumber
```
    Optional on AAMVA version 01. The number assigned to an individual by the Social Security Administration.
    
    See Also:
    
    Constant Field Values
  - kAKASocialSecurityNumber
```
public static final java.lang.String kAKASocialSecurityNumber
```
    Optional on AAMVA version 01. Driver "AKA" Social Security Number. FORMAT SAME AS DRIVER SOC SEC NUM. ALTERNATIVE NUMBERS(S) used as SS NUM.
    
    See Also:
    
    Constant Field Values
  - kAKAMiddleName
```
public static final java.lang.String kAKAMiddleName
```
    Optional on AAMVA 01 ALTERNATIVE MIDDLE NAME(s) or INITIALS of the individual holding the Driver License or ID. Hyphenated names acceptable, spaces between names acceptable, but no other use of special symbols
    
    See Also:
    
    Constant Field Values
  - kAKAPrefixName
```
public static final java.lang.String kAKAPrefixName
```
    Optional on AAMVA 01 ALTERNATIVE PREFIX to Driver Name. Freeform as defined by issuing jurisdiction.
    
    See Also:
    
    Constant Field Values
  - kOrganDonor
```
public static final java.lang.String kOrganDonor
```
    Optional on AAMVA 06, 07, 08 Field that indicates that the cardholder is an organ donor = "1".
    
    See Also:
    
    Constant Field Values
  - kVeteran
```
public static final java.lang.String kVeteran
```
    Optional on AAMVA 07, 08 Field that indicates that the cardholder is a veteran = "1"
    
    See Also:
    
    Constant Field Values
  - kAKADateOfBirth
```
public static final java.lang.String kAKADateOfBirth
```
    Optional on AAMVA 01. (MMDDCCYY format) ALTERNATIVE DATES(S) given as date of birth.
    
    See Also:
    
    Constant Field Values
  - kIssuerIdentificationNumber
```
public static final java.lang.String kIssuerIdentificationNumber
```
    Mandatory on all AAMVA, Magnetic and Compact barcodes. This number uniquely identifies the issuing jurisdiction and can be obtained by contacting the ISO Issuing Authority (AAMVA)
    
    See Also:
    
    Constant Field Values
  - kDocumentExpirationDate
```
public static final java.lang.String kDocumentExpirationDate
```
    Mandatory on all AAMVA, Magnetic and Compact barcodes. If document is non expiring than "Non expiring" is written in this field. Date on which the driving and identification privileges granted by the document are no longer valid. (MMDDCCYY format)
    
    See Also:
    
    Constant Field Values
  - kJurisdictionVersionNumber
```
public static final java.lang.String kJurisdictionVersionNumber
```
    Mandatory on all AAMVA and Compact barcodes. Optional on Magnetic barcodes. Jurisdiction Version Number: This is a decimal value between 0 and 99 that specifies the jurisdiction version level of the PDF417 bar code format. Notwithstanding iterations of this standard, jurisdictions implement incremental changes to their bar codes, including new jurisdiction-specific data, compression algorithms for digitized images, digital signatures, or new truncation conventions used for names and addresses. Each change to the bar code format within each AAMVA version (above) must be noted, beginning with Jurisdiction Version 00.
    
    See Also:
    
    Constant Field Values
  - kJurisdictionVehicleClass
```
public static final java.lang.String kJurisdictionVehicleClass
```
    Mandatory on all AAMVA and Magnetic barcodes. Jurisdiction-specific vehicle class / group code, designating the type of vehicle the cardholder has privilege to drive.
    
    See Also:
    
    Constant Field Values
  - kJurisdictionRestrictionCodes
```
public static final java.lang.String kJurisdictionRestrictionCodes
```
    Mandatory on all AAMVA barcodes. Optional on Magnetic barcodes. Jurisdiction-specific codes that represent restrictions to driving privileges (such as airbrakes, automatic transmission, daylight only, etc.).
    
    See Also:
    
    Constant Field Values
  - kJurisdictionEndorsementCodes
```
public static final java.lang.String kJurisdictionEndorsementCodes
```
    Mandatory on all AAMVA barcodes. Optional on Magnetic barcodes. Jurisdiction-specific codes that represent additional privileges granted to the cardholder beyond the vehicle class (such as transportation of passengers, hazardous materials, operation of motorcycles, etc.).
    
    See Also:
    
    Constant Field Values
  - kDocumentIssueDate
```
public static final java.lang.String kDocumentIssueDate
```
    Mandatory on all AAMVA and Compact barcodes. Date on which the document was issued. (MMDDCCYY format)
    
    See Also:
    
    Constant Field Values
  - kFederalCommercialVehicleCodes
```
public static final java.lang.String kFederalCommercialVehicleCodes
```
    Mandatory on AAMVA versions 02 and 03. Federally established codes for vehicle categories, endorsements, and restrictions that are generally applicable to commercial motor vehicles. If the vehicle is not a commercial vehicle, "NONE" is to be entered.
    
    See Also:
    
    Constant Field Values
  - kIssuingJurisdiction
```
public static final java.lang.String kIssuingJurisdiction
```
    Optional on all AAMVA barcodes. Mandatory on Compact barcodes. Jurisdictions may define a subfile to contain jurisdiction-specific information. These subfiles are designated with the first character of “Z” and the second character is the first letter of the jurisdiction's name. For example, "ZC" would be the designator for a California or Colorado jurisdiction-defined subfile; "ZQ" would be the designator for a Quebec jurisdiction-defined subfile. In the case of a jurisdiction-defined subfile that has a first letter that could be more than one jurisdiction (e.g. California, Colorado, Connecticut) then other data, like the IIN or address, must be examined to determine the jurisdiction.
    
    See Also:
    
    Constant Field Values
  - kStandardVehicleClassification
```
public static final java.lang.String kStandardVehicleClassification
```
    Optional on all AAMVA barcodes. Mandatory on Compact barcodes. Standard vehicle classification code(s) for cardholder. This data element is a placeholder for future efforts to standardize vehicle classifications.
    
    See Also:
    
    Constant Field Values
  - kIssuingJurisdictionName
```
public static final java.lang.String kIssuingJurisdictionName
```
    Optional on all AAMVA and Magnetic barcodes. Name of issuing jurisdiction, for example: Alabama, Alaska ...
    
    See Also:
    
    Constant Field Values
  - kStandardEndorsementCode
```
public static final java.lang.String kStandardEndorsementCode
```
    Optional on all AAMVA barcodes. Standard endorsement code(s) for cardholder. See codes in D20. This data element is a placeholder for future efforts to standardize endorsement codes. Code Description H Hazardous Material - This endorsement is required for the operation of any vehicle transporting hazardous materials requiring placarding, as defined by U.S. Department of Transportation regulations. L Motorcycles – Including Mopeds/Motorized Bicycles. N Tank - This endorsement is required for the operation of any vehicle transporting, as its primary cargo, any liquid or gaseous material within a tank attached to the vehicle. O Other Jurisdiction Specific Endorsement(s) - This code indicates one or more additional jurisdiction assigned endorsements. P Passenger - This endorsement is required for the operation of any vehicle used for transportation of sixteen or more occupants, including the driver. S School Bus - This endorsement is required for the operation of a school bus. School bus means a CMV used to transport pre-primary, primary, or secondary school students from home to school, from school to home, or to and from school sponsored events. School bus does not include a bus used as common carrier (49 CRF 383.5). T Doubles/Triples - This endorsement is required for the operation of any vehicle that would be referred to as a double or triple. X Combined Tank/HAZ-MAT - This endorsement may be issued to any driver who qualifies for both the N and H endorsements.
    
    See Also:
    
    Constant Field Values
  - kStandardRestrictionCode
```
public static final java.lang.String kStandardRestrictionCode
```
    Optional on all AAMVA barcodes Standard restriction code(s) for cardholder. See codes in D20. This data element is a placeholder for future efforts to standardize restriction codes. Code Description B Corrective Lenses C Mechanical Devices (Special Brakes, Hand Controls, or Other Adaptive Devices) D Prosthetic Aid E Automatic Transmission F Outside Mirror G Limit to Daylight Only H Limit to Employment I Limited Other J Other K CDL Intrastate Only L Vehicles without air brakes M Except Class A bus N Except Class A and Class B bus O Except Tractor-Trailer V Medical Variance Documentation Required W Farm Waiver
    
    See Also:
    
    Constant Field Values
  - kJurisdictionVehicleClassificationDescription
```
public static final java.lang.String kJurisdictionVehicleClassificationDescription
```
    Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes Text that explains the jurisdiction-specific code(s) for classifications of vehicles cardholder is authorized to drive.
    
    See Also:
    
    Constant Field Values
  - kJurisdictionEndorsmentCodeDescription
```
public static final java.lang.String kJurisdictionEndorsmentCodeDescription
```
    Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes Text that explains the jurisdiction-specific code(s) that indicates additional driving privileges granted to the cardholder beyond the vehicle class.
    
    See Also:
    
    Constant Field Values
  - kJurisdictionRestrictionCodeDescription
```
public static final java.lang.String kJurisdictionRestrictionCodeDescription
```
    Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes Text describing the jurisdiction-specific restriction code(s) that curtail driving privileges.
    
    See Also:
    
    Constant Field Values
  - kInventoryControlNumber
```
public static final java.lang.String kInventoryControlNumber
```
    Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 A string of letters and/or numbers that is affixed to the raw materials (card stock, laminate, etc.) used in producing driver licenses and ID cards. (DHS recommended field)
    
    See Also:
    
    Constant Field Values
  - kCardRevisionDate
```
public static final java.lang.String kCardRevisionDate
```
    Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes DHS required field that indicates date of the most recent version change or modification to the visible format of the DL/ID (MMDDCCYY format)
    
    See Also:
    
    Constant Field Values
  - kDocumentDiscriminator
```
public static final java.lang.String kDocumentDiscriminator
```
    Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Magnetic barcodes. Optional and Compact barcodes Number must uniquely identify a particular document issued to that customer from others that may have been issued in the past. This number may serve multiple purposes of document discrimination, audit information number, and/or inventory control.
    
    See Also:
    
    Constant Field Values
  - kLimitedDurationDocument
```
public static final java.lang.String kLimitedDurationDocument
```
    Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes DHS required field that indicates that the cardholder has temporary lawful status = "1".
    
    See Also:
    
    Constant Field Values
  - kAuditInformation
```
public static final java.lang.String kAuditInformation
```
    Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes A string of letters and/or numbers that identifies when, where, and by whom a driver license/ID card was made. If audit information is not used on the card or the MRT, it must be included in the driver record.
    
    See Also:
    
    Constant Field Values
  - kComplianceType
```
public static final java.lang.String kComplianceType
```
    Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes DHS required field that indicates compliance: "M" = materially compliant; "F" = fully compliant; and, "N" = non-compliant.
    
    See Also:
    
    Constant Field Values
  - kIssueTimestamp
```
public static final java.lang.String kIssueTimestamp
```
    Optional on AAMVA version 01. Issue Timestamp. A string used by some jurisdictions to validate the document against their data base.
    
    See Also:
    
    Constant Field Values
  - kPermitExpirationDate
```
public static final java.lang.String kPermitExpirationDate
```
    Optional on AAMVA version 01. Driver Permit Expiration Date. MMDDCCYY format. Date permit expires.
    
    See Also:
    
    Constant Field Values
  - kPermitIdentifier
```
public static final java.lang.String kPermitIdentifier
```
    Optional on AAMVA version 01. Type of permit.
    
    See Also:
    
    Constant Field Values
  - kPermitIssueDate
```
public static final java.lang.String kPermitIssueDate
```
    Optional on AAMVA version 01. Driver Permit Issue Date. MMDDCCYY format. Date permit was issued.
    
    See Also:
    
    Constant Field Values
  - kNumberOfDuplicates
```
public static final java.lang.String kNumberOfDuplicates
```
    Optional on AAMVA version 01. Number of duplicate cards issued for a license or ID if any.
    
    See Also:
    
    Constant Field Values
  - kHAZMATExpirationDate
```
public static final java.lang.String kHAZMATExpirationDate
```
    Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes Date on which the hazardous material endorsement granted by the document is no longer valid. (MMDDCCYY format)
    
    See Also:
    
    Constant Field Values
  - kMedicalIndicator
```
public static final java.lang.String kMedicalIndicator
```
    Optional on AAMVA version 01. Medical Indicator/Codes. STATE SPECIFIC. Freeform; Standard "TBD"
    
    See Also:
    
    Constant Field Values
  - kNonResident
```
public static final java.lang.String kNonResident
```
    Optional on AAMVA version 01. Non-Resident Indicator. "Y". Used by some jurisdictions to indicate holder of the document is a non-resident.
    
    See Also:
    
    Constant Field Values
  - kUniqueCustomerId
```
public static final java.lang.String kUniqueCustomerId
```
    Optional on AAMVA version 01. A number or alphanumeric string used by some jurisdictions to identify a "customer" across multiple data bases.
    
    See Also:
    
    Constant Field Values
  - kDataDiscriminator
```
public static final java.lang.String kDataDiscriminator
```
    Optional on compact encoding. Document discriminator.
    
    See Also:
    
    Constant Field Values
  - kDocumentExpirationMonth
```
public static final java.lang.String kDocumentExpirationMonth
```
    Optional on Magnetic barcodes. Month on which the driving and identification privileges granted by the document are no longer valid. (MMYY format)
    
    See Also:
    
    Constant Field Values
  - kDocumentNonexpiring
```
public static final java.lang.String kDocumentNonexpiring
```
    Optional on Magnetic barcodes. Field that indicates that the driving and identification privileges granted by the document are nonexpiring = "1".
    
    See Also:
    
    Constant Field Values
  - kSecurityVersion
```
public static final java.lang.String kSecurityVersion
```
    Optional on Magnetic barcodes. Security version beeing used.
    
    See Also:
    
    Constant Field Values
  - CREATOR
```
public static final android.os.Parcelable.Creator<USDLScanResult> CREATOR
```
    Parcelable creator object
- Constructor Detail
  - USDLScanResult
```
public USDLScanResult(long data,
                      boolean empty,
                      boolean valid)
```
  - USDLScanResult
```
protected USDLScanResult(android.os.Parcel in)
```
- Method Detail
  - writeToParcel
```
public void writeToParcel(android.os.Parcel dest,
                          int flags)
```
    Description copied from class: BaseRecognitionResult
    
    Method serializes the object to android Parcel. This is required in order to enable sending this object via Intents.
    
    Specified by:
    
    writeToParcel in interface android.os.Parcelable
    
    Overrides:
    
    writeToParcel in class BaseRecognitionResult
    
    Parameters:
    
    dest - Destination
    
    flags - Additional serializer flags.
  - getField
```
@Nullable
public java.lang.String getField(java.lang.String key)
```
    Returns a field inside US Driver's licence. Available Keys are listed as public static String fields in this class.
    
    Parameters:
    
    key - Key representing the required information.
    
    Returns:
    
    required information (if it exists), or null if it does not
  - isUncertain
```
public boolean isUncertain()
```
    Returns true if returned data is uncertain, only applicable if used with Pdf417RecognizerSettings.setUncertainScanning(true)
    
    Returns:
    
    true if returned data is uncertain
  - getRawData
```
@Nullable
public BarcodeDetailedData getRawData()
```
    Returns the raw barcode data.
    
    Returns:
    
    the raw barcode data.
  - getStringData
```
@Nullable
public java.lang.String getStringData()
```
    Returns the string representation of barcode data (not parsed).
    
    Returns:
    
    the string representation of barcode data (not parsed).
  - getTitle
```
public java.lang.String getTitle()
```
    Overrides:
    
    getTitle in class BaseRecognitionResult
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class BaseRecognitionResult

Class USDLScanResult

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class com.microblink.recognizers.BaseRecognitionResult

Methods inherited from class java.lang.Object

Field Detail

kDocumentType

kStandardVersionNumber

kCustomerFamilyName

kCustomerFirstName

kCustomerFullName

kDateOfBirth

kSex

kEyeColor

kAddressStreet

kAddressCity

kAddressJurisdictionCode

kAddressPostalCode

kFullAddress

kHeight

kHeightIn

kHeightCm

kCustomerMiddleName

kHairColor

kNameSuffix

kAKAFullName

kAKAFamilyName

kAKAGivenName

kAKASuffixName

kWeightRange

kWeightPounds

kWeightKilograms

kCustomerIdNumber

kFamilyNameTruncation

kFirstNameTruncation

kMiddleNameTruncation

kPlaceOfBirth

kAddressStreet2

kRaceEthnicity

kNamePrefix

kCountryIdentification

kResidenceStreetAddress

kResidenceStreetAddress2

kResidenceCity

kResidenceJurisdictionCode

kResidencePostalCode

kResidenceFullAddress

kUnder18

kUnder19

kUnder21

kSocialSecurityNumber

kAKASocialSecurityNumber

kAKAMiddleName

kAKAPrefixName

kOrganDonor

kVeteran

kAKADateOfBirth

kIssuerIdentificationNumber

kDocumentExpirationDate

kJurisdictionVersionNumber

kJurisdictionVehicleClass

kJurisdictionRestrictionCodes

kJurisdictionEndorsementCodes

kDocumentIssueDate

kFederalCommercialVehicleCodes

kIssuingJurisdiction

kStandardVehicleClassification

kIssuingJurisdictionName

kStandardEndorsementCode

kStandardRestrictionCode

kJurisdictionVehicleClassificationDescription

kJurisdictionEndorsmentCodeDescription

kJurisdictionRestrictionCodeDescription

kInventoryControlNumber

kCardRevisionDate

kDocumentDiscriminator