com.amazonaws.services.dynamodbv2.datamodeling

Class DynamoDBMapper.SaveObjectHandler

java.lang.Object

com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapper.SaveObjectHandler

Enclosing class:

DynamoDBMapper

protected abstract class DynamoDBMapper.SaveObjectHandler
extends Object

The handler for saving object using DynamoDBMapper. Caller should implement the abstract methods to provide the expected behavior on each scenario, and this handler will take care of all the other basic workflow and common operations.

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<?>	clazz
protected Object	object

Constructor Summary

Constructors

Constructor and Description
SaveObjectHandler(Class<?> clazz, Object object, String tableName, DynamoDBMapperConfig.SaveBehavior saveBehavior, Map<String,ExpectedAttributeValue> userProvidedExpectedValues) Constructs a handler for saving the specified model object.

Method Summary

Modifier and Type	Method and Description
void	execute() The general workflow of a save operation.
protected abstract void	executeLowLevelRequest(boolean onlyKeyAttributeSpecified) Implement this method to send the low-level request that is necessary to complete the save operation.
protected Map<String,AttributeValueUpdate>	getAttributeValueUpdates() Get the map of AttributeValueUpdate on each modeled attribute.
protected Map<String,ExpectedAttributeValue>	getExpectedAttributeValues() Get the map of ExpectedAttributeValue on each modeled attribute.
protected List<com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapper.ValueUpdate>	getInMemoryUpdates() Get the list of all the necessary in-memory update on the object.
protected Map<String,AttributeValue>	getKeyAttributeValues() Get the map of all the specified key of the saved object.
protected DynamoDBMapperConfig.SaveBehavior	getLocalSaveBehavior() Get the SaveBehavior used locally for this save operation.
protected String	getTableName() Get the table name
protected abstract void	onKeyAttributeValue(String attributeName, AttributeValue keyAttributeValue) Implement this method to do the necessary operations when a key attribute is set with some value.
protected void	onNonKeyAttribute(String attributeName, AttributeValue currentValue) Implement this method for necessary operations when a non-key attribute is set a non-null value in the object.
protected abstract void	onNullNonKeyAttribute(String attributeName) Implement this method for necessary operations when a non-key attribute is set null in the object.

Methods inherited from class java.lang.Object

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

Field Detail

object

protected final Object object

clazz

protected final Class<?> clazz

Constructor Detail

SaveObjectHandler

public SaveObjectHandler(Class<?> clazz,
                         Object object,
                         String tableName,
                         DynamoDBMapperConfig.SaveBehavior saveBehavior,
                         Map<String,ExpectedAttributeValue> userProvidedExpectedValues)

Constructs a handler for saving the specified model object.

Parameters:

object - The model object to be saved.

clazz - The domain class of the object.

tableName - The table name.

userProvidedExpectedValues - Any expected values that should be applied to the save

Method Detail

execute

public void execute()

The general workflow of a save operation.

onKeyAttributeValue

protected abstract void onKeyAttributeValue(String attributeName,
                                            AttributeValue keyAttributeValue)

Implement this method to do the necessary operations when a key attribute is set with some value.

Parameters:

attributeName - The name of the key attribute.

keyAttributeValue - The AttributeValue of the key attribute as specified in the object.

onNonKeyAttribute

protected void onNonKeyAttribute(String attributeName,
                                 AttributeValue currentValue)

Implement this method for necessary operations when a non-key attribute is set a non-null value in the object. The default implementation simply adds a "PUT" update for the given attribute.

Parameters:

attributeName - The name of the non-key attribute.

currentValue - The updated value of the given attribute.

onNullNonKeyAttribute

protected abstract void onNullNonKeyAttribute(String attributeName)

Implement this method for necessary operations when a non-key attribute is set null in the object.

Parameters:

attributeName - The name of the non-key attribute.

executeLowLevelRequest

protected abstract void executeLowLevelRequest(boolean onlyKeyAttributeSpecified)

Implement this method to send the low-level request that is necessary to complete the save operation.

Parameters:

onlyKeyAttributeSpecified - Whether the object to be saved is only specified with key attributes.

getLocalSaveBehavior

protected DynamoDBMapperConfig.SaveBehavior getLocalSaveBehavior()

Get the SaveBehavior used locally for this save operation.

getTableName

protected String getTableName()

Get the table name

getKeyAttributeValues

protected Map<String,AttributeValue> getKeyAttributeValues()

Get the map of all the specified key of the saved object.

getAttributeValueUpdates

protected Map<String,AttributeValueUpdate> getAttributeValueUpdates()

Get the map of AttributeValueUpdate on each modeled attribute.

getExpectedAttributeValues

protected Map<String,ExpectedAttributeValue> getExpectedAttributeValues()

Get the map of ExpectedAttributeValue on each modeled attribute.

getInMemoryUpdates

protected List<com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapper.ValueUpdate> getInMemoryUpdates()

Get the list of all the necessary in-memory update on the object.