Block (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.comprehend.model.Block

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Block
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Block()

Constructors
Constructor and Description
`Block()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Block`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBlockType()` The block represents a line of text or one word of text.
`Geometry`	`getGeometry()` Co-ordinates of the rectangle or polygon that contains the text.
`String`	`getId()` Unique identifier for the block.
`Integer`	`getPage()` Page number where the block appears.
`List<RelationshipsListItem>`	`getRelationships()` A list of child blocks of the current block.
`String`	`getText()` The word or line of text extracted from the block.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBlockType(String blockType)` The block represents a line of text or one word of text.
`void`	`setGeometry(Geometry geometry)` Co-ordinates of the rectangle or polygon that contains the text.
`void`	`setId(String id)` Unique identifier for the block.
`void`	`setPage(Integer page)` Page number where the block appears.
`void`	`setRelationships(Collection<RelationshipsListItem> relationships)` A list of child blocks of the current block.
`void`	`setText(String text)` The word or line of text extracted from the block.
`String`	`toString()` Returns a string representation of this object.
`Block`	`withBlockType(BlockType blockType)` The block represents a line of text or one word of text.
`Block`	`withBlockType(String blockType)` The block represents a line of text or one word of text.
`Block`	`withGeometry(Geometry geometry)` Co-ordinates of the rectangle or polygon that contains the text.
`Block`	`withId(String id)` Unique identifier for the block.
`Block`	`withPage(Integer page)` Page number where the block appears.
`Block`	`withRelationships(Collection<RelationshipsListItem> relationships)` A list of child blocks of the current block.
`Block`	`withRelationships(RelationshipsListItem... relationships)` A list of child blocks of the current block.
`Block`	`withText(String text)` The word or line of text extracted from the block.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Block
```
public Block()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    Unique identifier for the block.
    
    Parameters:
    
    id - Unique identifier for the block.
  - getId
```
public String getId()
```
    Unique identifier for the block.
    
    Returns:
    
    Unique identifier for the block.
  - withId
```
public Block withId(String id)
```
    Unique identifier for the block.
    
    Parameters:
    
    id - Unique identifier for the block.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBlockType
```
public void setBlockType(String 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
    Parameters:
    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
    See Also:
    
    BlockType
  - getBlockType
```
public String getBlockType()
```
    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
    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
  - withBlockType
```
public Block withBlockType(String 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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BlockType
  - withBlockType
```
public Block withBlockType(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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BlockType
  - setText
```
public void setText(String text)
```
    The word or line of text extracted from the block.
    
    Parameters:
    
    text - The word or line of text extracted from the block.
  - getText
```
public String getText()
```
    The word or line of text extracted from the block.
    
    Returns:
    
    The word or line of text extracted from the block.
  - withText
```
public Block withText(String text)
```
    The word or line of text extracted from the block.
    
    Parameters:
    
    text - The word or line of text extracted from the block.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPage
```
public void setPage(Integer page)
```
    Page number where the block appears.
    
    Parameters:
    
    page - Page number where the block appears.
  - getPage
```
public Integer getPage()
```
    Page number where the block appears.
    
    Returns:
    
    Page number where the block appears.
  - withPage
```
public Block withPage(Integer page)
```
    Page number where the block appears.
    
    Parameters:
    
    page - Page number where the block appears.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGeometry
```
public void setGeometry(Geometry geometry)
```
    Co-ordinates of the rectangle or polygon that contains the text.
    
    Parameters:
    
    geometry - Co-ordinates of the rectangle or polygon that contains the text.
  - getGeometry
```
public Geometry getGeometry()
```
    Co-ordinates of the rectangle or polygon that contains the text.
    
    Returns:
    
    Co-ordinates of the rectangle or polygon that contains the text.
  - withGeometry
```
public Block withGeometry(Geometry geometry)
```
    Co-ordinates of the rectangle or polygon that contains the text.
    
    Parameters:
    
    geometry - Co-ordinates of the rectangle or polygon that contains the text.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRelationships
```
public List<RelationshipsListItem> getRelationships()
```
    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.
    
    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.
  - setRelationships
```
public void setRelationships(Collection<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.
    
    Parameters:
    
    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.
  - withRelationships
```
public Block withRelationships(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setRelationships(java.util.Collection) or withRelationships(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRelationships
```
public Block withRelationships(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Block clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class Block

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Block

Method Detail

setId

getId

withId

setBlockType

getBlockType

withBlockType

withBlockType

setText

getText

withText

setPage

getPage

withPage

setGeometry

getGeometry

withGeometry

getRelationships

setRelationships

withRelationships

withRelationships

toString

equals

hashCode

clone

marshall