Package io.scanbot.sdk.documentdata

Class DocumentDataExtractionResult

java.lang.Object

io.scanbot.sdk.documentdata.DocumentDataExtractionResult

All Implemented Interfaces:

java.lang.AutoCloseable

public class DocumentDataExtractionResult
extends java.lang.Object
implements java.lang.AutoCloseable

Contains the result of running the document data extractor.

Constructor Summary

Constructors

Constructor	Description
DocumentDataExtractionResult(DocumentDataExtractionStatus status, GenericDocument document, DocumentDetectionResult documentDetectionResult)	Constructs DocumentDataExtractionResult with default parameters.
DocumentDataExtractionResult(DocumentDataExtractionStatus status, GenericDocument document, DocumentDetectionResult documentDetectionResult, ImageRef croppedImage)	Constructs DocumentDataExtractionResult with the given params.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes native resources (images) held by the object.
ImageRef	getCroppedImage()	Getter for croppedImage field.
GenericDocument	getDocument()	Getter for document field.
DocumentDetectionResult	getDocumentDetectionResult()	Getter for documentDetectionResult field.
DocumentDataExtractionStatus	getStatus()	Getter for status field.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentDataExtractionResult

public DocumentDataExtractionResult(DocumentDataExtractionStatus status,
                                    GenericDocument document,
                                    DocumentDetectionResult documentDetectionResult,
                                    ImageRef croppedImage)

Constructs DocumentDataExtractionResult with the given params.

Parameters:

status - The status of the extraction process.

document - The extracted document.

documentDetectionResult - Result of the document detection in the input image.

croppedImage - Crop of the document if it was detected.

DocumentDataExtractionResult

public DocumentDataExtractionResult(DocumentDataExtractionStatus status,
                                    GenericDocument document,
                                    DocumentDetectionResult documentDetectionResult)

Constructs DocumentDataExtractionResult with default parameters.

Parameters:

status - The status of the extraction process.

document - The extracted document.

documentDetectionResult - Result of the document detection in the input image.

Method Detail

getStatus

public DocumentDataExtractionStatus getStatus()

Getter for status field. See constructor documentation for more information about the field.

Returns:

status

getDocument

public GenericDocument getDocument()

Getter for document field. See constructor documentation for more information about the field.

Returns:

document

getDocumentDetectionResult

public DocumentDetectionResult getDocumentDetectionResult()

Getter for documentDetectionResult field. See constructor documentation for more information about the field.

Returns:

documentDetectionResult

getCroppedImage

public ImageRef getCroppedImage()

Getter for croppedImage field. See constructor documentation for more information about the field.

Returns:

croppedImage

close

public void close()

Closes native resources (images) held by the object.

Specified by:

close in interface java.lang.AutoCloseable