Package io.scanbot.sdk.textpattern

Class TextPatternScannerResult

java.lang.Object

io.scanbot.sdk.textpattern.TextPatternScannerResult

public class TextPatternScannerResult
extends Object

The result of the text line recognition.

Constructor Summary

Constructors

Constructor	Description
TextPatternScannerResult(String rawText, List<WordBox> wordBoxes, List<SymbolBox> symbolBoxes)	Constructs TextPatternScannerResult with default parameters.
TextPatternScannerResult(String rawText, List<WordBox> wordBoxes, List<SymbolBox> symbolBoxes, double confidence, boolean validationSuccessful)	Constructs TextPatternScannerResult with the given params.

Method Summary

Modifier and Type	Method	Description
double	getConfidence()	Getter for confidence field.
String	getRawText()	Getter for rawText field.
List<SymbolBox>	getSymbolBoxes()	Getter for symbolBoxes field.
boolean	getValidationSuccessful()	Getter for validationSuccessful field.
List<WordBox>	getWordBoxes()	Getter for wordBoxes field.

Methods inherited from class java.lang.Object

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

Constructor Details

TextPatternScannerResult

public TextPatternScannerResult(String rawText,
 List<WordBox> wordBoxes,
 List<SymbolBox> symbolBoxes,
 double confidence,
 boolean validationSuccessful)

Constructs TextPatternScannerResult with the given params.

Parameters:

rawText - Raw recognized string.

wordBoxes - Boxes for each recognized word.

symbolBoxes - Boxes for each recognized symbol.

confidence - Confidence of the recognition. Default is `0.0`.

validationSuccessful - True if both the configured validator (if any) and the configured frame accumulation criteria were satisfied. Default is `false`.

TextPatternScannerResult

public TextPatternScannerResult(String rawText,
 List<WordBox> wordBoxes,
 List<SymbolBox> symbolBoxes)

Constructs TextPatternScannerResult with default parameters.

Parameters:

rawText - Raw recognized string.

wordBoxes - Boxes for each recognized word.

symbolBoxes - Boxes for each recognized symbol.

Method Details

getRawText

public String getRawText()

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

Returns:

rawText

getWordBoxes

public List<WordBox> getWordBoxes()

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

Returns:

wordBoxes

getSymbolBoxes

public List<SymbolBox> getSymbolBoxes()

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

Returns:

symbolBoxes

getConfidence

public double getConfidence()

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

Returns:

confidence

getValidationSuccessful

public boolean getValidationSuccessful()

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

Returns:

validationSuccessful