io.scanbot.sdk.ui.view.generictext.entity

Class TextDataScannerStep

io.scanbot.sdk.ui.view.generictext.entity.TextDataScannerStep

public class TextDataScannerStep

Defines a single step of the data scanning flow

Field Detail

SIGNIFICANT_DELAY_DEFAULT

public static long SIGNIFICANT_DELAY_DEFAULT

See Also:

Constant Field Values

DEFAULT_FINDER_HEIGHT

public static float DEFAULT_FINDER_HEIGHT

See Also:

Constant Field Values

Companion

public static io.scanbot.sdk.ui.view.generictext.entity.TextDataScannerStep.Companion Companion

Constructor Detail

TextDataScannerStep

public TextDataScannerStep(@NotNull
                           java.lang.String stepTag,
                           @NotNull
                           java.lang.String title,
                           @NotNull
                           java.lang.String guidanceText,
                           @Nullable
                           java.lang.String pattern,
                           boolean shouldMatchSubstring,
                           @Nullable
                           io.scanbot.sdk.generictext.GenericTextRecognizer.GenericTextValidationCallback validationCallback,
                           @Nullable
                           io.scanbot.sdk.generictext.GenericTextRecognizer.CleanRecognitionResultCallback cleanRecognitionResultCallback,
                           float preferredZoom,
                           @NotNull
                           io.scanbot.sdk.ui.camera.FinderAspectRatio aspectRatio,
                           float unzoomedFinderHeight,
                           @NotNull
                           java.util.Set<java.lang.Character> allowedSymbols,
                           @NotNull
                           io.scanbot.sdk.generictext.TextFilterStrategy textFilterStrategy,
                           long significantShakeDelay)

Defines a single step of the data scanning flow

Parameters:

stepTag - The tag of the scanning step to make. It will be indicated in the result

title - Title for a value

guidanceText - User guidance for the step

pattern - Sets a validation pattern (Supports ? - any character, # - any digit,all other characters represent themselves). Empty string or null will disable the validation)

shouldMatchSubstring - Find and match only part of the whole string if the pattern is used

validationCallback - Callback for text validation

cleanRecognitionResultCallback - Callback to clean recognized string prior to validation.

preferredZoom - Digital zoom level required for this step

aspectRatio - Aspect ratio for the step

unzoomedFinderHeight - Default height of the finder (for zoom-level 1.0)

allowedSymbols - Allowed symbols to be detected

textFilterStrategy - Additional parameter to set the type of the scanned object. @see TextFilterStrategy. Default is TextFilterStrategy.Document

significantShakeDelay - Detection will be paused after significant movement-1 is default valueDefault = 0 for TextFilterStrategy.Document or 1000 for TextFilterStrategy.LcdDotMatrixDisplay

Method Detail

getStepTag

@NotNull
public java.lang.String getStepTag()

The tag of the scanning step to make.

It will be indicated in the result

getTitle

@NotNull
public java.lang.String getTitle()

Title for a value

getGuidanceText

@NotNull
public java.lang.String getGuidanceText()

User guidance for the step

getPattern

@Nullable
public java.lang.String getPattern()

Sets a validation pattern

(Supports ? - any character, # - any digit,all other characters represent themselves). Empty string or null will disable the validation)

getShouldMatchSubstring

public boolean getShouldMatchSubstring()

Find and match only part of the whole string if the pattern is used

getValidationCallback

@Nullable
public io.scanbot.sdk.generictext.GenericTextRecognizer.GenericTextValidationCallback getValidationCallback()

Callback for text validation

getCleanRecognitionResultCallback

@Nullable
public io.scanbot.sdk.generictext.GenericTextRecognizer.CleanRecognitionResultCallback getCleanRecognitionResultCallback()

Callback to clean recognized string prior to validation.

getPreferredZoom

public float getPreferredZoom()

Digital zoom level required for this step

getAspectRatio

@NotNull
public io.scanbot.sdk.ui.camera.FinderAspectRatio getAspectRatio()

Aspect ratio for the step

getUnzoomedFinderHeight

public float getUnzoomedFinderHeight()

Default height of the finder

(for zoom-level 1.0)

getAllowedSymbols

@NotNull
public java.util.Set<java.lang.Character> getAllowedSymbols()

Allowed symbols to be detected

getTextFilterStrategy

@NotNull
public io.scanbot.sdk.generictext.TextFilterStrategy getTextFilterStrategy()

Additional parameter to set the type of the scanned object.

@see TextFilterStrategy. Default is TextFilterStrategy.Document

getSignificantShakeDelay

public long getSignificantShakeDelay()

Detection will be paused after significant movement

-1 is default valueDefault = 0 for TextFilterStrategy.Document or 1000 for TextFilterStrategy.LcdDotMatrixDisplay

component1

@NotNull
public java.lang.String component1()

The tag of the scanning step to make.

It will be indicated in the result

component2

@NotNull
public java.lang.String component2()

Title for a value

component3

@NotNull
public java.lang.String component3()

User guidance for the step

component4

@Nullable
public java.lang.String component4()

Sets a validation pattern

(Supports ? - any character, # - any digit,all other characters represent themselves). Empty string or null will disable the validation)

component5

public boolean component5()

Find and match only part of the whole string if the pattern is used

component6

@Nullable
public io.scanbot.sdk.generictext.GenericTextRecognizer.GenericTextValidationCallback component6()

Callback for text validation

component7

@Nullable
public io.scanbot.sdk.generictext.GenericTextRecognizer.CleanRecognitionResultCallback component7()

Callback to clean recognized string prior to validation.

component8

public float component8()

Digital zoom level required for this step

component9

@NotNull
public io.scanbot.sdk.ui.camera.FinderAspectRatio component9()

Aspect ratio for the step

component10

public float component10()

Default height of the finder

(for zoom-level 1.0)

component11

@NotNull
public java.util.Set<java.lang.Character> component11()

Allowed symbols to be detected

component12

@NotNull
public io.scanbot.sdk.generictext.TextFilterStrategy component12()

Additional parameter to set the type of the scanned object.

@see TextFilterStrategy. Default is TextFilterStrategy.Document

component13

public long component13()

Detection will be paused after significant movement

-1 is default valueDefault = 0 for TextFilterStrategy.Document or 1000 for TextFilterStrategy.LcdDotMatrixDisplay

copy

@NotNull
public TextDataScannerStep copy(@NotNull
                                         java.lang.String stepTag,
                                         @NotNull
                                         java.lang.String title,
                                         @NotNull
                                         java.lang.String guidanceText,
                                         @Nullable
                                         java.lang.String pattern,
                                         boolean shouldMatchSubstring,
                                         @Nullable
                                         io.scanbot.sdk.generictext.GenericTextRecognizer.GenericTextValidationCallback validationCallback,
                                         @Nullable
                                         io.scanbot.sdk.generictext.GenericTextRecognizer.CleanRecognitionResultCallback cleanRecognitionResultCallback,
                                         float preferredZoom,
                                         @NotNull
                                         io.scanbot.sdk.ui.camera.FinderAspectRatio aspectRatio,
                                         float unzoomedFinderHeight,
                                         @NotNull
                                         java.util.Set<java.lang.Character> allowedSymbols,
                                         @NotNull
                                         io.scanbot.sdk.generictext.TextFilterStrategy textFilterStrategy,
                                         long significantShakeDelay)

Defines a single step of the data scanning flow

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(@Nullable
                      java.lang.Object p)