de.caluga.morphium

Interface Writer

All Known Implementing Classes:

WriterImpl

public interface Writer

User: Stephan Bösebeck Date: 30.08.12 Time: 14:39

Interface for all morphium write accesses. Override for own use and set to MorphiumConfig

See Also:

MorphiumConfig

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(List lst)
void	delete(Object o)
void	delete(Query q) deletes all objects matching the given query
void	inc(Object toInc, String field, int amount) Increases a value in an existing mongo collection entry - no reading necessary.
void	inc(Query<?> query, String field, int amount, boolean insertIfNotExist, boolean multiple)
void	pushPull(boolean push, Query<?> query, String field, Object value, boolean insertIfNotExist, boolean multiple)
void	pushPullAll(boolean push, Query<?> query, String field, List<?> value, boolean insertIfNotExist, boolean multiple)
void	set(Object toSet, String field, Object value) changes an object in DB
void	set(Query<?> query, Map<String,Object> values, boolean insertIfNotExist, boolean multiple) will change an entry in mongodb-collection corresponding to given class object if query is too complex, upsert might not work!
void	setMorphium(Morphium m)
void	store(List lst) stores the given list of objects, should be entities or embedded
void	store(Object o) Stores the object, should be an entity
void	storeUsingFields(Object ent, String... fields) update an object using fields specified
void	unset(Object toSet, String field) Un-setting a value in an existing mongo collection entry - no reading necessary.

Method Detail

store

void store(Object o)

Stores the object, should be an entity

Parameters:

o - - entity

store

void store(List lst)

stores the given list of objects, should be entities or embedded

Parameters:

lst - - to store

storeUsingFields

void storeUsingFields(Object ent,
                    String... fields)

update an object using fields specified

Parameters:

ent - entity

fields - - fields

set

void set(Object toSet,
       String field,
       Object value)

changes an object in DB

Parameters:

toSet - entity to set values in

field - field

value - value to set

set

void set(Query<?> query,
       Map<String,Object> values,
       boolean insertIfNotExist,
       boolean multiple)

will change an entry in mongodb-collection corresponding to given class object if query is too complex, upsert might not work! Upsert should consist of single and-queries, which will be used to generate the object to create, unless it already exists. look at Mongodb-query documentation as well

Parameters:

query - - query to specify which objects should be set

values - - map fieldName->Value, which values are to be set!

insertIfNotExist - - insert, if it does not exist (query needs to be simple!)

multiple - - update several documents, if false, only first hit will be updated

inc

void inc(Query<?> query,
       String field,
       int amount,
       boolean insertIfNotExist,
       boolean multiple)

inc

void inc(Object toInc,
       String field,
       int amount)

Increases a value in an existing mongo collection entry - no reading necessary. Object is altered in place db.collection.update({"_id":toInc.id},{$inc:{field:amount}} attention: this alteres the given object toSet in a similar way

Parameters:

toInc: - object to set the value in (or better - the corresponding entry in mongo)

field: - the field to change

amount: - the value to set

setMorphium

void setMorphium(Morphium m)

delete

void delete(List lst)

delete

void delete(Object o)

delete

void delete(Query q)

deletes all objects matching the given query

Parameters:

q - the query

pushPull

void pushPull(boolean push,
            Query<?> query,
            String field,
            Object value,
            boolean insertIfNotExist,
            boolean multiple)

pushPullAll

void pushPullAll(boolean push,
               Query<?> query,
               String field,
               List<?> value,
               boolean insertIfNotExist,
               boolean multiple)

unset

void unset(Object toSet,
         String field)

Un-setting a value in an existing mongo collection entry - no reading necessary. Object is altered in place db.collection.update({"_id":toSet.id},{$unset:{field:1}} attention: this alteres the given object toSet in a similar way

Parameters:

toSet: - object to set the value in (or better - the corresponding entry in mongo)

field: - field to remove from document