Package io.scanbot.sdk.frameaccumulation

Enum Class ConfirmationMethod

java.lang.Object

java.lang.Enum<ConfirmationMethod>

io.scanbot.sdk.frameaccumulation.ConfirmationMethod

All Implemented Interfaces:

Serializable, Comparable<ConfirmationMethod>, Constable

public enum ConfirmationMethod
extends Enum<ConfirmationMethod>

Method used to confirm a result.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXACT	Require seeing the same result multiple times to confirm it.
INTERPOLATE	Interpolate between seen values to generate the most likely true value.

Method Summary

Modifier and Type	Method	Description
static ConfirmationMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ConfirmationMethod[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EXACT

public static final ConfirmationMethod EXACT

Require seeing the same result multiple times to confirm it. E.g. if the seen values are "John B. Doe", "John B.", "B. Doe", "John B. Doe" then the confirmation count for the value "John B. Doe" is 2 and for the rest it's 1. A field's value is considered CONFIRMED if its confirmation count is greater or equal to minConfirmations.

INTERPOLATE

public static final ConfirmationMethod INTERPOLATE

Interpolate between seen values to generate the most likely true value. E.g. if the seen values are "John X. Doe", "John B.", "B. Doe" then the most likely true value can be interpolated to be "John B. Doe". The interpolated value is considered CONFIRMED if each character in it has been seen at least minConfirmations times.

Method Details

values

public static ConfirmationMethod[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ConfirmationMethod valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null