com.amazonaws.services.dynamodbv2.datamodeling

Class DynamoDBMapperFieldModel<T,V>

java.lang.Object

com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapperFieldModel<T,V>

Type Parameters:

T - The object type.

V - The field model type.

All Implemented Interfaces:

DynamoDBAutoGenerator<V>, DynamoDBTypeConverter<AttributeValue,V>

public class DynamoDBMapperFieldModel<T,V>
extends Object
implements DynamoDBAutoGenerator<V>, DynamoDBTypeConverter<AttributeValue,V>

Field model.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DynamoDBMapperFieldModel.DynamoDBAttributeType
static class	DynamoDBMapperFieldModel.Id<T> The field's "global" identifier.

Nested classes/interfaces inherited from interface com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBTypeConverter

DynamoDBTypeConverter.Factory

Constructor Summary

Constructors

Constructor and Description
DynamoDBMapperFieldModel(String dynamoDBAttributeName, DynamoDBMapperFieldModel.DynamoDBAttributeType dynamoDBAttributeType, ArgumentMarshaller argumentMarshaller) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	anyKey(KeyType... keyTypes) Returns true if the field matches any key or index key.
Condition	beginsWith(V value) Creates a condition which filters on the specified value.
Condition	between(V lo, V hi) Creates a condition which filters on the specified values.
Condition	betweenAny(V lo, V hi) Creates a condition which filters on any non-null argument; if lo is null a LE condition is applied on hi, if hi is null a GE condition is applied on lo.
boolean	canGenerate(T object, DynamoDBMapperConfig.SaveBehavior saveBehavior, DynamoDBMapperTableModel<T> model) Determines if the mapping value can be auto-generated.
Condition	contains(V value) Creates a condition which filters on the specified value.
AttributeValue	convert(V object) Turns an object of type T into an object of type S.
Collection<AttributeValue>	convertAll(Collection<V> values) Converts the object values into AttributeValues.
AttributeDefinition	definition() Gets the attribute deinition for this field.
Condition	eq(V value) Creates a condition which filters on the specified value.
ExpectedAttributeValue	expectedExists(V value) Creates an expectation that the value should exist.
ExpectedAttributeValue	expectedIfExists(V value) Creates an expectation that the value should exist if the value is not null or an expectation that the value should not exist otherwise.
ExpectedAttributeValue	expectedNotExists() Creates an expectation that the value should not exist.
Condition	ge(V value) Creates a condition which filters on the specified value.
V	generate(V currentValue) Generates a new value given the current value (or null) if applicable.
AttributeValue	generateAndConvert(T object) Get the current value from the object and generates a new value.
V	get(T object) Gets the value from the object instance.
AttributeValue	getAndConvert(T object) Get the current value from the object and convert it.
String	getDynamoDBAttributeName() Returns the name of the DynamoDB attribute this mapped field will be stored as.
DynamoDBMapperFieldModel.DynamoDBAttributeType	getDynamoDBAttributeType() Returns the type of the DynamoDB attribute this mapped field will be stored as.
DynamoDBAutoGenerateStrategy	getGenerateStrategy() Gets the auto-generate strategy.
List<String>	globalSecondaryIndexNames(KeyType keyType) Gets the global secondary indexes.
Condition	gt(V value) Creates a condition which filters on the specified value.
DynamoDBMapperFieldModel.Id<T>	id() Gets the ID.
Condition	in(Collection<V> values) Creates a condition which filters on the specified values.
Condition	in(V... values) Creates a condition which filters on the specified values.
Condition	isNull() Creates a condition which filters on the specified value.
KeyType	keyType() Gets the key type.
Condition	le(V value) Creates a condition which filters on the specified value.
List<String>	localSecondaryIndexNames() Gets the local secondary indexes.
Condition	lt(V value) Creates a condition which filters on the specified value.
String	name() Gets the attribute name.
Condition	ne(V value) Creates a condition which filters on the specified value.
Condition	notContains(V value) Creates a condition which filters on the specified value.
Condition	notNull() Creates a condition which filters on the specified value.
void	set(T object, V value) Sets the value on the object instance.
V	unconvert(AttributeValue object) Turns an object of type S into an objext of type T.
Collection<V>	unconvertAll(Collection<AttributeValue> values) Unconverts the AttributeValues into the object value.
void	unconvertAndSet(T object, AttributeValue value) Unconverts the value and sets it on the object.
boolean	versioned() Indicates if this attribute is a version attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamoDBMapperFieldModel

@Deprecated
public DynamoDBMapperFieldModel(String dynamoDBAttributeName,
                                            DynamoDBMapperFieldModel.DynamoDBAttributeType dynamoDBAttributeType,
                                            ArgumentMarshaller argumentMarshaller)

Deprecated.

Method Detail

getDynamoDBAttributeName

public String getDynamoDBAttributeName()

Returns the name of the DynamoDB attribute this mapped field will be stored as.

getDynamoDBAttributeType

public DynamoDBMapperFieldModel.DynamoDBAttributeType getDynamoDBAttributeType()

Returns the type of the DynamoDB attribute this mapped field will be stored as.

id

public final DynamoDBMapperFieldModel.Id<T> id()

Gets the ID.

Returns:

The ID.

name

public final String name()

Gets the attribute name.

Returns:

The attribute name.

get

public final V get(T object)

Gets the value from the object instance.

Parameters:

object - The object instance.

Returns:

The value.

set

public final void set(T object,
                      V value)

Sets the value on the object instance.

Parameters:

object - The object instance.

value - The value.

canGenerate

public final boolean canGenerate(T object,
                                 DynamoDBMapperConfig.SaveBehavior saveBehavior,
                                 DynamoDBMapperTableModel<T> model)

Determines if the mapping value can be auto-generated.

Parameters:

object - The object instance.

saveBehavior - The save behaviour.

model - The table model.

Returns:

True if can be auto-generated, false otherwise.

versioned

public final boolean versioned()

Indicates if this attribute is a version attribute.

Returns:

True if it is, false otherwise.

getGenerateStrategy

public final DynamoDBAutoGenerateStrategy getGenerateStrategy()

Gets the auto-generate strategy.

Specified by:

getGenerateStrategy in interface DynamoDBAutoGenerator<V>

generate

public final V generate(V currentValue)

Generates a new value given the current value (or null) if applicable.

Specified by:

generate in interface DynamoDBAutoGenerator<V>

convert

public final AttributeValue convert(V object)

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

Specified by:

convert in interface DynamoDBTypeConverter<AttributeValue,V>

unconvert

public final V unconvert(AttributeValue object)

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

Specified by:

unconvert in interface DynamoDBTypeConverter<AttributeValue,V>

keyType

public final KeyType keyType()

Gets the key type.

Returns:

The key type, or null if not a key.

globalSecondaryIndexNames

public final List<String> globalSecondaryIndexNames(KeyType keyType)

Gets the global secondary indexes.

Parameters:

keyType - The key type.

Returns:

The list of global secondary indexes.

localSecondaryIndexNames

public final List<String> localSecondaryIndexNames()

Gets the local secondary indexes.

Returns:

The list of local secondary indexes.

anyKey

public final boolean anyKey(KeyType... keyTypes)

Returns true if the field matches any key or index key.

Parameters:

keyTypes - The key types.

Returns:

True if matching any key type.

definition

public final AttributeDefinition definition()

Gets the attribute deinition for this field.

Returns:

The attribute definition.

generateAndConvert

public final AttributeValue generateAndConvert(T object)

Get the current value from the object and generates a new value.

Parameters:

object - The object instance.

Returns:

The generated value.

getAndConvert

public final AttributeValue getAndConvert(T object)

Get the current value from the object and convert it.

Parameters:

object - The object instance.

Returns:

The converted value.

unconvertAndSet

public final void unconvertAndSet(T object,
                                  AttributeValue value)

Unconverts the value and sets it on the object.

Parameters:

object - The object instance.

value - The attribute value.

convertAll

public final Collection<AttributeValue> convertAll(Collection<V> values)

Converts the object values into AttributeValues.

Parameters:

values - The object values.

Returns:

The attribute values.

unconvertAll

public final Collection<V> unconvertAll(Collection<AttributeValue> values)

Unconverts the AttributeValues into the object value.

Parameters:

values - The attribute values.

Returns:

The field model values.

expectedExists

public final ExpectedAttributeValue expectedExists(V value)

Creates an expectation that the value should exist.

Parameters:

value - The value.

Returns:

The expected value.

See Also:

DynamoDBSaveExpression.withExpectedEntry(java.lang.String, com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue), DynamoDBDeleteExpression.withExpectedEntry(java.lang.String, com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue), ExpectedAttributeValue

expectedNotExists

public final ExpectedAttributeValue expectedNotExists()

Creates an expectation that the value should not exist.

Returns:

The expected value.

See Also:

DynamoDBSaveExpression.withExpectedEntry(java.lang.String, com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue), DynamoDBDeleteExpression.withExpectedEntry(java.lang.String, com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue), ExpectedAttributeValue

expectedIfExists

public final ExpectedAttributeValue expectedIfExists(V value)

Creates an expectation that the value should exist if the value is not null or an expectation that the value should not exist otherwise.

Parameters:

value - The value.

Returns:

The expected value.

See Also:

DynamoDBSaveExpression.withExpectedEntry(java.lang.String, com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue), DynamoDBDeleteExpression.withExpectedEntry(java.lang.String, com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue), ExpectedAttributeValue

beginsWith

public final Condition beginsWith(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.BEGINS_WITH, Condition

between

public final Condition between(V lo,
                               V hi)

Creates a condition which filters on the specified values.

Parameters:

lo - The start of the range (inclusive).

hi - The end of the range (inclusive).

Returns:

The condition.

See Also:

ComparisonOperator.BETWEEN, Condition

contains

public final Condition contains(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.CONTAINS, Condition

eq

public final Condition eq(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.EQ, Condition

ge

public final Condition ge(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.GE, Condition

gt

public final Condition gt(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.GT, Condition

in

public final Condition in(V... values)

Creates a condition which filters on the specified values.

Parameters:

values - The values.

Returns:

The condition.

See Also:

ComparisonOperator.IN, Condition

in

public final Condition in(Collection<V> values)

Creates a condition which filters on the specified values.

Parameters:

values - The values.

Returns:

The condition.

See Also:

ComparisonOperator.IN, Condition

isNull

public final Condition isNull()

Creates a condition which filters on the specified value.

Returns:

The condition.

See Also:

ComparisonOperator.NULL, Condition

le

public final Condition le(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.LE, Condition

lt

public final Condition lt(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.LT, Condition

ne

public final Condition ne(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.NE, Condition

notContains

public final Condition notContains(V value)

Creates a condition which filters on the specified value.

Parameters:

value - The value.

Returns:

The condition.

See Also:

ComparisonOperator.NOT_CONTAINS, Condition

notNull

public final Condition notNull()

Creates a condition which filters on the specified value.

Returns:

The condition.

See Also:

ComparisonOperator.NOT_NULL, Condition

betweenAny

public final Condition betweenAny(V lo,
                                  V hi)

Creates a condition which filters on any non-null argument; if lo is null a LE condition is applied on hi, if hi is null a GE condition is applied on lo.

Parameters:

lo - The start of the range (inclusive).

hi - The end of the range (inclusive).

Returns:

The condition or null if both arguments are null.

See Also:

ComparisonOperator.BETWEEN, ComparisonOperator.EQ, ComparisonOperator.GE, ComparisonOperator.LE, Condition