Package software.amazon.awssdk.services.comprehend.model

Class Block

java.lang.Object
software.amazon.awssdk.services.comprehend.model.Block
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Block.Builder,Block>
@Generated("software.amazon.awssdk:codegen") public final class Block extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Block.Builder,Block>

Information about each word or line of text in the input document.

For additional information, see Block in the Amazon Textract API reference.

See Also:

  • Method Details

    • id

      public final String id()

      Unique identifier for the block.

      Returns:
      Unique identifier for the block.

    • blockType

      public final BlockType blockType()

      The block represents a line of text or one word of text.

      • WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.

      • LINE - A string of tab-delimited, contiguous words that are detected on a document page

      If the service returns an enum value that is not available in the current SDK version, blockType will return BlockType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from blockTypeAsString().

      Returns:
      The block represents a line of text or one word of text.

      • WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.

      • LINE - A string of tab-delimited, contiguous words that are detected on a document page

      See Also:

    • blockTypeAsString

      public final String blockTypeAsString()

      The block represents a line of text or one word of text.

      • WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.

      • LINE - A string of tab-delimited, contiguous words that are detected on a document page

      If the service returns an enum value that is not available in the current SDK version, blockType will return BlockType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from blockTypeAsString().

      Returns:
      The block represents a line of text or one word of text.

      • WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.

      • LINE - A string of tab-delimited, contiguous words that are detected on a document page

      See Also:

    • text

      public final String text()

      The word or line of text extracted from the block.

      Returns:
      The word or line of text extracted from the block.

    • page

      public final Integer page()

      Page number where the block appears.

      Returns:
      Page number where the block appears.

    • geometry

      public final Geometry geometry()

      Co-ordinates of the rectangle or polygon that contains the text.

      Returns:
      Co-ordinates of the rectangle or polygon that contains the text.

    • hasRelationships

      public final boolean hasRelationships()
      For responses, this returns true if the service returned a value for the Relationships 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.

    • relationships

      public final List<RelationshipsListItem> relationships()

      A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text.

      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 hasRelationships() method.

      Returns:
      A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text.

    • toBuilder

      public Block.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Block.Builder,Block>
      Returns:
      a builder for type T

    • builder

      public static Block.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Block.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.