Package software.amazon.awssdk.services.textract.model

Class ExpenseField

    • Method Detail

      • type

        public final ExpenseType type()

        The implied label of a detected element. Present alongside LabelDetection for explicit elements.

        Returns:
        The implied label of a detected element. Present alongside LabelDetection for explicit elements.

      • labelDetection

        public final ExpenseDetection labelDetection()

        The explicitly stated label of a detected element.

        Returns:
        The explicitly stated label of a detected element.

      • valueDetection

        public final ExpenseDetection valueDetection()

        The value of a detected element. Present in explicit and implicit elements.

        Returns:
        The value of a detected element. Present in explicit and implicit elements.

      • pageNumber

        public final Integer pageNumber()

        The page number the value was detected on.

        Returns:
        The page number the value was detected on.

      • currency

        public final ExpenseCurrency currency()

        Shows the kind of currency, both the code and confidence associated with any monatary value detected.

        Returns:
        Shows the kind of currency, both the code and confidence associated with any monatary value detected.

      • hasGroupProperties

        public final boolean hasGroupProperties()
        For responses, this returns true if the service returned a value for the GroupProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • groupProperties

        public final List<ExpenseGroupProperty> groupProperties()

        Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupProperties() method.

        Returns:
        Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)