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

Class DynamoDbMappedIndex<T>

java.lang.Object

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

All Implemented Interfaces:

MappedIndex<T>

@ThreadSafe
public class DynamoDbMappedIndex<T>
extends Object
implements MappedIndex<T>

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
<R> R	execute(IndexOperation<T,?,?,R> operationToPerform) Executes a command against the database with the context of the specific table and secondary index this object is linked to.
DynamoDbClient	getDynamoDbClient()
String	getIndexName() Gets the physical secondary index name that operations performed by this object will be executed against.
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()
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(IndexOperation<T,?,?,R> operationToPerform)

Description copied from interface: MappedIndex

Executes a command against the database with the context of the specific table and secondary index this object is linked to. Example: mappedIndex.execute(Scan.create());

Specified by:

execute in interface MappedIndex<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 secondary index.

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: MappedIndex

Gets the MapperExtension associated with this mapped resource.

Specified by:

getMapperExtension in interface MappedIndex<T>

Returns:

The MapperExtension associated with this mapped resource.

getTableSchema

public TableSchema<T> getTableSchema()

Description copied from interface: MappedIndex

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

Specified by:

getTableSchema in interface MappedIndex<T>

Returns:

The TableSchema object for this mapped table.

getDynamoDbClient

public DynamoDbClient getDynamoDbClient()

getTableName

public String getTableName()

Description copied from interface: MappedIndex

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

Specified by:

getTableName in interface MappedIndex<T>

Returns:

The physical table name.

getIndexName

public String getIndexName()

Description copied from interface: MappedIndex

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

Specified by:

getIndexName in interface MappedIndex<T>

Returns:

The physical secondary index name.

keyFrom

public Key keyFrom(T item)

Description copied from interface: MappedIndex

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