software.amazon.awssdk.extensions.dynamodb.mappingclient.staticmapper

Class StaticTableSchema<T>

java.lang.Object

software.amazon.awssdk.extensions.dynamodb.mappingclient.staticmapper.StaticTableSchema<T>

All Implemented Interfaces:

TableSchema<T>

public class StaticTableSchema<T>
extends Object
implements TableSchema<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StaticTableSchema.Builder<T>
static class	StaticTableSchema.GenericBuilder

Method Summary

Modifier and Type	Method and Description
static StaticTableSchema.GenericBuilder	builder() Returns a builder for the default implementation of this interface which is an immutable, declarative, type-safe mapper.
AttributeValue	getAttributeValue(T item, String key) Returns a single attribute value from the modelled object.
StaticTableMetadata	getTableMetadata() Returns the object that describes the structure of the table being modelled by the mapper.
Map<String,AttributeValue>	itemToMap(T item, boolean ignoreNulls) Takes a modelled object and converts it into a raw map of AttributeValue that the DynamoDb low-level SDK can work with.
Map<String,AttributeValue>	itemToMap(T item, Collection<String> attributes) Takes a modelled object and extracts a specific set of attributes which are then returned as a map of AttributeValue that the DynamoDb low-level SDK can work with.
T	mapToItem(Map<String,AttributeValue> attributeMap) Takes a raw DynamoDb SDK representation of a record in a table and maps it to a Java object.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static StaticTableSchema.GenericBuilder builder()

Description copied from interface: TableSchema

Returns a builder for the default implementation of this interface which is an immutable, declarative, type-safe mapper. See StaticTableSchema for more information.

Specified by:

builder in interface TableSchema<T>

Returns:

A default builder for a StaticTableSchema.

getTableMetadata

public StaticTableMetadata getTableMetadata()

Description copied from interface: TableSchema

Returns the object that describes the structure of the table being modelled by the mapper. This includes information such as the table name, index keys and attribute tags.

Specified by:

getTableMetadata in interface TableSchema<T>

Returns:

A TableMetadata object that contains structural information about the table being modelled.

mapToItem

public T mapToItem(Map<String,AttributeValue> attributeMap)

Description copied from interface: TableSchema

Takes a raw DynamoDb SDK representation of a record in a table and maps it to a Java object. A new object is created to fulfil this operation. If attributes are missing from the map, that will not cause an error, however if attributes are found in the map which the mapper does not know how to map, an exception will be thrown.

Specified by:

mapToItem in interface TableSchema<T>

Parameters:

attributeMap - A map of String to AttributeValue that contains all the raw attributes to map.

Returns:

A new instance of a Java object with all the attributes mapped onto it.

itemToMap

public Map<String,AttributeValue> itemToMap(T item,
                                            boolean ignoreNulls)

Description copied from interface: TableSchema

Takes a modelled object and converts it into a raw map of AttributeValue that the DynamoDb low-level SDK can work with.

Specified by:

itemToMap in interface TableSchema<T>

Parameters:

item - The modelled Java object to convert into a map of attributes.

ignoreNulls - If set to true; any null values in the Java object will not be added to the output map. If set to false; null values in the Java object will be added as AttributeValue of type 'nul' to the output map.

Returns:

A map of String to AttributeValue representing all the modelled attributes in the model object.

itemToMap

public Map<String,AttributeValue> itemToMap(T item,
                                            Collection<String> attributes)

Description copied from interface: TableSchema

Takes a modelled object and extracts a specific set of attributes which are then returned as a map of AttributeValue that the DynamoDb low-level SDK can work with. This method is typically used to extract just the key attributes of a modelled item and will not ignore nulls on the modelled object.

Specified by:

itemToMap in interface TableSchema<T>

Parameters:

item - The modelled Java object to extract the map of attributes from.

attributes - A collection of attribute names to extract into the output map.

Returns:

A map of String to AttributeValue representing the requested modelled attributes in the model object.

getAttributeValue

public AttributeValue getAttributeValue(T item,
                                        String key)

Description copied from interface: TableSchema

Returns a single attribute value from the modelled object.

Specified by:

getAttributeValue in interface TableSchema<T>

Parameters:

item - The modelled Java object to extract the attribute from.

key - The attribute name describing which attribute to extract.

Returns:

A single AttributeValue representing the requested modelled attribute in the model object or null if the attribute has not been set with a value in the modelled object.