- C(document) - Constructor for class io.scanbot.genericdocument.entity.Categories.C
-
- C.Companion - Class in io.scanbot.genericdocument.entity
-
- C1(document) - Constructor for class io.scanbot.genericdocument.entity.Categories.C1
-
- C1.Companion - Class in io.scanbot.genericdocument.entity
-
- C1E(document) - Constructor for class io.scanbot.genericdocument.entity.Categories.C1E
-
- C1E.Companion - Class in io.scanbot.genericdocument.entity
-
- Categories(document) - Constructor for class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Categories table row container
- Categories.A - Class in io.scanbot.genericdocument.entity
-
- Categories.A1 - Class in io.scanbot.genericdocument.entity
-
- Categories.A2 - Class in io.scanbot.genericdocument.entity
-
- Categories.B - Class in io.scanbot.genericdocument.entity
-
- Categories.B1 - Class in io.scanbot.genericdocument.entity
-
- Categories.BE - Class in io.scanbot.genericdocument.entity
-
- Categories.C - Class in io.scanbot.genericdocument.entity
-
- Categories.C1 - Class in io.scanbot.genericdocument.entity
-
- Categories.C1E - Class in io.scanbot.genericdocument.entity
-
- Categories.CE - Class in io.scanbot.genericdocument.entity
-
- Categories.Companion - Class in io.scanbot.genericdocument.entity
-
- Categories.D - Class in io.scanbot.genericdocument.entity
-
- Categories.D1 - Class in io.scanbot.genericdocument.entity
-
- Categories.D1E - Class in io.scanbot.genericdocument.entity
-
- Categories.DE - Class in io.scanbot.genericdocument.entity
-
- Categories.L - Class in io.scanbot.genericdocument.entity
-
- Categories.M - Class in io.scanbot.genericdocument.entity
-
- Categories.T - Class in io.scanbot.genericdocument.entity
-
- Category(document) - Constructor for class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Category
-
A category row from the categories table
- Category.Companion - Class in io.scanbot.genericdocument.entity
-
- Category.FieldNames - Class in io.scanbot.genericdocument.entity
-
- Category.NormalizedFieldNames - Class in io.scanbot.genericdocument.entity
-
- CE(document) - Constructor for class io.scanbot.genericdocument.entity.Categories.CE
-
- CE.Companion - Class in io.scanbot.genericdocument.entity
-
- CHECK_DIGIT - Static variable in class io.scanbot.genericdocument.entity.MRZ.FieldNames
-
Field type name of the "CheckDigit" document field.
- CHECK_DIGIT - Static variable in class io.scanbot.genericdocument.entity.MRZ.NormalizedFieldNames
-
Normalized field type name of the "CheckDigit" document field.
- childByDocumentType(name) - Method in class io.scanbot.genericdocument.entity.GenericDocument
-
Returns a sub-document given its document type name. Returns null if not found.
- CommonFieldType - Enum in io.scanbot.genericdocument.entity
-
Common field types
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.A
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.A1
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.A2
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.B
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.B1
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.BE
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.C
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.C1
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.C1E
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.CE
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.D
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.D1
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.D1E
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.DE
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.L
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.M
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.Categories.T
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Category
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseBack
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.DeIdCardBack
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.DeIdCardFront
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.DePassport
-
- Companion - Static variable in class io.scanbot.genericdocument.entity.MRZ
-
- Companion - Static variable in enum io.scanbot.genericdocument.entity.RootDocumentType
-
- component1() - Method in class io.scanbot.genericdocument.entity.DocumentProperties
-
the friendly display name of a document in English.
- component1() - Method in class io.scanbot.genericdocument.entity.Field
-
the type of the field.
- component1() - Method in class io.scanbot.genericdocument.entity.Field.Type
-
Local field type name scoped to the containing document type
- component1() - Method in class io.scanbot.genericdocument.entity.FieldProperties
-
the friendly display name of a field in English.
- component1() - Method in class io.scanbot.genericdocument.entity.GenericDocument
-
document type
- component1() - Method in class io.scanbot.genericdocument.entity.GenericDocument.Type
-
Local document type name
- component1() - Method in class io.scanbot.genericdocument.entity.OcrResult
-
recognized text
- component2() - Method in class io.scanbot.genericdocument.entity.Field
-
optional value of the field.
- component2() - Method in class io.scanbot.genericdocument.entity.Field.Type
-
Unique global field type name prefixed with the document types of all containing documents
- component2() - Method in class io.scanbot.genericdocument.entity.FieldProperties
-
the default display state of a field in the RTU UI,
- component2() - Method in class io.scanbot.genericdocument.entity.GenericDocument
-
a list of document fields
- component2() - Method in class io.scanbot.genericdocument.entity.GenericDocument.Type
-
Unique global document type name prefixed with the document types of all containing documents
- component2() - Method in class io.scanbot.genericdocument.entity.OcrResult
-
confidence in result accuracy.
- component3() - Method in class io.scanbot.genericdocument.entity.Field
-
image crop of the field.
- component3() - Method in class io.scanbot.genericdocument.entity.Field.Type
-
Normalized global field type name.
- component3() - Method in class io.scanbot.genericdocument.entity.GenericDocument
-
a list of sub-documents
- component3() - Method in class io.scanbot.genericdocument.entity.GenericDocument.Type
-
Normalized global document type name.
- component4() - Method in class io.scanbot.genericdocument.entity.Field
-
field validation status.
- component4() - Method in class io.scanbot.genericdocument.entity.Field.Type
-
optional common field type.
- component4() - Method in class io.scanbot.genericdocument.entity.GenericDocument
-
the average confidence in the accuracy of the document recognition result
- component5() - Method in class io.scanbot.genericdocument.entity.GenericDocument
-
the weight of the confidence.
- copy(defaultDisplayText) - Method in class io.scanbot.genericdocument.entity.DocumentProperties
-
Document metadata container
- copy(type, value, image, validationStatus) - Method in class io.scanbot.genericdocument.entity.Field
-
Document field.
- copy(name, fullName, normalizedName, commonType) - Method in class io.scanbot.genericdocument.entity.Field.Type
-
Field type
- copy(defaultDisplayText, defaultDisplayState) - Method in class io.scanbot.genericdocument.entity.FieldProperties
-
Field metadata container.
- copy(type, fields, children, confidence, confidenceWeight) - Method in class io.scanbot.genericdocument.entity.GenericDocument
-
A generic document. Contains fields and sub-documents.
- copy(name, fullName, normalizedName) - Method in class io.scanbot.genericdocument.entity.GenericDocument.Type
-
Document type
- copy(text, confidence) - Method in class io.scanbot.genericdocument.entity.OcrResult
-
Result of OCR text recognition.
- COUNTRY_CODE - Static variable in class io.scanbot.genericdocument.entity.DePassport.FieldNames
-
Field type name of the "CountryCode" document field.
- COUNTRY_CODE - Static variable in class io.scanbot.genericdocument.entity.DePassport.NormalizedFieldNames
-
Normalized field type name of the "CountryCode" document field.
- D(document) - Constructor for class io.scanbot.genericdocument.entity.Categories.D
-
- D.Companion - Class in io.scanbot.genericdocument.entity
-
- D1(document) - Constructor for class io.scanbot.genericdocument.entity.Categories.D1
-
- D1.Companion - Class in io.scanbot.genericdocument.entity
-
- D1E(document) - Constructor for class io.scanbot.genericdocument.entity.Categories.D1E
-
- D1E.Companion - Class in io.scanbot.genericdocument.entity
-
- DE(document) - Constructor for class io.scanbot.genericdocument.entity.Categories.DE
-
- DE.Companion - Class in io.scanbot.genericdocument.entity
-
- DeDriverLicenseBack - Class in io.scanbot.genericdocument.entity
-
German driver license (Führerschein), backside
- DeDriverLicenseBack(document) - Constructor for class io.scanbot.genericdocument.entity.DeDriverLicenseBack
-
German driver license (Führerschein), backside
- DeDriverLicenseBack.Categories - Class in io.scanbot.genericdocument.entity
-
Categories table row container
- DeDriverLicenseBack.Category - Class in io.scanbot.genericdocument.entity
-
A category row from the categories table
- DeDriverLicenseBack.Companion - Class in io.scanbot.genericdocument.entity
-
- DeDriverLicenseBack.FieldNames - Class in io.scanbot.genericdocument.entity
-
- DeDriverLicenseBack.NormalizedFieldNames - Class in io.scanbot.genericdocument.entity
-
- DeDriverLicenseFront - Class in io.scanbot.genericdocument.entity
-
German driver license (Führerschein), front side
- DeDriverLicenseFront(document) - Constructor for class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
German driver license (Führerschein), front side
- DeDriverLicenseFront.Companion - Class in io.scanbot.genericdocument.entity
-
- DeDriverLicenseFront.FieldNames - Class in io.scanbot.genericdocument.entity
-
- DeDriverLicenseFront.NormalizedFieldNames - Class in io.scanbot.genericdocument.entity
-
- DeIdCardBack - Class in io.scanbot.genericdocument.entity
-
German ID card, back side
- DeIdCardBack(document) - Constructor for class io.scanbot.genericdocument.entity.DeIdCardBack
-
German ID card, back side
- DeIdCardBack.Companion - Class in io.scanbot.genericdocument.entity
-
- DeIdCardBack.FieldNames - Class in io.scanbot.genericdocument.entity
-
- DeIdCardBack.NormalizedFieldNames - Class in io.scanbot.genericdocument.entity
-
- DeIdCardFront - Class in io.scanbot.genericdocument.entity
-
German ID card, front side
- DeIdCardFront(document) - Constructor for class io.scanbot.genericdocument.entity.DeIdCardFront
-
German ID card, front side
- DeIdCardFront.Companion - Class in io.scanbot.genericdocument.entity
-
- DeIdCardFront.FieldNames - Class in io.scanbot.genericdocument.entity
-
- DeIdCardFront.NormalizedFieldNames - Class in io.scanbot.genericdocument.entity
-
- DePassport - Class in io.scanbot.genericdocument.entity
-
German travel passport (Reisepass)
- DePassport(document) - Constructor for class io.scanbot.genericdocument.entity.DePassport
-
German travel passport (Reisepass)
- DePassport.Companion - Class in io.scanbot.genericdocument.entity
-
- DePassport.FieldNames - Class in io.scanbot.genericdocument.entity
-
- DePassport.NormalizedFieldNames - Class in io.scanbot.genericdocument.entity
-
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.A
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.A1
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.A2
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.B
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.B1
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.BE
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.C
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.C1
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.C1E
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.CE
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.D
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.D1
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.D1E
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.DE
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.L
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.M
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.T
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseBack
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.DeIdCardBack
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.DeIdCardFront
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.DePassport
-
Normalized document type name of this document wrapper.
- DOCUMENT_NORMALIZED_TYPE - Static variable in class io.scanbot.genericdocument.entity.MRZ
-
Normalized document type name of this document wrapper.
- DOCUMENT_NUMBER - Static variable in class io.scanbot.genericdocument.entity.MRZ.FieldNames
-
Field type name of the "DocumentNumber" document field.
- DOCUMENT_NUMBER - Static variable in class io.scanbot.genericdocument.entity.MRZ.NormalizedFieldNames
-
Normalized field type name of the "DocumentNumber" document field.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.A
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.A1
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.A2
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.B
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.B1
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.BE
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.C
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.C1
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.C1E
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.CE
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.D
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.D1
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.D1E
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.DE
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.L
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.M
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.Categories.T
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseBack
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.DeIdCardBack
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.DeIdCardFront
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.DePassport
-
Generic document type name of this document wrapper.
- DOCUMENT_TYPE - Static variable in class io.scanbot.genericdocument.entity.MRZ
-
Generic document type name of this document wrapper.
- DocumentProperties - Class in io.scanbot.genericdocument.entity
-
Document metadata container
- DocumentProperties(defaultDisplayText) - Constructor for class io.scanbot.genericdocument.entity.DocumentProperties
-
Document metadata container
- GENDER - Static variable in class io.scanbot.genericdocument.entity.DePassport.FieldNames
-
Field type name of the "Gender" document field.
- GENDER - Static variable in class io.scanbot.genericdocument.entity.DePassport.NormalizedFieldNames
-
Normalized field type name of the "Gender" document field.
- GENDER - Static variable in class io.scanbot.genericdocument.entity.MRZ.FieldNames
-
Field type name of the "Gender" document field.
- GENDER - Static variable in class io.scanbot.genericdocument.entity.MRZ.NormalizedFieldNames
-
Normalized field type name of the "Gender" document field.
- GenericDocument - Class in io.scanbot.genericdocument.entity
-
A generic document. Contains fields and sub-documents.
- GenericDocument(type, fields, children, confidence, confidenceWeight) - Constructor for class io.scanbot.genericdocument.entity.GenericDocument
-
A generic document. Contains fields and sub-documents.
- GenericDocument.Type - Class in io.scanbot.genericdocument.entity
-
Document type
- GenericDocumentLibrary - Class in io.scanbot.genericdocument.entity
-
- GenericDocumentWrapper - Class in io.scanbot.genericdocument.entity
-
Base class for strongly-typed GenericDocument wrappers
- GenericDocumentWrapper(document) - Constructor for class io.scanbot.genericdocument.entity.GenericDocumentWrapper
-
Base class for strongly-typed GenericDocument wrappers
- getA() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the A sub-document.
- getA1() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the A1 sub-document.
- getA2() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the A2 sub-document.
- getAddress() - Method in class io.scanbot.genericdocument.entity.DeIdCardBack
-
Address
- getALL_TYPES() - Method in class io.scanbot.genericdocument.entity.RootDocumentType.Companion
-
List of all enum values
- getB() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the B sub-document.
- getB1() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the B1 sub-document.
- getBe() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the BE sub-document.
- getBirthDate() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
Birth date
- getBirthDate() - Method in class io.scanbot.genericdocument.entity.DeIdCardFront
-
Birth date
- getBirthDate() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Birth date
- getBirthDate() - Method in class io.scanbot.genericdocument.entity.MRZ
-
Birth date
- getBirthplace() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
Birthplace
- getBirthplace() - Method in class io.scanbot.genericdocument.entity.DeIdCardFront
-
Birthplace
- getBirthplace() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Birthplace
- getC() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the C sub-document.
- getC1() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the C1 sub-document.
- getC1e() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the C1E sub-document.
- getCategories() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack
-
Contains the Categories sub-document.
- getCe() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the CE sub-document.
- getCheckDigits() - Method in class io.scanbot.genericdocument.entity.MRZ
-
Check digit
- getChildren() - Method in class io.scanbot.genericdocument.entity.GenericDocument
-
a list of sub-documents
- getCommonType() - Method in class io.scanbot.genericdocument.entity.Field.Type
-
optional common field type.
- getConfidence() - Method in class io.scanbot.genericdocument.entity.GenericDocument
-
the average confidence in the accuracy of the document recognition result
- getConfidence() - Method in class io.scanbot.genericdocument.entity.OcrResult
-
confidence in result accuracy.
- getConfidenceWeight() - Method in class io.scanbot.genericdocument.entity.GenericDocument
-
the weight of the confidence.
- getCountryCode() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Country code
- getD() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the D sub-document.
- getD1() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the D1 sub-document.
- getD1e() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the D1E sub-document.
- getDe() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the DE sub-document.
- getDefaultDisplayState() - Method in class io.scanbot.genericdocument.entity.FieldProperties
-
the default display state of a field in the RTU UI,
- getDefaultDisplayText() - Method in class io.scanbot.genericdocument.entity.DocumentProperties
-
the friendly display name of a document in English.
- getDefaultDisplayText() - Method in class io.scanbot.genericdocument.entity.FieldProperties
-
the friendly display name of a field in English.
- getDocProps() - Method in class io.scanbot.genericdocument.entity.ModelConstants
-
Default document display properties containing English translation
- getDocument() - Method in class io.scanbot.genericdocument.entity.GenericDocumentWrapper
-
- getDocumentNumber() - Method in class io.scanbot.genericdocument.entity.MRZ
-
Document number
- getExpiryDate() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
Expiry date
- getExpiryDate() - Method in class io.scanbot.genericdocument.entity.DeIdCardFront
-
Expiry date
- getExpiryDate() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Expiry date
- getExpiryDate() - Method in class io.scanbot.genericdocument.entity.MRZ
-
Expiry date
- getEyeColor() - Method in class io.scanbot.genericdocument.entity.DeIdCardBack
-
Eye color
- getFieldProps() - Method in class io.scanbot.genericdocument.entity.ModelConstants
-
Default field display properties containing visibility and English translation
- getFields() - Method in class io.scanbot.genericdocument.entity.GenericDocument
-
a list of document fields
- getFullName() - Method in class io.scanbot.genericdocument.entity.Field.Type
-
Unique global field type name prefixed with the document types of all containing documents
- getFullName() - Method in class io.scanbot.genericdocument.entity.GenericDocument.Type
-
Unique global document type name prefixed with the document types of all containing documents
- getGender() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Gender
- getGender() - Method in class io.scanbot.genericdocument.entity.MRZ
-
Gender
- getGivenNames() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
Given names
- getGivenNames() - Method in class io.scanbot.genericdocument.entity.DeIdCardFront
-
Given names
- getGivenNames() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Given names
- getGivenNames() - Method in class io.scanbot.genericdocument.entity.MRZ
-
Given names
- getHeight() - Method in class io.scanbot.genericdocument.entity.DeIdCardBack
-
Height
- getId() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
Document ID number (in the top-right corner).
- getId() - Method in class io.scanbot.genericdocument.entity.DeIdCardFront
-
Document ID number (in the top-right corner)
- getId() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Document ID number (in the top-right corner).
- getImage() - Method in class io.scanbot.genericdocument.entity.Field
-
image crop of the field.
- getImage() - Method in class io.scanbot.genericdocument.entity.FieldWrapper
-
Field image crop
- getIssueDate() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
Issue date
- getIssueDate() - Method in class io.scanbot.genericdocument.entity.DeIdCardBack
-
Issue date
- getIssueDate() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Issue date
- getIssuingAuthority() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
Issuing authority
- getIssuingAuthority() - Method in class io.scanbot.genericdocument.entity.DeIdCardBack
-
Issuing authority
- getIssuingAuthority() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Issuing authority
- getIssuingAuthority() - Method in class io.scanbot.genericdocument.entity.MRZ
-
Issuing authority
- getL() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the L sub-document.
- getLicenseCategories() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
Driver's license categories
- getM() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the M sub-document.
- getMaidenName() - Method in class io.scanbot.genericdocument.entity.DeIdCardFront
-
Maiden name
- getMaidenName() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Maiden name
- getMrz() - Method in class io.scanbot.genericdocument.entity.DeIdCardBack
-
Contains the MRZ sub-document.
- getMrz() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Contains the MRZ sub-document.
- getName() - Method in class io.scanbot.genericdocument.entity.Field.Type
-
Local field type name scoped to the containing document type
- getName() - Method in class io.scanbot.genericdocument.entity.GenericDocument.Type
-
Local document type name
- getNationality() - Method in class io.scanbot.genericdocument.entity.DeIdCardFront
-
Nationality
- getNationality() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Nationality
- getNationality() - Method in class io.scanbot.genericdocument.entity.MRZ
-
Nationality
- getNormalizedName() - Method in class io.scanbot.genericdocument.entity.Field.Type
-
Normalized global field type name.
- getNormalizedName() - Method in class io.scanbot.genericdocument.entity.GenericDocument.Type
-
Normalized global document type name.
- getOptional1() - Method in class io.scanbot.genericdocument.entity.MRZ
-
Optional field 1
- getOptional2() - Method in class io.scanbot.genericdocument.entity.MRZ
-
Optional field 2
- getPassportType() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Passport type
- getPhoto() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
Photo image
- getPhoto() - Method in class io.scanbot.genericdocument.entity.DeIdCardFront
-
Photo image
- getPhoto() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Photo image
- getPin() - Method in class io.scanbot.genericdocument.entity.DeIdCardFront
-
PIN
- getPseudonym() - Method in class io.scanbot.genericdocument.entity.DeIdCardBack
-
Pseudonym
- getRawMRZ() - Method in class io.scanbot.genericdocument.entity.DeIdCardBack
-
Raw MRZ text value
- getRawMRZ() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Raw MRZ text value
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.A
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.A1
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.A2
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.B
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.B1
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.BE
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.C
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.C1
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.C1E
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.CE
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.D
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.D1
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.D1E
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.DE
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.L
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.M
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.Categories.T
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.DeIdCardBack
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.DeIdCardFront
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.DePassport
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.GenericDocumentWrapper
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRequiredDocumentType() - Method in class io.scanbot.genericdocument.entity.MRZ
-
The required type of the wrapped document. Null if this wrapper can wrap more than one type of document
- getRestrictions() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Category
-
Restrictions
- getRestrictions() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack
-
Restrictions applied for the driver's license
- getSignature() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
Signature image
- getSignature() - Method in class io.scanbot.genericdocument.entity.DeIdCardFront
-
Signature image
- getSignature() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Signature image
- getSurname() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseFront
-
Surname
- getSurname() - Method in class io.scanbot.genericdocument.entity.DeIdCardFront
-
Surname
- getSurname() - Method in class io.scanbot.genericdocument.entity.DePassport
-
Surname
- getSurname() - Method in class io.scanbot.genericdocument.entity.MRZ
-
Surname
- getT() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Categories
-
Contains the T sub-document.
- getText() - Method in class io.scanbot.genericdocument.entity.OcrResult
-
recognized text
- getTravelDocType() - Method in class io.scanbot.genericdocument.entity.MRZ
-
Travel document type
- getTravelDocTypeVariant() - Method in class io.scanbot.genericdocument.entity.MRZ
-
Travel document type variant
- getType() - Method in class io.scanbot.genericdocument.entity.Field
-
the type of the field.
- getType() - Method in class io.scanbot.genericdocument.entity.FieldWrapper
-
Field type
- getType() - Method in class io.scanbot.genericdocument.entity.GenericDocument
-
document type
- getType() - Method in enum io.scanbot.genericdocument.entity.RootDocumentType
-
- getValidationStatus() - Method in class io.scanbot.genericdocument.entity.Field
-
field validation status.
- getValidFrom() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Category
-
Valid from
- getValidUntil() - Method in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.Category
-
Valid until
- getValue() - Method in class io.scanbot.genericdocument.entity.Field
-
optional value of the field.
- getValue() - Method in class io.scanbot.genericdocument.entity.TextFieldWrapper
-
Field text value
- GIVEN_NAMES - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseFront.FieldNames
-
Field type name of the "GivenNames" document field.
- GIVEN_NAMES - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseFront.NormalizedFieldNames
-
Normalized field type name of the "GivenNames" document field.
- GIVEN_NAMES - Static variable in class io.scanbot.genericdocument.entity.DeIdCardFront.FieldNames
-
Field type name of the "GivenNames" document field.
- GIVEN_NAMES - Static variable in class io.scanbot.genericdocument.entity.DeIdCardFront.NormalizedFieldNames
-
Normalized field type name of the "GivenNames" document field.
- GIVEN_NAMES - Static variable in class io.scanbot.genericdocument.entity.DePassport.FieldNames
-
Field type name of the "GivenNames" document field.
- GIVEN_NAMES - Static variable in class io.scanbot.genericdocument.entity.DePassport.NormalizedFieldNames
-
Normalized field type name of the "GivenNames" document field.
- GIVEN_NAMES - Static variable in class io.scanbot.genericdocument.entity.MRZ.FieldNames
-
Field type name of the "GivenNames" document field.
- GIVEN_NAMES - Static variable in class io.scanbot.genericdocument.entity.MRZ.NormalizedFieldNames
-
Normalized field type name of the "GivenNames" document field.
- ID - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseFront.FieldNames
-
Field type name of the "ID" document field.
- ID - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseFront.NormalizedFieldNames
-
Normalized field type name of the "ID" document field.
- ID - Static variable in class io.scanbot.genericdocument.entity.DeIdCardFront.FieldNames
-
Field type name of the "ID" document field.
- ID - Static variable in class io.scanbot.genericdocument.entity.DeIdCardFront.NormalizedFieldNames
-
Normalized field type name of the "ID" document field.
- ID - Static variable in class io.scanbot.genericdocument.entity.DePassport.FieldNames
-
Field type name of the "ID" document field.
- ID - Static variable in class io.scanbot.genericdocument.entity.DePassport.NormalizedFieldNames
-
Normalized field type name of the "ID" document field.
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.Category.FieldNames
-
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.Category.NormalizedFieldNames
-
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.FieldNames
-
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseBack.NormalizedFieldNames
-
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseFront.FieldNames
-
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseFront.NormalizedFieldNames
-
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.DeIdCardBack.FieldNames
-
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.DeIdCardBack.NormalizedFieldNames
-
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.DeIdCardFront.FieldNames
-
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.DeIdCardFront.NormalizedFieldNames
-
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.DePassport.FieldNames
-
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.DePassport.NormalizedFieldNames
-
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.GenericDocumentLibrary
-
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.ModelConstants
-
Default field and document display properties containing visibility and English translation
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.MRZ.FieldNames
-
- INSTANCE - Static variable in class io.scanbot.genericdocument.entity.MRZ.NormalizedFieldNames
-
- io.scanbot.genericdocument.entity - package io.scanbot.genericdocument.entity
-
- ISSUE_DATE - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseFront.FieldNames
-
Field type name of the "IssueDate" document field.
- ISSUE_DATE - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseFront.NormalizedFieldNames
-
Normalized field type name of the "IssueDate" document field.
- ISSUE_DATE - Static variable in class io.scanbot.genericdocument.entity.DeIdCardBack.FieldNames
-
Field type name of the "IssueDate" document field.
- ISSUE_DATE - Static variable in class io.scanbot.genericdocument.entity.DeIdCardBack.NormalizedFieldNames
-
Normalized field type name of the "IssueDate" document field.
- ISSUE_DATE - Static variable in class io.scanbot.genericdocument.entity.DePassport.FieldNames
-
Field type name of the "IssueDate" document field.
- ISSUE_DATE - Static variable in class io.scanbot.genericdocument.entity.DePassport.NormalizedFieldNames
-
Normalized field type name of the "IssueDate" document field.
- ISSUING_AUTHORITY - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseFront.FieldNames
-
Field type name of the "IssuingAuthority" document field.
- ISSUING_AUTHORITY - Static variable in class io.scanbot.genericdocument.entity.DeDriverLicenseFront.NormalizedFieldNames
-
Normalized field type name of the "IssuingAuthority" document field.
- ISSUING_AUTHORITY - Static variable in class io.scanbot.genericdocument.entity.DeIdCardBack.FieldNames
-
Field type name of the "IssuingAuthority" document field.
- ISSUING_AUTHORITY - Static variable in class io.scanbot.genericdocument.entity.DeIdCardBack.NormalizedFieldNames
-
Normalized field type name of the "IssuingAuthority" document field.
- ISSUING_AUTHORITY - Static variable in class io.scanbot.genericdocument.entity.DePassport.FieldNames
-
Field type name of the "IssuingAuthority" document field.
- ISSUING_AUTHORITY - Static variable in class io.scanbot.genericdocument.entity.DePassport.NormalizedFieldNames
-
Normalized field type name of the "IssuingAuthority" document field.
- ISSUING_AUTHORITY - Static variable in class io.scanbot.genericdocument.entity.MRZ.FieldNames
-
Field type name of the "IssuingAuthority" document field.
- ISSUING_AUTHORITY - Static variable in class io.scanbot.genericdocument.entity.MRZ.NormalizedFieldNames
-
Normalized field type name of the "IssuingAuthority" document field.
- isValid() - Method in class io.scanbot.genericdocument.entity.ValidatedTextFieldWrapper
-
True if the field value passes validation, otherwise false.