public final class StaticTableSchema<T> extends Object implements TableSchema<T>
TableSchema that builds a schema based on directly declared attributes and methods to
get and set those attributes. This is the most direct, and thus fastest, implementation of TableSchema.
Example using a fictional 'Customer' data item class:-
static final TableSchema<Customer> CUSTOMER_TABLE_SCHEMA =
StaticTableSchema.builder(Customer.class)
.newItemSupplier(Customer::new)
.addAttribute(String.class, a -> a.name("account_id")
.getter(Customer::getAccountId)
.setter(Customer::setAccountId)
.tags(primaryPartitionKey()))
.addAttribute(Integer.class, a -> a.name("sub_id")
.getter(Customer::getSubId)
.setter(Customer::setSubId)
.tags(primarySortKey()))
.addAttribute(String.class, a -> a.name("name")
.getter(Customer::getName)
.setter(Customer::setName)
.tags(secondaryPartitionKey("customers_by_name")))
.addAttribute(Instant.class, a -> a.name("created_date")
.getter(Customer::getCreatedDate)
.setter(Customer::setCreatedDate)
.tags(secondarySortKey("customers_by_date"),
secondarySortKey("customers_by_name")))
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
StaticTableSchema.Builder<T>
Builder for a
StaticTableSchema |
| Modifier and Type | Method and Description |
|---|---|
AttributeConverterProvider |
attributeConverterProvider()
The table schema
AttributeConverterProvider. |
AttributeValue |
attributeValue(T item,
String key)
Returns a single attribute value from the modelled object.
|
static <T> StaticTableSchema.Builder<T> |
builder(Class<T> itemClass)
Creates a builder for a
StaticTableSchema typed to specific data item class. |
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. |
EnhancedType<T> |
itemType()
Returns the
EnhancedType that represents the 'Type' of the Java object this table schema object maps to
and from. |
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.
|
StaticTableMetadata |
tableMetadata()
Returns the object that describes the structure of the table being modelled by the mapper.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitfromBeanpublic static <T> StaticTableSchema.Builder<T> builder(Class<T> itemClass)
StaticTableSchema typed to specific data item class.builder in interface TableSchema<T>T - The type of the item this TableSchema will map records to.itemClass - The data item class object that the StaticTableSchema is to map to.public StaticTableMetadata tableMetadata()
TableSchematableMetadata in interface TableSchema<T>TableMetadata object that contains structural information about the table being modelled.public T mapToItem(Map<String,AttributeValue> attributeMap)
TableSchemaIf 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.
mapToItem in interface TableSchema<T>attributeMap - A map of String to AttributeValue that contains all the raw attributes to map.public Map<String,AttributeValue> itemToMap(T item, boolean ignoreNulls)
TableSchemaAttributeValue that the DynamoDb low-level
SDK can work with.itemToMap in interface TableSchema<T>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.AttributeValue representing all the modelled attributes in the model object.public Map<String,AttributeValue> itemToMap(T item, Collection<String> attributes)
TableSchemaAttributeValue 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.itemToMap in interface TableSchema<T>item - The modelled Java object to extract the map of attributes from.attributes - A collection of attribute names to extract into the output map.AttributeValue representing the requested modelled attributes in the model
object.public AttributeValue attributeValue(T item, String key)
TableSchemaattributeValue in interface TableSchema<T>item - The modelled Java object to extract the attribute from.key - The attribute name describing which attribute to extract.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.public EnhancedType<T> itemType()
TableSchemaEnhancedType that represents the 'Type' of the Java object this table schema object maps to
and from.itemType in interface TableSchema<T>EnhancedType of the modelled item this TableSchema maps to.public AttributeConverterProvider attributeConverterProvider()
AttributeConverterProvider.attributeConverterProviderCopyright © 2020. All rights reserved.