software.amazon.awssdk.extensions.dynamodb.mappingclient.core

Class DynamoDbMappedTable<T>

java.lang.Object

software.amazon.awssdk.extensions.dynamodb.mappingclient.core.DynamoDbMappedTable<T>

All Implemented Interfaces:

MappedTable<T>, MappedTableResource<T>

@ThreadSafe
public class DynamoDbMappedTable<T>
extends Object
implements MappedTable<T>

Method Summary

Modifier and Type	Method and Description
DynamoDbClient	dynamoDbClient()
boolean	equals(Object o)
<R> SdkIterable<R>	execute(PaginatedTableOperation<T,?,?,R> operationToPerform) Executes a command that is expected to return a paginated list of data items against the database with the context of the primary index of the specific table this object is linked to.
<R> R	execute(TableOperation<T,?,?,R> operationToPerform) Executes a command that is expected to return a single data item against the database with the context of the primary index of the specific table this object is linked to.
int	hashCode()
DynamoDbMappedIndex<T>	index(String indexName) Returns a mapped index that can be used to execute commands against a secondary index belonging to the table being mapped by this object.
Key	keyFrom(T item) Creates a Key object from a modelled item.
MapperExtension	mapperExtension() Gets the MapperExtension associated with this mapped resource.
String	tableName() Gets the physical table name that operations performed by this object will be executed against.
TableSchema<T>	tableSchema() Gets the TableSchema object that this mapped table was built with.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

execute

public <R> R execute(TableOperation<T,?,?,R> operationToPerform)

Description copied from interface: MappedTable

Executes a command that is expected to return a single data item against the database with the context of the primary index of the specific table this object is linked to.

Specified by:

execute in interface MappedTable<T>

Type Parameters:

R - The expected return type from the operation. This is typically inferred by the compiler.

Parameters:

operationToPerform - The operation to be performed in the context of the primary index of the table.

Returns:

the result of the operation being executed. The documentation on the operation itself should have more information.

execute

public <R> SdkIterable<R> execute(PaginatedTableOperation<T,?,?,R> operationToPerform)

Description copied from interface: MappedTable

Executes a command that is expected to return a paginated list of data items against the database with the context of the primary index of the specific table this object is linked to.

Specified by:

execute in interface MappedTable<T>

Type Parameters:

R - The expected return type from the operation. This is typically inferred by the compiler.

Parameters:

operationToPerform - The operation to be performed in the context of the primary index of the table.

Returns:

An SdkIterable that will return successive pages of result data items as it is iterated over.

mapperExtension

public MapperExtension mapperExtension()

Description copied from interface: MappedTableResource

Gets the MapperExtension associated with this mapped resource.

Specified by:

mapperExtension in interface MappedTableResource<T>

Returns:

The MapperExtension associated with this mapped resource.

tableSchema

public TableSchema<T> tableSchema()

Description copied from interface: MappedTableResource

Gets the TableSchema object that this mapped table was built with.

Specified by:

tableSchema in interface MappedTableResource<T>

Returns:

The TableSchema object for this mapped table.

dynamoDbClient

public DynamoDbClient dynamoDbClient()

tableName

public String tableName()

Description copied from interface: MappedTableResource

Gets the physical table name that operations performed by this object will be executed against.

Specified by:

tableName in interface MappedTableResource<T>

Returns:

The physical table name.

index

public DynamoDbMappedIndex<T> index(String indexName)

Description copied from interface: MappedTable

Returns a mapped index that can be used to execute commands against a secondary index belonging to the table being mapped by this object. Note that only a subset of the commands that work against a table will work against a secondary index.

Specified by:

index in interface MappedTable<T>

Parameters:

indexName - The name of the secondary index to build the command interface for.

Returns:

A MappedIndex object that can be used to execute database commands against.

keyFrom

public Key keyFrom(T item)

Description copied from interface: MappedTableResource

Creates a Key object from a modelled item. This key can be used in query conditionals and get operations to locate a specific record.

Specified by:

keyFrom in interface MappedTableResource<T>

Parameters:

item - The item to extract the key fields from.

Returns:

A key that has been initialized with the index values extracted from the modelled object.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object