software.amazon.awssdk.services.textract.model

Class Geometry

java.lang.Object

software.amazon.awssdk.services.textract.model.Geometry

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Geometry.Builder,Geometry>

@Generated(value="software.amazon.awssdk:codegen")
public final class Geometry
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Geometry.Builder,Geometry>

Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Geometry.Builder

Method Summary

Modifier and Type	Method and Description
BoundingBox	boundingBox() An axis-aligned coarse representation of the location of the recognized item on the document page.
static Geometry.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPolygon() For responses, this returns true if the service returned a value for the Polygon property.
List<Point>	polygon() Within the bounding box, a fine-grained polygon around the recognized item.
List<SdkField<?>>	sdkFields()
static Class<? extends Geometry.Builder>	serializableBuilderClass()
Geometry.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

boundingBox

public final BoundingBox boundingBox()

An axis-aligned coarse representation of the location of the recognized item on the document page.

Returns:

An axis-aligned coarse representation of the location of the recognized item on the document page.

hasPolygon

public final boolean hasPolygon()

For responses, this returns true if the service returned a value for the Polygon 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.

polygon

public final List<Point> polygon()

Within the bounding box, a fine-grained polygon around the recognized item.

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

Returns:

Within the bounding box, a fine-grained polygon around the recognized item.

toBuilder

public Geometry.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<Geometry.Builder,Geometry>

Returns:

a builder for type T

builder

public static Geometry.Builder builder()

serializableBuilderClass

public static Class<? extends Geometry.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.