Package io.scanbot.sdk.documentdata

Enum Class ValueConsistency

java.lang.Object
java.lang.Enum<ValueConsistency>
io.scanbot.sdk.documentdata.ValueConsistency
All Implemented Interfaces:
Serializable, Comparable<ValueConsistency>, Constable
public enum ValueConsistency extends Enum<ValueConsistency>
The status of the consistency verification.

  • 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
    INCONSISTENT
    The values that correspond to the same logical field are inconsistent.
    OK
    All values that correspond to the same logical field are exactly equal.
    OK_DEBURRED
    All values that correspond to the same logical field are equal after punctuation is removed, all characters are converted to upper case and diacritics are replaced with their base characters.
    OK_DEBURRED_EXTENDED
    Same as OK_DEBURRED but allows replacing diacritics not only with their base characters but also with some more complex combinations.
    OK_PUNCTUATION_UPPER_CASE_CLEANED
    All values that correspond to the same logical field are equal after punctuation is removed and all characters are converted to upper case.
    OK_TRUNCATED
    In addition to OK_DEBURRED_EXTENDED, allows one string to be a prefix of another string.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ValueConsistency
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ValueConsistency[]
    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

    • OK

      public static final ValueConsistency OK
      All values that correspond to the same logical field are exactly equal.

    • OK_PUNCTUATION_UPPER_CASE_CLEANED

      public static final ValueConsistency OK_PUNCTUATION_UPPER_CASE_CLEANED
      All values that correspond to the same logical field are equal after punctuation is removed and all characters are converted to upper case.

    • OK_DEBURRED

      public static final ValueConsistency OK_DEBURRED
      All values that correspond to the same logical field are equal after punctuation is removed, all characters are converted to upper case and diacritics are replaced with their base characters.

    • OK_DEBURRED_EXTENDED

      public static final ValueConsistency OK_DEBURRED_EXTENDED
      Same as OK_DEBURRED but allows replacing diacritics not only with their base characters but also with some more complex combinations. E.g., according to ICAO 9303 MRZ standard Ü can be replaced with U or UE or UXX.

    • OK_TRUNCATED

      public static final ValueConsistency OK_TRUNCATED
      In addition to OK_DEBURRED_EXTENDED, allows one string to be a prefix of another string. Correctly works with complex diacritics replacements. In particular, if one string is MUEL and another is MÜLLER, then they are considered equal up to truncation.

    • INCONSISTENT

      public static final ValueConsistency INCONSISTENT
      The values that correspond to the same logical field are inconsistent.

  • Method Details

    • values

      public static ValueConsistency[] 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 ValueConsistency 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