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
DynamoDbClient	dynamoDbClient()
boolean	equals(Object o)
<R> R	execute(IndexOperation<T,?,?,R> operationToPerform) Executes a command that is expected to return a single data item against the database with the context of the specific table and secondary index this object is linked to.
<R> SdkIterable<R>	execute(PaginatedIndexOperation<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 specific table and secondary index this object is linked to.
int	hashCode()
String	indexName() Gets the physical secondary index name that operations performed by this object will be executed against.
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(IndexOperation<T,?,?,R> operationToPerform)

Description copied from interface: MappedIndex

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

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.

execute

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

Description copied from interface: MappedIndex

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

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:

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

mapperExtension

public MapperExtension mapperExtension()

Description copied from interface: MappedIndex

Gets the MapperExtension associated with this mapped resource.

Specified by:

mapperExtension in interface MappedIndex<T>

Returns:

The MapperExtension associated with this mapped resource.

tableSchema

public TableSchema<T> tableSchema()

Description copied from interface: MappedIndex

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

Specified by:

tableSchema in interface MappedIndex<T>

Returns:

The TableSchema object for this mapped table.

dynamoDbClient

public DynamoDbClient dynamoDbClient()

tableName

public String tableName()

Description copied from interface: MappedIndex

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

Specified by:

tableName in interface MappedIndex<T>

Returns:

The physical table name.

indexName

public String indexName()

Description copied from interface: MappedIndex

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

Specified by:

indexName 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