Package io.scanbot.sdk.documentclassifier

Class DocumentClassifierResult

java.lang.Object

io.scanbot.sdk.documentclassifier.DocumentClassifierResult

All Implemented Interfaces:

java.lang.AutoCloseable

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

Contains the result of running the document classifier.

Constructor Summary

Constructors

Constructor	Description
DocumentClassifierResult(DocumentType documentType, double confidence, DocumentClassifierStatus status, DocumentScanningResult documentScanningResult)	Constructs DocumentClassifierResult with the given params.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes native resources (images) held by the object.
double	getConfidence()	Getter for confidence field.
DocumentScanningResult	getDocumentScanningResult()	Getter for documentScanningResult field.
DocumentType	getDocumentType()	Getter for documentType field.
DocumentClassifierStatus	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

DocumentClassifierResult

public DocumentClassifierResult(DocumentType documentType,
                                double confidence,
                                DocumentClassifierStatus status,
                                DocumentScanningResult documentScanningResult)

Constructs DocumentClassifierResult with the given params.

Parameters:

documentType - The classification result.

confidence - The confidence of the classification result.

status - The status of the classification result.

documentScanningResult - The result of the document scanning.

Method Detail

getDocumentType

public DocumentType getDocumentType()

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

Returns:

documentType

getConfidence

public double getConfidence()

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

Returns:

confidence

getStatus

public DocumentClassifierStatus getStatus()

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

Returns:

status

getDocumentScanningResult

public DocumentScanningResult getDocumentScanningResult()

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

Returns:

documentScanningResult

close

public void close()

Closes native resources (images) held by the object.

Specified by:

close in interface java.lang.AutoCloseable