Package io.scanbot.sdk.documentdata

Class DocumentDataExtractorConfiguration

java.lang.Object

io.scanbot.sdk.documentdata.DocumentDataExtractorConfiguration

public class DocumentDataExtractorConfiguration
extends java.lang.Object

Configuration for the document data extractor.

Constructor Summary

Constructors

Constructor	Description
DocumentDataExtractorConfiguration()	Constructs DocumentDataExtractorConfiguration with default parameters.
DocumentDataExtractorConfiguration(ResultAccumulationConfiguration resultAccumulationConfig, java.util.List<java.lang.String> fieldExcludeList, java.util.List<DocumentDataExtractorConfigurationElement> configurations, boolean returnCrops, DocumentTrustMode documentTrustMode, ProcessingMode processingMode)	Constructs DocumentDataExtractorConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
java.util.List<DocumentDataExtractorConfigurationElement>	getConfigurations()	Getter for configurations field.
DocumentTrustMode	getDocumentTrustMode()	Getter for documentTrustMode field.
java.util.List<java.lang.String>	getFieldExcludeList()	Getter for fieldExcludeList field.
ProcessingMode	getProcessingMode()	Getter for processingMode field.
ResultAccumulationConfiguration	getResultAccumulationConfig()	Getter for resultAccumulationConfig field.
boolean	getReturnCrops()	Getter for returnCrops field.
void	setConfigurations(java.util.List<DocumentDataExtractorConfigurationElement> configurations)	Setter for configurations field.
void	setDocumentTrustMode(DocumentTrustMode documentTrustMode)	Setter for documentTrustMode field.
void	setFieldExcludeList(java.util.List<java.lang.String> fieldExcludeList)	Setter for fieldExcludeList field.
void	setProcessingMode(ProcessingMode processingMode)	Setter for processingMode field.
void	setResultAccumulationConfig(ResultAccumulationConfiguration resultAccumulationConfig)	Setter for resultAccumulationConfig field.
void	setReturnCrops(boolean returnCrops)	Setter for returnCrops field.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentDataExtractorConfiguration

public DocumentDataExtractorConfiguration(ResultAccumulationConfiguration resultAccumulationConfig,
                                          java.util.List<java.lang.String> fieldExcludeList,
                                          java.util.List<DocumentDataExtractorConfigurationElement> configurations,
                                          boolean returnCrops,
                                          DocumentTrustMode documentTrustMode,
                                          ProcessingMode processingMode)

Constructs DocumentDataExtractorConfiguration with the given params.

Parameters:

resultAccumulationConfig - Configuration for how to accumulate results.

fieldExcludeList - Normalized names of the fields to exclude from the result.

configurations - List of configuration elements for the document data extractor.

returnCrops - If true, crops of the detected documents and fields will be returned in the result. Default is false

documentTrustMode - Level of trust in the authenticity of the extracted document. Default is TRUSTED

processingMode - Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it. On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject. Default is AUTO

DocumentDataExtractorConfiguration

public DocumentDataExtractorConfiguration()

Constructs DocumentDataExtractorConfiguration with default parameters.

Method Detail

getResultAccumulationConfig

public ResultAccumulationConfiguration getResultAccumulationConfig()

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

Returns:

resultAccumulationConfig

setResultAccumulationConfig

public void setResultAccumulationConfig(ResultAccumulationConfiguration resultAccumulationConfig)

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

Parameters:

resultAccumulationConfig - Value to set.

getFieldExcludeList

public java.util.List<java.lang.String> getFieldExcludeList()

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

Returns:

fieldExcludeList

setFieldExcludeList

public void setFieldExcludeList(java.util.List<java.lang.String> fieldExcludeList)

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

Parameters:

fieldExcludeList - Value to set.

getConfigurations

public java.util.List<DocumentDataExtractorConfigurationElement> getConfigurations()

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

Returns:

configurations

setConfigurations

public void setConfigurations(java.util.List<DocumentDataExtractorConfigurationElement> configurations)

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

Parameters:

configurations - Value to set.

getReturnCrops

public boolean getReturnCrops()

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

Returns:

returnCrops

setReturnCrops

public void setReturnCrops(boolean returnCrops)

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

Parameters:

returnCrops - Value to set.

getDocumentTrustMode

public DocumentTrustMode getDocumentTrustMode()

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

Returns:

documentTrustMode

setDocumentTrustMode

public void setDocumentTrustMode(DocumentTrustMode documentTrustMode)

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

Parameters:

documentTrustMode - Value to set.

getProcessingMode

public ProcessingMode getProcessingMode()

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

Returns:

processingMode

setProcessingMode

public void setProcessingMode(ProcessingMode processingMode)

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

Parameters:

processingMode - Value to set.