Package io.scanbot.sdk.check

Class CheckScanningResult

java.lang.Object

io.scanbot.sdk.check.CheckScanningResult

All Implemented Interfaces:

AutoCloseable

public class CheckScanningResult
extends Object
implements AutoCloseable

The result of check scanning.

Constructor Summary

Constructors

Constructor	Description
CheckScanningResult(CheckMagneticInkStripScanningStatus status, GenericDocument check, DocumentDetectionResult documentDetectionResult, ImageRef croppedImage)	Constructs CheckScanningResult with the given params.
CheckScanningResult(GenericDocument check, DocumentDetectionResult documentDetectionResult)	Constructs CheckScanningResult with default parameters.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

CheckScanningResult

public CheckScanningResult(CheckMagneticInkStripScanningStatus status,
 GenericDocument check,
 DocumentDetectionResult documentDetectionResult,
 ImageRef croppedImage)

Constructs CheckScanningResult with the given params.

Parameters:

status - Magnetic ink strip scanning status. Default is `ERROR_NOTHING_FOUND`.

check - Generic document containing check data. Not present, if status is FAIL.

documentDetectionResult - The result of document detection. Will be set only if detectDocument in the configuration is set to true. Check scanning may still succeed even if the whole document is not visible in the input image and the complete document could not be located.

croppedImage - Crop of the check if documentDetectionMode is set to DETECT_AND_CROP_DOCUMENT. Will be non-empty, only if check recognition succeeded.

CheckScanningResult

public CheckScanningResult(GenericDocument check,
 DocumentDetectionResult documentDetectionResult)

Constructs CheckScanningResult with default parameters.

Parameters:

check - Generic document containing check data. Not present, if status is FAIL.

documentDetectionResult - The result of document detection. Will be set only if detectDocument in the configuration is set to true. Check scanning may still succeed even if the whole document is not visible in the input image and the complete document could not be located.

Method Details

getStatus

public CheckMagneticInkStripScanningStatus getStatus()

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

Returns:

status

getCheck

public GenericDocument getCheck()

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

Returns:

check

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 AutoCloseable