Package io.scanbot.sdk.documentqualityanalyzer

Class DocumentQualityAnalyzerCompatibilityModeConfiguration

java.lang.Object

io.scanbot.sdk.documentqualityanalyzer.DocumentQualityAnalyzerCompatibilityModeConfiguration

public class DocumentQualityAnalyzerCompatibilityModeConfiguration
extends Object

Configuration for the compatibility mode of the Document Quality Analyzer. In this mode, the analyzer will return results that are identical to older versions of the SDK.

Constructor Summary

Constructors

Constructor	Description
DocumentQualityAnalyzerCompatibilityModeConfiguration()	Constructs DocumentQualityAnalyzerCompatibilityModeConfiguration with default parameters.
DocumentQualityAnalyzerCompatibilityModeConfiguration(DocumentQualityAnalyzerCompatibilityMode mode, DocumentQuality minimumAcceptableQuality, DocumentQuality minimumUncertainQuality, boolean inspectSmallText)	Constructs DocumentQualityAnalyzerCompatibilityModeConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
boolean	getInspectSmallText()	Getter for inspectSmallText field.
DocumentQuality	getMinimumAcceptableQuality()	Getter for minimumAcceptableQuality field.
DocumentQuality	getMinimumUncertainQuality()	Getter for minimumUncertainQuality field.
DocumentQualityAnalyzerCompatibilityMode	getMode()	Getter for mode field.
void	setInspectSmallText(boolean inspectSmallText)	Setter for inspectSmallText field.
void	setMinimumAcceptableQuality(DocumentQuality minimumAcceptableQuality)	Setter for minimumAcceptableQuality field.
void	setMinimumUncertainQuality(DocumentQuality minimumUncertainQuality)	Setter for minimumUncertainQuality field.

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentQualityAnalyzerCompatibilityModeConfiguration

public DocumentQualityAnalyzerCompatibilityModeConfiguration(DocumentQualityAnalyzerCompatibilityMode mode,
 DocumentQuality minimumAcceptableQuality,
 DocumentQuality minimumUncertainQuality,
 boolean inspectSmallText)

Constructs DocumentQualityAnalyzerCompatibilityModeConfiguration with the given params.

Parameters:

mode - Compatibility mode to use. Default is `V8`.

minimumAcceptableQuality - This setting describes how the Document Quality Analyzer in v8 compatibility mode will behave. Minimum compatibility-mode quality that gets converted to DocumentQualityAssessment.ACCEPTABLE. Compatibility-mode quality levels equal to or higher than `minimumAcceptableQuality` result in an ACCEPTABLE quality assessment. Default is `REASONABLE`.

minimumUncertainQuality - Minimum compatibility-mode quality that gets converted to DocumentQualityAssessment.UNCERTAIN. Compatibility-mode quality levels between `minimumUncertainQuality` (inclusive) and `minimumAcceptableQuality` (exclusive) result in an UNCERTAIN quality assessment. Default is `POOR`.

inspectSmallText - Inspect small text (typically less than 12 pixels height) when analyzing the document quality. If true, processing will be slower, but when the quality issue with a document is the low resolution of the text, then the issue will be caught. Default is `false`.

DocumentQualityAnalyzerCompatibilityModeConfiguration

public DocumentQualityAnalyzerCompatibilityModeConfiguration()

Constructs DocumentQualityAnalyzerCompatibilityModeConfiguration with default parameters.

Method Details

getMode

public DocumentQualityAnalyzerCompatibilityMode getMode()

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

Returns:

mode

getMinimumAcceptableQuality

public DocumentQuality getMinimumAcceptableQuality()

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

Returns:

minimumAcceptableQuality

setMinimumAcceptableQuality

public void setMinimumAcceptableQuality(DocumentQuality minimumAcceptableQuality)

Setter for minimumAcceptableQuality field. See constructor documentation for more information about the field.

Parameters:

minimumAcceptableQuality - Value to set.

getMinimumUncertainQuality

public DocumentQuality getMinimumUncertainQuality()

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

Returns:

minimumUncertainQuality

setMinimumUncertainQuality

public void setMinimumUncertainQuality(DocumentQuality minimumUncertainQuality)

Setter for minimumUncertainQuality field. See constructor documentation for more information about the field.

Parameters:

minimumUncertainQuality - Value to set.

getInspectSmallText

public boolean getInspectSmallText()

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

Returns:

inspectSmallText

setInspectSmallText

public void setInspectSmallText(boolean inspectSmallText)

Setter for inspectSmallText field. See constructor documentation for more information about the field.

Parameters:

inspectSmallText - Value to set.