Package io.scanbot.sdk.documentdata

Enum ValueConsistency

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

    • 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

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ValueConsistency valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ValueConsistency[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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 Detail

      • values

        public static ValueConsistency[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ValueConsistency c : ValueConsistency.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ValueConsistency valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null