Package com.regula.documentreader.api.results

Class DocumentReaderValue

java.lang.Object

com.regula.documentreader.api.results.DocumentReaderValue

public class DocumentReaderValue
extends java.lang.Object

structure describing single value of the field

Field Summary

Fields

Modifier and Type	Field	Description
Rect	boundRect	bounds result of the particular value
java.util.Map<java.lang.Integer,java.lang.Integer>	comparison	Deprecated.
DocumentReaderTextField	field	current text field DocumentReaderTextField
java.util.List<DocumentReaderSymbol>	originalSymbols	list of all symbols for this value
java.lang.String	originalValue	unformatted value as it was on the source
int	pageIndex
int	probability
DocumentReaderRfidOrigin	rfidOrigin	the field is available only for the 'rfid' source
int	sourceType	one of eRPRM_ResultType values indicating the value's origin source
int	validity	Deprecated.
java.lang.String	value	Lexical Analysis formatted value

Constructor Summary

Constructors

Constructor	Description
DocumentReaderValue()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

field

public DocumentReaderTextField field

current text field DocumentReaderTextField

sourceType

public int sourceType

one of eRPRM_ResultType values indicating the value's origin source

value

public java.lang.String value

Lexical Analysis formatted value

originalValue

public java.lang.String originalValue

unformatted value as it was on the source

pageIndex

public int pageIndex

boundRect

public Rect boundRect

bounds result of the particular value

rfidOrigin

public DocumentReaderRfidOrigin rfidOrigin

the field is available only for the 'rfid' source

validity

@Deprecated
public int validity

Deprecated.

one of eRPRM_FieldVerificationResult values, indicating verification result of this particular value Since version 6.6 validity is deprecated. Use DocumentReaderTextField.validityList

originalSymbols

public java.util.List<DocumentReaderSymbol> originalSymbols

list of all symbols for this value

comparison

@Deprecated
public java.util.Map<java.lang.Integer,java.lang.Integer> comparison

Deprecated.

comparison results with another values of same type key is one of eRPRM_ResultType values value is one of eRPRM_FieldVerificationResult values. Since version 6.6 comparison is deprecated. Use DocumentReaderTextField.comparisonList

probability

public int probability

Constructor Detail

DocumentReaderValue

public DocumentReaderValue()