Package io.scanbot.sdk.genericdocument

Enum FieldValidationStatus

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FieldValidationStatus>
    public enum FieldValidationStatus
extends java.lang.Enum<FieldValidationStatus>
    Field validation status. Optical character recognition (OCR) invariably introduces errors in the recognized text. There are numerous ways to verify that what has been recognized is, in fact, what was written in the document. The best way to validate the value of a field is for it to have a known format or validation logic. For example, an IBAN number has a known format and two check digits that make it very unlikely that a value with OCR errors will pass validation. Fields with known validation rules will have a validation status of either VALID or INVALID. Fields whose value can be inferred from other fields, or from domain knowledge (for example, the field may have the same value in every instance of this type of document), will have the status INFERRED. Inferring the value of a field is a strong validation method, provided that there are no unexpected changes to the document format. Fields that do not have validation rules and cannot be inferred can still be validated by checking whether the same value is recognized from multiple attempts, e.g. across multiple frames of a camera stream. If the same value is recognized in multiple frames, the value is considered CONFIRMED, otherwise it will have the status NONE. This is the least strict validation method, as it does not protect from systemic OCR errors, but in practice it still provides good results for most fields.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CONFIRMED
      The same field value was recognized in multiple frames, thereby confirming the value.
      IGNORED
      The document contains a field of this type, but recognition for this field is disabled.
      INFERRED
      Field value was inferred from other fields or from domain knowledge.
      INVALID
      Field value failed validation.
      NONE
      Field value was not validated, typically because the field does not support validation and the value has not been seen enough times to confirm it.
      OBSTRUCTED
      Field value was not recognized because it was obstructed by e.g.
      VALID
      Field value passed validation.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static FieldValidationStatus valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FieldValidationStatus[] 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

      • INVALID

        public static final FieldValidationStatus INVALID
        Field value failed validation. This status is used for fields that have validation rules, like IBAN, date fields, etc. that have check digits or a known format that can be validated.

      • OBSTRUCTED

        public static final FieldValidationStatus OBSTRUCTED
        Field value was not recognized because it was obstructed by e.g. a light reflection or a shadow.

      • NONE

        public static final FieldValidationStatus NONE
        Field value was not validated, typically because the field does not support validation and the value has not been seen enough times to confirm it. If the same value is seen in multiple frames, the validation status will transition to CONFIRMED, but only if that particular recognizer supports multiple frame accumulation.

      • CONFIRMED

        public static final FieldValidationStatus CONFIRMED
        The same field value was recognized in multiple frames, thereby confirming the value. Occurs only for fields that have no validation rules otherwise. A CONFIRMED value gives a strong guarantee that the field value has been read out without errors, but not as strong as VALID. The value may still be incorrect, due to systemic OCR errors. In case of OCR errors, increase the number of frames needed to confirm the value in the recognizer configuration.

      • INFERRED

        public static final FieldValidationStatus INFERRED
        Field value was inferred from other fields or from domain knowledge. The field value may differ from what is actually written in the document in unexpected situations.

      • VALID

        public static final FieldValidationStatus VALID
        Field value passed validation. This status is used for fields that have validation rules, like IBAN, date fields, etc. that have check digits or a known format that can be validated. The VALID status gives the strongest guarantee that the field value has been read out without errors.

      • IGNORED

        public static final FieldValidationStatus IGNORED
        The document contains a field of this type, but recognition for this field is disabled. The value of this field is always empty, although the field may be non-empty in the document.

    • Method Detail

      • values

        public static FieldValidationStatus[] 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 (FieldValidationStatus c : FieldValidationStatus.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static FieldValidationStatus 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