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

Class VitruvioOCRProviderResult

Object

VitruvioOCRProviderResult

All Implemented Interfaces:

DocumentRepresentation, OCRResult

public class VitruvioOCRProviderResult
extends Object
implements OCRResult

Nested Class Summary

Nested classes/interfaces inherited from interface OCRResult

OCRResult.FieldResultStatus, OCRResult.OCRResultField

Field Summary

Fields inherited from interface DocumentRepresentation

DEFAULT_DATE_FORMAT

Fields inherited from interface OCRResult

SERVICE_SOURCE

Constructor Summary

Constructors

Constructor	Description
VitruvioOCRProviderResult(ModeloDocumentoOCR modelo, Throwable error)
VitruvioOCRProviderResult(ModeloDocumentoOCR modelo, Map<String,OCRResult.OCRResultField> results)
VitruvioOCRProviderResult(ModeloDocumentoOCR modelo, Map<String,OCRResult.OCRResultField> results, File sourceFile)

Method Summary

Modifier and Type	Method	Description
boolean	anyFieldWithError()
Throwable	getError()	Obtem o erro encontrado pelo provedor, ou null se nenhum
Map<String,DocumentFieldRepresentation>	getFieldMap()	Resultados
Collection<DocumentFieldRepresentation>	getFields()	Obtem uma colecao dos campos do documento
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
String	serviceSource()	Identifica unicamente o servico que obteve o documento
Long	store()	Solicita a persistencia do documento
Long	store(StoreOptions options)	Armazena o documento
String	toStoreRepresentation()	Gera uma representacao JSON para armazenamento do documento

Methods inherited from class Object

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

Constructor Details

VitruvioOCRProviderResult

public VitruvioOCRProviderResult(ModeloDocumentoOCR modelo,
 Map<String,OCRResult.OCRResultField> results)

VitruvioOCRProviderResult

public VitruvioOCRProviderResult(ModeloDocumentoOCR modelo,
 Map<String,OCRResult.OCRResultField> results,
 File sourceFile)

VitruvioOCRProviderResult

public VitruvioOCRProviderResult(ModeloDocumentoOCR modelo,
 Throwable error)

Method Details

serviceSource

public String serviceSource()

Description copied from interface: DocumentRepresentation

Identifica unicamente o servico que obteve o documento

Specified by:

serviceSource in interface DocumentRepresentation

Returns:

providerId

public String providerId()

Description copied from interface: OCRResult

Provedor OCR que interpretou os resultados

Specified by:

providerId in interface OCRResult

Returns:

getModeloOCR

public ModeloDocumentoOCR getModeloOCR()

Description copied from interface: OCRResult

Modelo de documento que foi identificado na leitura

Specified by:

getModeloOCR in interface OCRResult

Returns:

getResults

public Map<String,OCRResult.OCRResultField> getResults()

Description copied from interface: OCRResult

Resultados

Specified by:

getResults in interface OCRResult

Returns:

getFieldMap

public Map<String,DocumentFieldRepresentation> getFieldMap()

Description copied from interface: DocumentRepresentation

Resultados

Specified by:

getFieldMap in interface DocumentRepresentation

Returns:

getFields

public Collection<DocumentFieldRepresentation> getFields()

Description copied from interface: DocumentRepresentation

Obtem uma colecao dos campos do documento

Specified by:

getFields in interface DocumentRepresentation

Returns:

isEmpty

public boolean isEmpty()

Description copied from interface: OCRResult

Determina se nenhum campo foi coletado para este modelo

Specified by:

isEmpty in interface OCRResult

Returns:

anyFieldWithError

public boolean anyFieldWithError()

Specified by:

anyFieldWithError in interface OCRResult

isError

public boolean isError()

Description copied from interface: OCRResult

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

Specified by:

isError in interface OCRResult

Returns:

getError

public Throwable getError()

Description copied from interface: OCRResult

Obtem o erro encontrado pelo provedor, ou null se nenhum

Specified by:

getError in interface OCRResult

Returns:

toStoreRepresentation

public String toStoreRepresentation()

Description copied from interface: DocumentRepresentation

Gera uma representacao JSON para armazenamento do documento

Specified by:

toStoreRepresentation in interface DocumentRepresentation

Returns:

getSourceFile

public File getSourceFile()

Description copied from interface: OCRResult

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

Specified by:

getSourceFile in interface OCRResult

Returns:

store

public Long store()

Description copied from interface: DocumentRepresentation

Solicita a persistencia do documento

Specified by:

store in interface DocumentRepresentation

Returns:

store

public Long store(StoreOptions options)

Description copied from interface: OCRResult

Armazena o documento

Specified by:

store in interface OCRResult

Parameters:

options - // Opcoes de armazenamento

Returns: