com.amazonaws.services.dynamodbv2.datamodeling

Class DynamoDBMapperTableModel<T>

java.lang.Object

com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapperTableModel<T>

Type Parameters:

T - The object type.

All Implemented Interfaces:

DynamoDBTypeConverter<Map<String,AttributeValue>,T>

public final class DynamoDBMapperTableModel<T>
extends Object
implements DynamoDBTypeConverter<Map<String,AttributeValue>,T>

Table model.

Method Summary

Modifier and Type	Method and Description
boolean	anyKeyGeneratable(T object, DynamoDBMapperConfig.SaveBehavior saveBehavior) Determnes if any of the primary keys require auto-generation.
Map<String,AttributeValue>	convert(T object) Turns an object of type T into an object of type S.
<V> DynamoDBMapperFieldModel<T,V>	field(KeyType keyType) Gets the field model for a given key type.
<V> DynamoDBMapperFieldModel<T,V>	field(String attributeName) Gets the field model for a given attribute.
Collection<DynamoDBMapperFieldModel<T,Object>>	fields() Gets all the field models for the given class.
GlobalSecondaryIndex	globalSecondaryIndex(String indexName) Gets the global secondary index.
Collection<GlobalSecondaryIndex>	globalSecondaryIndexes() Gets the global secondary indexes for the given class.
<H> DynamoDBMapperFieldModel<T,H>	hashKey() Gets the hash key field model for the specified type.
Collection<DynamoDBMapperFieldModel<T,Object>>	keys() Gets all the key field models for the given class.
LocalSecondaryIndex	localSecondaryIndex(String indexName) Gets the local secondary index by name.
Collection<LocalSecondaryIndex>	localSecondaryIndexes() Gets the local secondary indexes for the given class.
<H,R> Map<String,AttributeValue>	mapKey(H hashKey, R rangeKey) Creates a new key map from the specified hash and range key.
<H,R> Map<String,AttributeValue>	mapKey(T object) Creates a new key map from the specified object.
<H,R> T	newKey(H hashKey, R rangeKey) Creates a new object instance with the keys populated.
<R> DynamoDBMapperFieldModel<T,R>	rangeKey() Gets the range key field model for the specified type.
<R> DynamoDBMapperFieldModel<T,R>	rangeKeyIfExists() Gets the range key field model for the specified type.
String	tableName() Gets the table name.
Class<T>	targetType() Gets the object type.
T	unconvert(Map<String,AttributeValue> object) Turns an object of type S into an objext of type T.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

targetType

public Class<T> targetType()

Gets the object type.

Returns:

The object type.

tableName

public String tableName()

Gets the table name.

Returns:

The table name.

fields

public Collection<DynamoDBMapperFieldModel<T,Object>> fields()

Gets all the field models for the given class.

Returns:

The field models.

field

public <V> DynamoDBMapperFieldModel<T,V> field(String attributeName)

Gets the field model for a given attribute.

Type Parameters:

V - The field model's value type.

Parameters:

attributeName - The attribute name.

Returns:

The field model.

field

public <V> DynamoDBMapperFieldModel<T,V> field(KeyType keyType)

Gets the field model for a given key type.

Type Parameters:

V - The field model's value type.

Parameters:

keyType - The key type.

Returns:

The field model.

keys

public Collection<DynamoDBMapperFieldModel<T,Object>> keys()

Gets all the key field models for the given class.

Returns:

The field models.

hashKey

public <H> DynamoDBMapperFieldModel<T,H> hashKey()

Gets the hash key field model for the specified type.

Type Parameters:

H - The hash key type.

Returns:

The hash key field model.

Throws:

DynamoDBMappingException - If the hash key is not present.

rangeKey

public <R> DynamoDBMapperFieldModel<T,R> rangeKey()

Gets the range key field model for the specified type.

Type Parameters:

R - The range key type.

Returns:

The range key field model.

Throws:

DynamoDBMappingException - If the range key is not present.

rangeKeyIfExists

public <R> DynamoDBMapperFieldModel<T,R> rangeKeyIfExists()

Gets the range key field model for the specified type.

Type Parameters:

R - The range key type.

Returns:

The range key field model, or null if not present.

globalSecondaryIndexes

public Collection<GlobalSecondaryIndex> globalSecondaryIndexes()

Gets the global secondary indexes for the given class.

Returns:

The map of index name to GlobalSecondaryIndexes.

globalSecondaryIndex

public GlobalSecondaryIndex globalSecondaryIndex(String indexName)

Gets the global secondary index.

Parameters:

indexName - The index name.

Returns:

The global secondary index or null.

localSecondaryIndexes

public Collection<LocalSecondaryIndex> localSecondaryIndexes()

Gets the local secondary indexes for the given class.

Parameters:

indexNames - The index names.

Returns:

The map of index name to LocalSecondaryIndexes.

localSecondaryIndex

public LocalSecondaryIndex localSecondaryIndex(String indexName)

Gets the local secondary index by name.

Parameters:

indexNames - The index name.

Returns:

The local secondary index, or null.

convert

public Map<String,AttributeValue> convert(T object)

Turns an object of type T into an object of type S.

Specified by:

convert in interface DynamoDBTypeConverter<Map<String,AttributeValue>,T>

unconvert

public T unconvert(Map<String,AttributeValue> object)

Turns an object of type S into an objext of type T.

Specified by:

unconvert in interface DynamoDBTypeConverter<Map<String,AttributeValue>,T>

newKey

public <H,R> T newKey(H hashKey,
                      R rangeKey)

Creates a new object instance with the keys populated.

Type Parameters:

H - The hash key type.

R - The range key type.

Parameters:

hashKey - The hash key.

rangeKey - The range key (optional if not present on table).

Returns:

The new instance.

mapKey

public <H,R> Map<String,AttributeValue> mapKey(H hashKey,
                                               R rangeKey)

Creates a new key map from the specified hash and range key.

Type Parameters:

H - The hash key type.

R - The range key type.

Parameters:

hashKey - The hash key.

rangeKey - The range key (optional if not present on table).

Returns:

The key map.

mapKey

public <H,R> Map<String,AttributeValue> mapKey(T object)

Creates a new key map from the specified object.

Type Parameters:

H - The hash key type.

R - The range key type.

Parameters:

object - The object instance.

Returns:

The key map.

anyKeyGeneratable

public boolean anyKeyGeneratable(T object,
                                 DynamoDBMapperConfig.SaveBehavior saveBehavior)

Determnes if any of the primary keys require auto-generation.

Parameters:

object - The object instance.

saveBehavior - The save behaviour.

Returns:

True if any keys should be auto-generated.