TextDetection (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.rekognition.model.TextDetection

All Implemented Interfaces:

java.io.Serializable
```
public class TextDetection
extends java.lang.Object
implements java.io.Serializable
```
Information about a word or line of text detected by DetectText.

The DetectedText field contains the text that Amazon Rekognition detected in the image.

Every word and line has an identifier (Id). Each word belongs to a line and has a parent identifier (ParentId) that identifies the line of text in which the word appears. The word Id is also an index for the word within a line of words.

For more information, see Detecting Text in the Amazon Rekognition Developer Guide.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

TextDetection()

Constructors
Constructor and Description
`TextDetection()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Float`	`getConfidence()` The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
`java.lang.String`	`getDetectedText()` The word or line of text recognized by Amazon Rekognition.
`Geometry`	`getGeometry()` The location of the detected text on the image.
`java.lang.Integer`	`getId()` The identifier for the detected text.
`java.lang.Integer`	`getParentId()` The Parent identifier for the detected text identified by the value of `ID`.
`java.lang.String`	`getType()` The type of text that was detected.
`int`	`hashCode()`
`void`	`setConfidence(java.lang.Float confidence)` The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
`void`	`setDetectedText(java.lang.String detectedText)` The word or line of text recognized by Amazon Rekognition.
`void`	`setGeometry(Geometry geometry)` The location of the detected text on the image.
`void`	`setId(java.lang.Integer id)` The identifier for the detected text.
`void`	`setParentId(java.lang.Integer parentId)` The Parent identifier for the detected text identified by the value of `ID`.
`void`	`setType(java.lang.String type)` The type of text that was detected.
`void`	`setType(TextTypes type)` The type of text that was detected.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`TextDetection`	`withConfidence(java.lang.Float confidence)` The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
`TextDetection`	`withDetectedText(java.lang.String detectedText)` The word or line of text recognized by Amazon Rekognition.
`TextDetection`	`withGeometry(Geometry geometry)` The location of the detected text on the image.
`TextDetection`	`withId(java.lang.Integer id)` The identifier for the detected text.
`TextDetection`	`withParentId(java.lang.Integer parentId)` The Parent identifier for the detected text identified by the value of `ID`.
`TextDetection`	`withType(java.lang.String type)` The type of text that was detected.
`TextDetection`	`withType(TextTypes type)` The type of text that was detected.

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

- Constructor Detail
  - TextDetection
```
public TextDetection()
```
- Method Detail
  - getDetectedText
```
public java.lang.String getDetectedText()
```
    The word or line of text recognized by Amazon Rekognition.
    
    Returns:
    
    The word or line of text recognized by Amazon Rekognition.
  - setDetectedText
```
public void setDetectedText(java.lang.String detectedText)
```
    The word or line of text recognized by Amazon Rekognition.
    
    Parameters:
    
    detectedText -
    The word or line of text recognized by Amazon Rekognition.
  - withDetectedText
```
public TextDetection withDetectedText(java.lang.String detectedText)
```
    The word or line of text recognized by Amazon Rekognition.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    detectedText -
    The word or line of text recognized by Amazon Rekognition.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getType
```
public java.lang.String getType()
```
    The type of text that was detected.
    
    Constraints:
    Allowed Values: LINE, WORD
    
    Returns:
    
    The type of text that was detected.
    
    See Also:
    
    TextTypes
  - setType
```
public void setType(java.lang.String type)
```
    The type of text that was detected.
    
    Constraints:
    Allowed Values: LINE, WORD
    
    Parameters:
    
    type -
    The type of text that was detected.
    
    See Also:
    
    TextTypes
  - withType
```
public TextDetection withType(java.lang.String type)
```
    The type of text that was detected.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: LINE, WORD
    
    Parameters:
    
    type -
    The type of text that was detected.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    TextTypes
  - setType
```
public void setType(TextTypes type)
```
    The type of text that was detected.
    
    Constraints:
    Allowed Values: LINE, WORD
    
    Parameters:
    
    type -
    The type of text that was detected.
    
    See Also:
    
    TextTypes
  - withType
```
public TextDetection withType(TextTypes type)
```
    The type of text that was detected.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: LINE, WORD
    
    Parameters:
    
    type -
    The type of text that was detected.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    TextTypes
  - getId
```
public java.lang.Integer getId()
```
    The identifier for the detected text. The identifier is only unique for a single call to DetectText.
    
    Constraints:
    Range: 0 -
    
    Returns:
    
    The identifier for the detected text. The identifier is only unique for a single call to DetectText.
  - setId
```
public void setId(java.lang.Integer id)
```
    The identifier for the detected text. The identifier is only unique for a single call to DetectText.
    
    Constraints:
    Range: 0 -
    
    Parameters:
    
    id -
    The identifier for the detected text. The identifier is only unique for a single call to DetectText.
  - withId
```
public TextDetection withId(java.lang.Integer id)
```
    The identifier for the detected text. The identifier is only unique for a single call to DetectText.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    Parameters:
    
    id -
    The identifier for the detected text. The identifier is only unique for a single call to DetectText.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getParentId
```
public java.lang.Integer getParentId()
```
    The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.
    
    Constraints:
    Range: 0 -
    
    Returns:
    
    The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.
  - setParentId
```
public void setParentId(java.lang.Integer parentId)
```
    The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.
    
    Constraints:
    Range: 0 -
    
    Parameters:
    
    parentId -
    The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.
  - withParentId
```
public TextDetection withParentId(java.lang.Integer parentId)
```
    The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    Parameters:
    
    parentId -
    The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getConfidence
```
public java.lang.Float getConfidence()
```
    The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
    
    Constraints:
    Length: 0 - 100
    
    Returns:
    
    The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
  - setConfidence
```
public void setConfidence(java.lang.Float confidence)
```
    The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
    
    Constraints:
    Length: 0 - 100
    
    Parameters:
    
    confidence -
    The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
  - withConfidence
```
public TextDetection withConfidence(java.lang.Float confidence)
```
    The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 100
    
    Parameters:
    
    confidence -
    The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getGeometry
```
public Geometry getGeometry()
```
    The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.
    
    Returns:
    
    The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.
  - setGeometry
```
public void setGeometry(Geometry geometry)
```
    The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.
    
    Parameters:
    
    geometry -
    The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.
  - withGeometry
```
public TextDetection withGeometry(Geometry geometry)
```
    The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    geometry -
    The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class TextDetection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TextDetection

Method Detail

getDetectedText

setDetectedText

withDetectedText

getType

setType

withType

setType

withType

getId

setId

withId

getParentId

setParentId

withParentId

getConfidence

setConfidence

withConfidence

getGeometry

setGeometry

withGeometry

toString

hashCode

equals