com.tomtom.speedtools.mongodb

Class MongoDBUpdate

java.lang.Object

com.tomtom.speedtools.mongodb.MongoDBUpdate

public class MongoDBUpdate
extends Object

Utility to facilitate creating mongo update objects using mapper fields. Fields in nested objects can be addressed. Query values are type-safe. Example:

 collection.update(
   new MongoDBQuery().
     eq(personMapper.lastName, "Henderson"),
   new MongoDBUpdate().
     set(personMapper.address.street, "Sunset blvd."));
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATOR_ADD_TO_SET
static String	OPERATOR_INC
static String	OPERATOR_POP_FIRST
static String	OPERATOR_POP_LAST
static String	OPERATOR_PULL
static String	OPERATOR_PUSH
static String	OPERATOR_PUSH_ALL
static String	OPERATOR_SET
static String	OPERATOR_UNSET

Constructor Summary

Constructors

Constructor and Description
MongoDBUpdate()

Method Summary

Modifier and Type	Method and Description
<T> MongoDBUpdate	addToSet(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.HasFieldName f2, EntityMapper.Field<Collection<T>> f3, T value)
<T> MongoDBUpdate	addToSet(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.Field<Collection<T>> f2, T value)
<T> MongoDBUpdate	addToSet(EntityMapper.HasFieldName f0, EntityMapper.Field<Collection<T>> f1, T value)
<T> MongoDBUpdate	addToSet(EntityMapper.Field<Collection<T>> f0, T value)
<T> MongoDBUpdate	inc(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.HasFieldName f2, EntityMapper.Field<Collection<T>> f3, T value)
<T> MongoDBUpdate	inc(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.Field<Collection<T>> f2, T value)
<T> MongoDBUpdate	inc(EntityMapper.HasFieldName f0, EntityMapper.Field<Collection<T>> f1, T value)
<T> MongoDBUpdate	inc(EntityMapper.Field<Collection<T>> f0, T value)
<T> MongoDBUpdate	popFirst(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.HasFieldName f2, EntityMapper.Field<Collection<T>> f3)
<T> MongoDBUpdate	popFirst(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.Field<Collection<T>> f2)
<T> MongoDBUpdate	popFirst(EntityMapper.HasFieldName f0, EntityMapper.Field<Collection<T>> f1)
<T> MongoDBUpdate	popFirst(EntityMapper.Field<Collection<T>> f0)
<T> MongoDBUpdate	popLast(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.HasFieldName f2, EntityMapper.Field<Collection<T>> f3)
<T> MongoDBUpdate	popLast(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.Field<Collection<T>> f2)
<T> MongoDBUpdate	popLast(EntityMapper.HasFieldName f0, EntityMapper.Field<Collection<T>> f1)
<T> MongoDBUpdate	popLast(EntityMapper.Field<Collection<T>> f0)
<T> MongoDBUpdate	pull(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.HasFieldName f2, EntityMapper.Field<Collection<T>> f3, T value)
<T> MongoDBUpdate	pull(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.Field<Collection<T>> f2, T value)
<T> MongoDBUpdate	pull(EntityMapper.HasFieldName f0, EntityMapper.Field<Collection<T>> f1, T value)
<T> MongoDBUpdate	pull(EntityMapper.Field<Collection<T>> f0, MongoDBQuery mongoDBQuery) Removes all occurrences of value from a field, if field is an array.
<T> MongoDBUpdate	pull(EntityMapper.Field<Collection<T>> f0, T value)
<T> MongoDBUpdate	push(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.HasFieldName f2, EntityMapper.Field<Collection<T>> f3, T value)
<T> MongoDBUpdate	push(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.Field<Collection<T>> f2, T value)
<T> MongoDBUpdate	push(EntityMapper.HasFieldName f0, EntityMapper.Field<Collection<T>> f1, T value)
<T> MongoDBUpdate	push(EntityMapper.Field<Collection<T>> f0, T value)
<T> MongoDBUpdate	pushAll(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.HasFieldName f2, EntityMapper.Field<Collection<T>> f3, Collection<T> values)
<T> MongoDBUpdate	pushAll(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.Field<Collection<T>> f2, Collection<T> values)
<T> MongoDBUpdate	pushAll(EntityMapper.HasFieldName f0, EntityMapper.Field<Collection<T>> f1, Collection<T> values)
<T> MongoDBUpdate	pushAll(EntityMapper.Field<Collection<T>> f0, Collection<T> values)
<T> MongoDBUpdate	set(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.HasFieldName f2, EntityMapper.Field<T> f3, T value)
<T> MongoDBUpdate	set(EntityMapper.HasFieldName f0, EntityMapper.HasFieldName f1, EntityMapper.Field<T> f2, T value)
<T> MongoDBUpdate	set(EntityMapper.HasFieldName f0, EntityMapper.Field<T> f1, T value)
<T> MongoDBUpdate	set(EntityMapper.Field<T> f0, T value)
<E> MongoDBUpdate	setAllExcept(EntityMapper<E> mapper, E entity, EntityMapper.Field<?>... fields)
<T> MongoDBUpdate	setRaw(String fieldName, Mapper<T> mapper, T value)
<T> MongoDBUpdate	setRaw(String fieldName, T value)
com.mongodb.DBObject	toDBObject()
String	toString()
MongoDBUpdate	unset(EntityMapper.Field<?>... fs)

Methods inherited from class java.lang.Object

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

Field Detail

OPERATOR_SET

public static final String OPERATOR_SET

See Also:

Constant Field Values

OPERATOR_UNSET

public static final String OPERATOR_UNSET

See Also:

Constant Field Values

OPERATOR_PUSH

public static final String OPERATOR_PUSH

See Also:

Constant Field Values

OPERATOR_PUSH_ALL

public static final String OPERATOR_PUSH_ALL

See Also:

Constant Field Values

OPERATOR_PULL

public static final String OPERATOR_PULL

See Also:

Constant Field Values

OPERATOR_POP_FIRST

public static final String OPERATOR_POP_FIRST

See Also:

Constant Field Values

OPERATOR_POP_LAST

public static final String OPERATOR_POP_LAST

See Also:

Constant Field Values

OPERATOR_INC

public static final String OPERATOR_INC

See Also:

Constant Field Values

OPERATOR_ADD_TO_SET

public static final String OPERATOR_ADD_TO_SET

See Also:

Constant Field Values

Constructor Detail

MongoDBUpdate

public MongoDBUpdate()

Method Detail

set

@Nonnull
public <T> MongoDBUpdate set(@Nonnull
                                      EntityMapper.Field<T> f0,
                                      @Nullable
                                      T value)

set

@Nonnull
public <T> MongoDBUpdate set(@Nonnull
                                      EntityMapper.HasFieldName f0,
                                      @Nonnull
                                      EntityMapper.Field<T> f1,
                                      @Nullable
                                      T value)

set

@Nonnull
public <T> MongoDBUpdate set(@Nonnull
                                      EntityMapper.HasFieldName f0,
                                      @Nonnull
                                      EntityMapper.HasFieldName f1,
                                      @Nonnull
                                      EntityMapper.Field<T> f2,
                                      @Nullable
                                      T value)

set

@Nonnull
public <T> MongoDBUpdate set(@Nonnull
                                      EntityMapper.HasFieldName f0,
                                      @Nonnull
                                      EntityMapper.HasFieldName f1,
                                      @Nonnull
                                      EntityMapper.HasFieldName f2,
                                      @Nonnull
                                      EntityMapper.Field<T> f3,
                                      @Nullable
                                      T value)

setAllExcept

@Nonnull
public <E> MongoDBUpdate setAllExcept(@Nonnull
                                               EntityMapper<E> mapper,
                                               @Nonnull
                                               E entity,
                                               @Nonnull
                                               EntityMapper.Field<?>... fields)
                                        throws MapperException

Throws:

MapperException

setRaw

@Nonnull
public <T> MongoDBUpdate setRaw(@Nonnull
                                         String fieldName,
                                         @Nullable
                                         T value)

setRaw

@Nonnull
public <T> MongoDBUpdate setRaw(@Nonnull
                                         String fieldName,
                                         @Nonnull
                                         Mapper<T> mapper,
                                         @Nullable
                                         T value)

unset

@Nonnull
public MongoDBUpdate unset(@Nonnull
                                    EntityMapper.Field<?>... fs)

push

@Nonnull
public <T> MongoDBUpdate push(@Nonnull
                                       EntityMapper.Field<Collection<T>> f0,
                                       @Nullable
                                       T value)

push

@Nonnull
public <T> MongoDBUpdate push(@Nonnull
                                       EntityMapper.HasFieldName f0,
                                       @Nonnull
                                       EntityMapper.Field<Collection<T>> f1,
                                       @Nullable
                                       T value)

push

@Nonnull
public <T> MongoDBUpdate push(@Nonnull
                                       EntityMapper.HasFieldName f0,
                                       @Nonnull
                                       EntityMapper.HasFieldName f1,
                                       @Nonnull
                                       EntityMapper.Field<Collection<T>> f2,
                                       @Nullable
                                       T value)

push

@Nonnull
public <T> MongoDBUpdate push(@Nonnull
                                       EntityMapper.HasFieldName f0,
                                       @Nonnull
                                       EntityMapper.HasFieldName f1,
                                       @Nonnull
                                       EntityMapper.HasFieldName f2,
                                       @Nonnull
                                       EntityMapper.Field<Collection<T>> f3,
                                       @Nullable
                                       T value)

pushAll

@Nonnull
public <T> MongoDBUpdate pushAll(@Nonnull
                                          EntityMapper.Field<Collection<T>> f0,
                                          Collection<T> values)

pushAll

@Nonnull
public <T> MongoDBUpdate pushAll(@Nonnull
                                          EntityMapper.HasFieldName f0,
                                          @Nonnull
                                          EntityMapper.Field<Collection<T>> f1,
                                          Collection<T> values)

pushAll

@Nonnull
public <T> MongoDBUpdate pushAll(@Nonnull
                                          EntityMapper.HasFieldName f0,
                                          @Nonnull
                                          EntityMapper.HasFieldName f1,
                                          @Nonnull
                                          EntityMapper.Field<Collection<T>> f2,
                                          Collection<T> values)

pushAll

@Nonnull
public <T> MongoDBUpdate pushAll(@Nonnull
                                          EntityMapper.HasFieldName f0,
                                          @Nonnull
                                          EntityMapper.HasFieldName f1,
                                          @Nonnull
                                          EntityMapper.HasFieldName f2,
                                          @Nonnull
                                          EntityMapper.Field<Collection<T>> f3,
                                          Collection<T> values)

pull

@Nonnull
public <T> MongoDBUpdate pull(@Nonnull
                                       EntityMapper.Field<Collection<T>> f0,
                                       @Nullable
                                       T value)

pull

@Nonnull
public <T> MongoDBUpdate pull(@Nonnull
                                       EntityMapper.HasFieldName f0,
                                       @Nonnull
                                       EntityMapper.Field<Collection<T>> f1,
                                       @Nullable
                                       T value)

pull

@Nonnull
public <T> MongoDBUpdate pull(@Nonnull
                                       EntityMapper.HasFieldName f0,
                                       @Nonnull
                                       EntityMapper.HasFieldName f1,
                                       @Nonnull
                                       EntityMapper.Field<Collection<T>> f2,
                                       @Nullable
                                       T value)

pull

@Nonnull
public <T> MongoDBUpdate pull(@Nonnull
                                       EntityMapper.Field<Collection<T>> f0,
                                       @Nonnull
                                       MongoDBQuery mongoDBQuery)

Removes all occurrences of value from a field, if field is an array. If the field is present but is not an array, an error condition is raised. Mongo shell equivalent:

 { $pull : { field : {field2: value} } }
 

Type Parameters:

T - Type.

Parameters:

f0 - The field that holds an array.

mongoDBQuery - The query that matches an element in the array.

Returns:

This instance.

pull

@Nonnull
public <T> MongoDBUpdate pull(@Nonnull
                                       EntityMapper.HasFieldName f0,
                                       @Nonnull
                                       EntityMapper.HasFieldName f1,
                                       @Nonnull
                                       EntityMapper.HasFieldName f2,
                                       @Nonnull
                                       EntityMapper.Field<Collection<T>> f3,
                                       @Nullable
                                       T value)

popFirst

@Nonnull
public <T> MongoDBUpdate popFirst(@Nonnull
                                           EntityMapper.Field<Collection<T>> f0)

popFirst

@Nonnull
public <T> MongoDBUpdate popFirst(@Nonnull
                                           EntityMapper.HasFieldName f0,
                                           @Nonnull
                                           EntityMapper.Field<Collection<T>> f1)

popFirst

@Nonnull
public <T> MongoDBUpdate popFirst(@Nonnull
                                           EntityMapper.HasFieldName f0,
                                           @Nonnull
                                           EntityMapper.HasFieldName f1,
                                           @Nonnull
                                           EntityMapper.Field<Collection<T>> f2)

popFirst

@Nonnull
public <T> MongoDBUpdate popFirst(@Nonnull
                                           EntityMapper.HasFieldName f0,
                                           @Nonnull
                                           EntityMapper.HasFieldName f1,
                                           @Nonnull
                                           EntityMapper.HasFieldName f2,
                                           @Nonnull
                                           EntityMapper.Field<Collection<T>> f3)

popLast

@Nonnull
public <T> MongoDBUpdate popLast(@Nonnull
                                          EntityMapper.Field<Collection<T>> f0)

popLast

@Nonnull
public <T> MongoDBUpdate popLast(@Nonnull
                                          EntityMapper.HasFieldName f0,
                                          @Nonnull
                                          EntityMapper.Field<Collection<T>> f1)

popLast

@Nonnull
public <T> MongoDBUpdate popLast(@Nonnull
                                          EntityMapper.HasFieldName f0,
                                          @Nonnull
                                          EntityMapper.HasFieldName f1,
                                          @Nonnull
                                          EntityMapper.Field<Collection<T>> f2)

popLast

@Nonnull
public <T> MongoDBUpdate popLast(@Nonnull
                                          EntityMapper.HasFieldName f0,
                                          @Nonnull
                                          EntityMapper.HasFieldName f1,
                                          @Nonnull
                                          EntityMapper.HasFieldName f2,
                                          @Nonnull
                                          EntityMapper.Field<Collection<T>> f3)

inc

@Nonnull
public <T> MongoDBUpdate inc(@Nonnull
                                      EntityMapper.Field<Collection<T>> f0,
                                      @Nullable
                                      T value)

inc

@Nonnull
public <T> MongoDBUpdate inc(@Nonnull
                                      EntityMapper.HasFieldName f0,
                                      @Nonnull
                                      EntityMapper.Field<Collection<T>> f1,
                                      @Nullable
                                      T value)

inc

@Nonnull
public <T> MongoDBUpdate inc(@Nonnull
                                      EntityMapper.HasFieldName f0,
                                      @Nonnull
                                      EntityMapper.HasFieldName f1,
                                      @Nonnull
                                      EntityMapper.Field<Collection<T>> f2,
                                      @Nullable
                                      T value)

inc

@Nonnull
public <T> MongoDBUpdate inc(@Nonnull
                                      EntityMapper.HasFieldName f0,
                                      @Nonnull
                                      EntityMapper.HasFieldName f1,
                                      @Nonnull
                                      EntityMapper.HasFieldName f2,
                                      @Nonnull
                                      EntityMapper.Field<Collection<T>> f3,
                                      @Nullable
                                      T value)

addToSet

@Nonnull
public <T> MongoDBUpdate addToSet(@Nonnull
                                           EntityMapper.Field<Collection<T>> f0,
                                           @Nullable
                                           T value)

addToSet

@Nonnull
public <T> MongoDBUpdate addToSet(@Nonnull
                                           EntityMapper.HasFieldName f0,
                                           @Nonnull
                                           EntityMapper.Field<Collection<T>> f1,
                                           @Nullable
                                           T value)

addToSet

@Nonnull
public <T> MongoDBUpdate addToSet(@Nonnull
                                           EntityMapper.HasFieldName f0,
                                           @Nonnull
                                           EntityMapper.HasFieldName f1,
                                           @Nonnull
                                           EntityMapper.Field<Collection<T>> f2,
                                           @Nullable
                                           T value)

addToSet

@Nonnull
public <T> MongoDBUpdate addToSet(@Nonnull
                                           EntityMapper.HasFieldName f0,
                                           @Nonnull
                                           EntityMapper.HasFieldName f1,
                                           @Nonnull
                                           EntityMapper.HasFieldName f2,
                                           @Nonnull
                                           EntityMapper.Field<Collection<T>> f3,
                                           @Nullable
                                           T value)

toDBObject

@Nonnull
public com.mongodb.DBObject toDBObject()
                                         throws MapperException

Throws:

MapperException

toString

public String toString()

Overrides:

toString in class Object