DynamoDbMapperTableModel (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.dynamodb.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.

Nested Class Summary
- Nested classes/interfaces inherited from interface software.amazon.awssdk.services.dynamodb.datamodeling.DynamoDbTypeConverter
  DynamoDbTypeConverter.AbstractConverter<S,T>, DynamoDbTypeConverter.DelegateConverter<S,T>, DynamoDbTypeConverter.ExtendedConverter<S,U,T>, DynamoDbTypeConverter.NullSafeConverter<S,T>

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,AttributeValue>`	`convert(T object)`	Turns an object of type T into an object of type S.
`<H,R> Map<String,AttributeValue>`	`convertKey(H hashKey, R rangeKey)`	Creates a new key map from the specified hash and range key.
`<H,R> Map<String,AttributeValue>`	`convertKey(T key)`	Creates a new key map from the specified object.
`<H,R> T`	`createKey(H hashKey, R rangeKey)`	Creates a new object instance with the keys populated.
`<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.
`<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.
`Class<T>`	`targetType()`	Gets the object type.
`T`	`unconvert(Map<String,AttributeValue> object)`	Turns an object of type S into an object of type T.
`boolean`	`versioned()`	Indicates if this table has any versioned attributes.
`Collection<DynamoDbMapperFieldModel<T,Object>>`	`versions()`	Gets all the version fields for the given class.

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.
  - 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.
  - 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.
  - versions
```
public Collection<DynamoDbMapperFieldModel<T,Object>> versions()
```
    Gets all the version fields for the given class.
    
    Returns:
    
    The field models.
  - versioned
```
public boolean versioned()
```
    Indicates if this table has any versioned attributes.
    
    Returns:
    
    True if any versioned attributes, false otherwise.
  - 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.
    
    Returns:
    
    The map of index name to LocalSecondaryIndexes.
  - localSecondaryIndex
```
public LocalSecondaryIndex localSecondaryIndex(String indexName)
```
    Gets the local secondary index by name.
    
    Parameters:
    
    indexName - 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 object of type T.
    
    Specified by:
    
    unconvert in interface DynamoDbTypeConverter<Map<String,AttributeValue>,T>
  - createKey
```
public <H,R> T createKey(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.
  - convertKey
```
public <H,R> Map<String,AttributeValue> convertKey(T key)
```
    Creates a new key map from the specified object.
    
    Type Parameters:
    
    H - The hash key type.
    
    R - The range key type.
    
    Returns:
    
    The key map.
  - convertKey
```
public <H,R> Map<String,AttributeValue> convertKey(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.

Class DynamoDbMapperTableModel<T>

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.dynamodb.datamodeling.DynamoDbTypeConverter

Method Summary

Methods inherited from class java.lang.Object

Method Detail

targetType

fields

field

keys

hashKey

rangeKey

rangeKeyIfExists

versions

versioned

globalSecondaryIndexes

globalSecondaryIndex

localSecondaryIndexes

localSecondaryIndex

convert

unconvert

createKey

convertKey

convertKey