Class DocumentReaderTextField
- java.lang.Object
-
- com.regula.documentreader.api.results.DocumentReaderTextField
-
public class DocumentReaderTextField extends java.lang.Object
serves for storing information from one text data field.
-
-
Field Summary
Fields Modifier and Type Field Description java.util.List<DocumentReaderComparison>
comparisonList
list of all comparison statuses for this field typeint
comparisonStatus
one ofeCheckResult
values, indicating comparison result of the fieldint
fieldType
one ofeVisualFieldType
values, indicating type of the fieldint
lcid
ID of language-culture to differentiate one field of the same type from another (for example Belarus Passport Page # 31 – Belarusian and Russian fields of the same type) one ofLCID
values, indicating type of the fieldint
status
one ofeCheckResult
values, indicating verification result of the fieldjava.util.List<DocumentReaderValidity>
validityList
list of all validity statuses for this field typeint
validityStatus
one ofeCheckResult
values, indicating validity result of the fieldjava.lang.String
value
value from the fieldjava.util.List<DocumentReaderValue>
values
list of all values of the same field type
-
Constructor Summary
Constructors Constructor Description DocumentReaderTextField()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getFieldName(Context context)
field symbolic namejava.lang.String
getLcidName(Context context)
DocumentReaderValue
value()
Returns value of first found source by priority mrz - rfid - barcode - visualDocumentReaderValue
value(int sourceType)
Returns value of source specified
-
-
-
Field Detail
-
fieldType
public int fieldType
one ofeVisualFieldType
values, indicating type of the field
-
lcid
public int lcid
ID of language-culture to differentiate one field of the same type from another (for example Belarus Passport Page # 31 – Belarusian and Russian fields of the same type) one ofLCID
values, indicating type of the field
-
values
public java.util.List<DocumentReaderValue> values
list of all values of the same field type
-
comparisonList
public java.util.List<DocumentReaderComparison> comparisonList
list of all comparison statuses for this field type
-
validityList
public java.util.List<DocumentReaderValidity> validityList
list of all validity statuses for this field type
-
value
public java.lang.String value
value from the field
-
status
public int status
one ofeCheckResult
values, indicating verification result of the field
-
comparisonStatus
public int comparisonStatus
one ofeCheckResult
values, indicating comparison result of the field
-
validityStatus
public int validityStatus
one ofeCheckResult
values, indicating validity result of the field
-
-
Method Detail
-
getFieldName
public java.lang.String getFieldName(Context context)
field symbolic name
-
getLcidName
public java.lang.String getLcidName(Context context)
-
value
public DocumentReaderValue value()
Returns value of first found source by priority mrz - rfid - barcode - visual- Returns:
- value or null
-
value
public DocumentReaderValue value(int sourceType)
Returns value of source specified- Parameters:
sourceType
- one of @eRPRM_ResultType.ResultTypeValues- Returns:
- value or null
-
-