Package io.scanbot.sdk.documentdata

Class CompositeFieldValueSemantics

java.lang.Object
io.scanbot.sdk.documentdata.CompositeFieldValueSemantics
public class CompositeFieldValueSemantics extends Object
Report of a logical field value semantics verification. If some logical field, e.g. expiry date is present in multiple places in the document, it can occur that some entries are semantically correct and some are semantically incorrect. This report shows the overall status of the logical field value semantics verification and details for each field that was verified.

  • Constructor Details

    • CompositeFieldValueSemantics

      public CompositeFieldValueSemantics(ValueSemantics overallFieldValueSemantics, List<FieldValueSemantics> fieldDetails)
      Constructs CompositeFieldValueSemantics with the given params.
      Parameters:
      overallFieldValueSemantics - Overall status of the logical value semantics verification. Corresponds to the most severe status of all fields, i.e. if at least one field is semantically incorrect, the overall status is semantically incorrect. If no fields are present, the overall status is SKIPPED.
      fieldDetails - List of value semantics for each field corresponding to the same logical field.

  • Method Details

    • getOverallFieldValueSemantics

      public ValueSemantics getOverallFieldValueSemantics()
      Getter for overallFieldValueSemantics field. See constructor documentation for more information about the field.
      Returns:
      overallFieldValueSemantics

    • getFieldDetails

      public List<FieldValueSemantics> getFieldDetails()
      Getter for fieldDetails field. See constructor documentation for more information about the field.
      Returns:
      fieldDetails