Package br.com.davinti.vitruvio.spi.documento.ocr

Interface OCRResult

All Superinterfaces:

DocumentRepresentation

All Known Implementing Classes:

VitruvioOCRProviderResult

public interface OCRResult
extends DocumentRepresentation

Resultado da leitura de um provedor

Author:

Eduardo Frazao

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	OCRResult.FieldResultStatus	Status da leitura do campo
static interface	OCRResult.OCRResultField	Resultado da leitura de um campo especifico de um documento

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_SOURCE

Fields inherited from interface DocumentRepresentation

DEFAULT_DATE_FORMAT

Method Summary

Modifier and Type	Method	Description
boolean	anyFieldWithError()
Throwable	getError()	Obtem o erro encontrado pelo provedor, ou null se nenhum
ModeloDocumentoOCR	getModeloOCR()	Modelo de documento que foi identificado na leitura
Map<String,OCRResult.OCRResultField>	getResults()	Resultados
File	getSourceFile()	Obtem o arquivo de origem relacionado a este resultado (opcional)
boolean	isEmpty()	Determina se nenhum campo foi coletado para este modelo
boolean	isError()	Determina se nao foi possivel coletar os resultados para este modelo especifico Se este campo retornar TRUE nenhum resultado deve ser considerado para esta leitura
String	providerId()	Provedor OCR que interpretou os resultados
Long	store(StoreOptions options)	Armazena o documento

Methods inherited from interface DocumentRepresentation

getFieldMap, getFields, serviceSource, store, toStoreRepresentation

Field Details

SERVICE_SOURCE

static final String SERVICE_SOURCE

See Also:

• Constant Field Values

Method Details

getModeloOCR

ModeloDocumentoOCR getModeloOCR()

Modelo de documento que foi identificado na leitura

Returns:

providerId

String providerId()

Provedor OCR que interpretou os resultados

Returns:

getResults

Map<String,OCRResult.OCRResultField> getResults()

Resultados

Returns:

isEmpty

boolean isEmpty()

Determina se nenhum campo foi coletado para este modelo

Returns:

isError

boolean isError()

Determina se nao foi possivel coletar os resultados para este modelo especifico Se este campo retornar TRUE nenhum resultado deve ser considerado para esta leitura

Returns:

getError

Throwable getError()

Obtem o erro encontrado pelo provedor, ou null se nenhum

Returns:

anyFieldWithError

boolean anyFieldWithError()

getSourceFile

File getSourceFile()

Obtem o arquivo de origem relacionado a este resultado (opcional)

Returns:

store

Long store(StoreOptions options)

Armazena o documento

Parameters:

options - // Opcoes de armazenamento

Returns: