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

Class Block

    • Method Detail

      • 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:
        BlockType

      • 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:
        BlockType

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

      • 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

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