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>

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
<R> R	execute(TableOperation<T,?,?,R> operationToPerform) Executes a command against the database with the context of the primary index of the specific table this object is linked to.
DynamoDbClient	getDynamoDbClient()
MapperExtension	getMapperExtension() Gets the MapperExtension associated with this mapped resource.
String	getTableName() Gets the physical table name that operations performed by this object will be executed against.
TableSchema<T>	getTableSchema() Gets the TableSchema object that this mapped table was built with.
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.

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 against the database with the context of the primary index of the specific table this object is linked to. Example: mappedTable.execute(PutItem.of(myItem));

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.

getMapperExtension

public MapperExtension getMapperExtension()

Description copied from interface: MappedTable

Gets the MapperExtension associated with this mapped resource.

Specified by:

getMapperExtension in interface MappedTable<T>

Returns:

The MapperExtension associated with this mapped resource.

getTableSchema

public TableSchema<T> getTableSchema()

Description copied from interface: MappedTable

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

Specified by:

getTableSchema in interface MappedTable<T>

Returns:

The TableSchema object for this mapped table.

getDynamoDbClient

public DynamoDbClient getDynamoDbClient()

getTableName

public String getTableName()

Description copied from interface: MappedTable

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

Specified by:

getTableName in interface MappedTable<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: MappedTable

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 MappedTable<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