de.caluga.morphium

Class Morphium

java.lang.Object

de.caluga.morphium.Morphium

public final class Morphium
extends Object

This is the single access point for accessing MongoDB. This should

Author:

stephan

Constructor Summary

Constructors

Constructor and Description
Morphium(MorphiumConfig cfg) init the MongoDbLayer.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accessDenied(Class<?> cls, Permission p)
boolean	accessDenied(Object r, Permission p)
void	addListener(MorphiumStorageListener lst)
void	addProfilingListener(ProfilingListener l)
void	addShutdownListener(ShutdownListener l)
<T> void	addToCache(String k, Class<?> type, List<T> ret) adds some list of objects to the cache manually...
<T,R> List<R>	aggregate(Aggregator<T,R> a)
void	callLifecycleMethod(Class<? extends Annotation> type, Object on)
boolean	checkAccess(String domain, Permission p)
void	clearCachefor(Class<?> cls) Erase cache entries for the given type. is being called after every store depending on cache settings!
void	clearCacheIfNecessary(Class cls)
void	clearCollection(Class<?> cls) issues a delete command - no lifecycle methods calles, no drop, keeps all indexec this way
void	clearCollectionOneByOne(Class<?> cls) clears every single object in collection - reads ALL objects to do so this way Lifecycle methods can be called!
Hashtable<Class<?>,Hashtable<String,CacheElement>>	cloneCache()
Hashtable<Class<?>,Hashtable<org.bson.types.ObjectId,Object>>	cloneIdCache()
void	close()
<T,R> Aggregator<T,R>	createAggregator(Class<? extends T> type, Class<? extends R> resultType)
String	createCamelCase(String n)
<T> T	createLazyLoadedEntity(Class<? extends T> cls, org.bson.types.ObjectId id)
<T> MongoField<T>	createMongoField()
<T> T	createPartiallyUpdateableEntity(T o) create a proxy object, implementing the ParitallyUpdateable Interface these objects will be updated in mongo by only changing altered fields Attention: the field name if determined by the setter name for now.
<T> Query<T>	createQueryFor(Class<? extends T> type)
void	dec(Object toDec, String field, int amount) decreasing a value of a given object calles inc(toDec,field,-amount);
void	dec(Query<?> query, Enum field, int amount)
void	dec(Query<?> query, Enum field, int amount, boolean insertIfNotExist, boolean multiple)
void	dec(Query<?> query, String field, int amount)
void	dec(Query<?> query, String field, int amount, boolean insertIfNotExist, boolean multiple)
void	delete(Object o) deletes a single object from morphium backend.
void	delete(Query o)
List<Object>	distinct(Enum key, Class c)
List<Object>	distinct(Enum key, Query q) returns a distinct list of values of the given collection Attention: these values are not unmarshalled, you might get MongoDBObjects
List<Object>	distinct(String key, Class cls)
List<Object>	distinct(String key, Query q) returns a distinct list of values of the given collection Attention: these values are not unmarshalled, you might get MongoDBObjects
void	dropCollection(Class<?> cls)
void	ensureIndex(Class<?> cls, Enum... fldStr)
void	ensureIndex(Class<?> cls, Map<String,Object> index)
void	ensureIndex(Class<?> cls, String... fldStr) ensureIndex(CachedObject.class,"counter","-value"); ensureIndex(CachedObject.class,"counter:2d","-value); Similar to sorting
void	ensureIndicesFor(Class type) can be called for autmatic index ensurance.
<T> List<T>	find(Query<T> q)
<T> List<T>	findByField(Class<? extends T> cls, Enum fld, Object val)
<T> List<T>	findByField(Class<? extends T> cls, String fld, Object val)
<T> T	findById(Class<? extends T> type, org.bson.types.ObjectId id)
<T> List<T>	findByTemplate(T template, String... fields) search for objects similar to template concerning all given fields.
void	firePostDropEvent(Class cls)
void	firePostLoadEvent(Object o) will be called by query after unmarshalling
void	firePostRemoveEvent(Object o)
void	firePostRemoveEvent(Query q)
void	firePostStoreEvent(Object o, boolean isNew)
void	firePostUpdateEvent(Class cls, MorphiumStorageListener.UpdateTypes t)
void	firePreDropEvent(Class cls)
void	firePreRemoveEvent(Object o)
void	firePreRemoveEvent(Query q)
void	firePreStoreEvent(Object o, boolean isNew)
void	firePreUpdateEvent(Class cls, MorphiumStorageListener.UpdateTypes t)
void	fireProfilingReadEvent(Query q, long time, ReadAccessType t)
void	fireProfilingWriteEvent(Class type, Object data, long time, boolean isNew, WriteAccessType wt)
List<Annotation>	getAllAnnotationsFromHierachy(Class<?> cls, Class<? extends Annotation>... anCls)
<T extends Annotation> T	getAnnotationFromHierarchy(Class<?> cls, Class<? extends T> anCls) returns annotations, even if in class hierarchy or lazyloading proxy
String	getCacheKey(com.mongodb.DBObject qo, Map<String,Integer> sort, int skip, int limit)
String	getCacheKey(Query q) create unique cache key for queries, also honoring skip & limit and sorting
MorphiumConfig	getConfig()
ConfigManager	getConfigManager()
String	getCreatedByField(Class<?> cls)
String	getCreationTimeField(Class<?> cls)
com.mongodb.DB	getDatabase()
Date	getDateValue(Object o, String fld)
Double	getDoubleValue(Object o, String fld)
Field	getField(Class cls, String fld) extended logic: Fld may be, the java field name, the name of the specified value in Property-Annotation or the translated underscored lowercase name (mongoId => mongo_id)
String	getFieldName(Class<?> cls, String fld)
List<String>	getFields(Class<?> cls) get a list of valid fields of a given record as they are in the MongoDB so, if you have a field Mapping, the mapped Property-name will be used
<T> List<T>	getFromCache(Class<? extends T> type, String k) return object by from cache.
org.bson.types.ObjectId	getId(Object o)
String	getLastAccessByField(Class<?> cls)
String	getLastAccessField(Class<?> cls)
String	getLastChangeByField(Class<?> cls)
String	getLastChangeField(Class<?> cls)
Long	getLongValue(Object o, String fld)
ObjectMapper	getMapper()
com.mongodb.Mongo	getMongo()
ReplicaSetStatus	getReplicaSetStatus() same as retReplicaSetStatus(false);
ReplicaSetStatus	getReplicaSetStatus(boolean full) get the current replicaset status - issues the replSetGetStatus command to mongo if full==true, also the configuration is read.
MongoSecurityManager	getSecurityManager()
Map<String,Double>	getStatistics()
Map<StatisticKeys,StatisticValue>	getStats()
String	getStringValue(Object o, String fld)
Class	getTypeOfField(Class<?> cls, String fld)
Object	getValue(Object o, String fld)
Object	getValueOf(Object toGetValueFrom, Enum fld)
Object	getValueOf(Object toGetValueFrom, String fld)
com.mongodb.WriteConcern	getWriteConcernForClass(Class<?> cls)
com.mongodb.DBObject	group(Query q, Map<String,Object> initial, String jsReduce, String jsFinalize, String... keys)
void	inc(Object toSet, String field, int i)
void	inc(Query<?> query, Enum field, int amount)
void	inc(Query<?> query, Enum field, int amount, boolean insertIfNotExist, boolean multiple)
void	inc(Query<?> query, String field, int amount)
void	inc(Query<?> query, String name, int amount, boolean insertIfNotExist, boolean multiple)
void	inc(StatisticKeys k)
<T extends Annotation> boolean	isAnnotationPresentInHierarchy(Class<?> cls, Class<? extends T> anCls)
boolean	isCached(Class<?> type, String k)
boolean	isReplicaSet()
boolean	isWriteCached(Class<?> cls)
void	pull(Query<?> query, Enum field, Object value)
void	pull(Query<?> query, Enum field, Object value, boolean insertIfNotExist, boolean multiple)
void	pull(Query<?> query, String field, Object value)
void	pull(Query<?> query, String field, Object value, boolean insertIfNotExist, boolean multiple)
void	pullAll(Query<?> query, Enum field, List<Object> value, boolean insertIfNotExist, boolean multiple)
void	pullAll(Query<?> query, String field, List<Object> value, boolean insertIfNotExist, boolean multiple)
void	push(Query<?> query, Enum field, Object value)
void	push(Query<?> query, Enum field, Object value, boolean insertIfNotExist, boolean multiple)
void	push(Query<?> query, String field, Object value)
void	push(Query<?> query, String field, Object value, boolean insertIfNotExist, boolean multiple)
void	pushAll(Query<?> query, Enum field, List<Object> value, boolean insertIfNotExist, boolean multiple)
void	pushAll(Query<?> query, String field, List<?> value, boolean insertIfNotExist, boolean multiple)
<T> List<T>	readAll(Class<? extends T> cls) return a list of all elements stored in morphium for this type
void	removeEntryFromCache(Class cls, org.bson.types.ObjectId id)
void	removeListener(MorphiumStorageListener lst)
void	removeProfilingListener(ProfilingListener l)
void	removeShutdownListener(ShutdownListener l)
<T> T	reread(T o) careful this actually changes the parameter o!
void	resetCache()
void	set(Object toSet, Enum field, Object value)
void	set(Object toSet, String field, Object value) setting a value in an existing mongo collection entry - no reading necessary.
void	set(Query<?> query, Enum field, Object val)
void	set(Query<?> query, Map<String,Object> map, boolean insertIfNotExist, boolean multiple)
void	set(Query<?> query, String field, Object val)
void	set(Query<?> query, String field, Object val, 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	setCache(Hashtable<Class<?>,Hashtable<String,CacheElement>> cache)
void	setEnum(Query<?> query, Map<Enum,Object> values, boolean insertIfNotExist, boolean multiple)
void	setIdCache(Hashtable<Class<?>,Hashtable<org.bson.types.ObjectId,Object>> c)
void	setPrivileged() temporarily switch off security settings - needed by SecurityManagers
void	setPrivilegedThread(Thread thr)
void	setValue(Object in, String fld, Object val)
void	setValueIn(Object toSetValueIn, Enum fld, Object value)
void	setValueIn(Object toSetValueIn, String fld, Object value) does not set values in DB only in the entity
com.mongodb.DBObject	simplifyQueryObject(com.mongodb.DBObject q)
void	store(Object o) Stores a single Object.
void	storeInBackground(Object lst)
<T> void	storeList(List<T> lst)
void	storeNoCache(Object lst)
boolean	storesCreatedBy(Class<?> cls)
boolean	storesCreation(Class<?> cls)
boolean	storesLastAccess(Class<?> cls)
boolean	storesLastAccessBy(Class<?> cls)
boolean	storesLastChange(Class<?> cls)
boolean	storesLastChangeBy(Class<?> cls)
String	toJsonString(Object o)
void	unset(Object toSet, Enum field)
void	unset(Object toSet, String field)
void	updateUsingFields(Object ent, String... fields) updating an enty in DB without sending the whole entity only transfers the fields to be changed / set
int	writeBufferCount()

Methods inherited from class java.lang.Object

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

Constructor Detail

Morphium

public Morphium(MorphiumConfig cfg)

init the MongoDbLayer. Uses Morphium-Configuration Object for Configuration. Needs to be set before use or RuntimeException is thrown! all logging is done in INFO level

See Also:

MorphiumConfig

Method Detail

getConfig

public MorphiumConfig getConfig()

addListener

public void addListener(MorphiumStorageListener lst)

removeListener

public void removeListener(MorphiumStorageListener lst)

getMongo

public com.mongodb.Mongo getMongo()

getDatabase

public com.mongodb.DB getDatabase()

getConfigManager

public ConfigManager getConfigManager()

findByTemplate

public <T> List<T> findByTemplate(T template,
                         String... fields)

search for objects similar to template concerning all given fields. If no fields are specified, all NON Null-Fields are taken into account if specified, field might also be null

Type Parameters:

T - - type

Parameters:

template - - what to search for

fields - - fields to use for searching

Returns:

result of search

unset

public void unset(Object toSet,
         Enum field)

unset

public void unset(Object toSet,
         String field)

ensureIndicesFor

public void ensureIndicesFor(Class type)

can be called for autmatic index ensurance. Attention: might cause heavy load on mongo will be called automatically if a new collection is created

Parameters:

type - type to ensure indices for

clearCacheIfNecessary

public void clearCacheIfNecessary(Class cls)

simplifyQueryObject

public com.mongodb.DBObject simplifyQueryObject(com.mongodb.DBObject q)

set

public void set(Query<?> query,
       Enum field,
       Object val)

set

public void set(Query<?> query,
       String field,
       Object val)

setEnum

public void setEnum(Query<?> query,
           Map<Enum,Object> values,
           boolean insertIfNotExist,
           boolean multiple)

push

public void push(Query<?> query,
        Enum field,
        Object value)

pull

public void pull(Query<?> query,
        Enum field,
        Object value)

push

public void push(Query<?> query,
        String field,
        Object value)

pull

public void pull(Query<?> query,
        String field,
        Object value)

push

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

pull

public void pull(Query<?> query,
        Enum field,
        Object value,
        boolean insertIfNotExist,
        boolean multiple)

pushAll

public void pushAll(Query<?> query,
           Enum field,
           List<Object> value,
           boolean insertIfNotExist,
           boolean multiple)

pullAll

public void pullAll(Query<?> query,
           Enum field,
           List<Object> value,
           boolean insertIfNotExist,
           boolean multiple)

push

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

pull

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

pushAll

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

pullAll

public void pullAll(Query<?> query,
           String field,
           List<Object> value,
           boolean insertIfNotExist,
           boolean multiple)

set

public void set(Query<?> query,
       String field,
       Object val,
       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

field - - field to set

val - - value to 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

set

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

dec

public void dec(Query<?> query,
       Enum field,
       int amount,
       boolean insertIfNotExist,
       boolean multiple)

dec

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

dec

public void dec(Query<?> query,
       String field,
       int amount)

dec

public void dec(Query<?> query,
       Enum field,
       int amount)

inc

public void inc(Query<?> query,
       String field,
       int amount)

inc

public void inc(Query<?> query,
       Enum field,
       int amount)

inc

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

inc

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

set

public void set(Object toSet,
       Enum field,
       Object value)

set

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

setting a value in an existing mongo collection entry - no reading necessary. Object is altered in place db.collection.update({"_id":toSet.id},{$set:{field:value}} 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: - the field to change

value: - the value to set

dec

public void dec(Object toDec,
       String field,
       int amount)

decreasing a value of a given object calles inc(toDec,field,-amount);

inc

public void inc(Object toSet,
       String field,
       int i)

setIdCache

public void setIdCache(Hashtable<Class<?>,Hashtable<org.bson.types.ObjectId,Object>> c)

addToCache

public <T> void addToCache(String k,
                  Class<?> type,
                  List<T> ret)

adds some list of objects to the cache manually... is being used internally, and should be used with care

Type Parameters:

T - - Type of record

Parameters:

k - - Key, usually the mongodb query string

type - - class type

ret - - list of results

setPrivilegedThread

public void setPrivilegedThread(Thread thr)

inc

public void inc(StatisticKeys k)

toJsonString

public String toJsonString(Object o)

writeBufferCount

public int writeBufferCount()

getCacheKey

public String getCacheKey(com.mongodb.DBObject qo,
                 Map<String,Integer> sort,
                 int skip,
                 int limit)

getCacheKey

public String getCacheKey(Query q)

create unique cache key for queries, also honoring skip & limit and sorting

Parameters:

q - the query

Returns:

the resulting cache key

updateUsingFields

public void updateUsingFields(Object ent,
                     String... fields)

updating an enty in DB without sending the whole entity only transfers the fields to be changed / set

Parameters:

ent - - entity to update

fields - - fields to use

getAllAnnotationsFromHierachy

public List<Annotation> getAllAnnotationsFromHierachy(Class<?> cls,
                                             Class<? extends Annotation>... anCls)

getAnnotationFromHierarchy

public <T extends Annotation> T getAnnotationFromHierarchy(Class<?> cls,
                                                  Class<? extends T> anCls)

returns annotations, even if in class hierarchy or lazyloading proxy

Parameters:

cls - class

Returns:

the Annotation

getMapper

public ObjectMapper getMapper()

isAnnotationPresentInHierarchy

public <T extends Annotation> boolean isAnnotationPresentInHierarchy(Class<?> cls,
                                                            Class<? extends T> anCls)

callLifecycleMethod

public void callLifecycleMethod(Class<? extends Annotation> type,
                       Object on)

reread

public <T> T reread(T o)

careful this actually changes the parameter o!

Type Parameters:

T - - tpye of the object

Parameters:

o - - object to read

Returns:

- entity

firePreStoreEvent

public void firePreStoreEvent(Object o,
                     boolean isNew)

firePostStoreEvent

public void firePostStoreEvent(Object o,
                      boolean isNew)

firePreDropEvent

public void firePreDropEvent(Class cls)

firePostDropEvent

public void firePostDropEvent(Class cls)

firePostUpdateEvent

public void firePostUpdateEvent(Class cls,
                       MorphiumStorageListener.UpdateTypes t)

firePreUpdateEvent

public void firePreUpdateEvent(Class cls,
                      MorphiumStorageListener.UpdateTypes t)

firePostRemoveEvent

public void firePostRemoveEvent(Object o)

firePostRemoveEvent

public void firePostRemoveEvent(Query q)

firePreRemoveEvent

public void firePreRemoveEvent(Object o)

firePreRemoveEvent

public void firePreRemoveEvent(Query q)

firePostLoadEvent

public void firePostLoadEvent(Object o)

will be called by query after unmarshalling

Parameters:

o - - entitiy

getReplicaSetStatus

public ReplicaSetStatus getReplicaSetStatus()

same as retReplicaSetStatus(false);

Returns:

replica set status

getReplicaSetStatus

public ReplicaSetStatus getReplicaSetStatus(boolean full)

get the current replicaset status - issues the replSetGetStatus command to mongo if full==true, also the configuration is read. This method is called with full==false for every write in case a Replicaset is configured to find out the current number of active nodes

Parameters:

full - - if true- return full status

Returns:

status

isReplicaSet

public boolean isReplicaSet()

getWriteConcernForClass

public com.mongodb.WriteConcern getWriteConcernForClass(Class<?> cls)

addProfilingListener

public void addProfilingListener(ProfilingListener l)

removeProfilingListener

public void removeProfilingListener(ProfilingListener l)

fireProfilingWriteEvent

public void fireProfilingWriteEvent(Class type,
                           Object data,
                           long time,
                           boolean isNew,
                           WriteAccessType wt)

fireProfilingReadEvent

public void fireProfilingReadEvent(Query q,
                          long time,
                          ReadAccessType t)

isCached

public boolean isCached(Class<?> type,
               String k)

getFromCache

public <T> List<T> getFromCache(Class<? extends T> type,
                       String k)

return object by from cache. Cache key usually is the string-representation of the search query.toQueryObject()

Type Parameters:

T - - type param

Parameters:

type - - type

k - - cache key

Returns:

resulting list

cloneCache

public Hashtable<Class<?>,Hashtable<String,CacheElement>> cloneCache()

cloneIdCache

public Hashtable<Class<?>,Hashtable<org.bson.types.ObjectId,Object>> cloneIdCache()

clearCollection

public void clearCollection(Class<?> cls)

issues a delete command - no lifecycle methods calles, no drop, keeps all indexec this way

Parameters:

cls - - class

clearCollectionOneByOne

public void clearCollectionOneByOne(Class<?> cls)

clears every single object in collection - reads ALL objects to do so this way Lifecycle methods can be called!

Parameters:

cls - -class

readAll

public <T> List<T> readAll(Class<? extends T> cls)

return a list of all elements stored in morphium for this type

Type Parameters:

T - - Type

Parameters:

cls - - type to search for, needs to be an Property

Returns:

- list of all elements stored

createQueryFor

public <T> Query<T> createQueryFor(Class<? extends T> type)

find

public <T> List<T> find(Query<T> q)

distinct

public List<Object> distinct(Enum key,
                    Class c)

distinct

public List<Object> distinct(Enum key,
                    Query q)

returns a distinct list of values of the given collection Attention: these values are not unmarshalled, you might get MongoDBObjects

distinct

public List<Object> distinct(String key,
                    Query q)

returns a distinct list of values of the given collection Attention: these values are not unmarshalled, you might get MongoDBObjects

distinct

public List<Object> distinct(String key,
                    Class cls)

group

public com.mongodb.DBObject group(Query q,
                         Map<String,Object> initial,
                         String jsReduce,
                         String jsFinalize,
                         String... keys)

findById

public <T> T findById(Class<? extends T> type,
             org.bson.types.ObjectId id)

setValueIn

public void setValueIn(Object toSetValueIn,
              String fld,
              Object value)

does not set values in DB only in the entity

Parameters:

toSetValueIn - - where to set the value

setValueIn

public void setValueIn(Object toSetValueIn,
              Enum fld,
              Object value)

getValueOf

public Object getValueOf(Object toGetValueFrom,
                String fld)

getValueOf

public Object getValueOf(Object toGetValueFrom,
                Enum fld)

findByField

public <T> List<T> findByField(Class<? extends T> cls,
                      String fld,
                      Object val)

findByField

public <T> List<T> findByField(Class<? extends T> cls,
                      Enum fld,
                      Object val)

getFields

public final List<String> getFields(Class<?> cls)

get a list of valid fields of a given record as they are in the MongoDB so, if you have a field Mapping, the mapped Property-name will be used

Parameters:

cls - - class

Returns:

return list of fields

getTypeOfField

public final Class getTypeOfField(Class<?> cls,
                   String fld)

storesLastChange

public boolean storesLastChange(Class<?> cls)

storesLastChangeBy

public boolean storesLastChangeBy(Class<?> cls)

storesLastAccess

public boolean storesLastAccess(Class<?> cls)

storesLastAccessBy

public boolean storesLastAccessBy(Class<?> cls)

storesCreation

public boolean storesCreation(Class<?> cls)

storesCreatedBy

public boolean storesCreatedBy(Class<?> cls)

getFieldName

public String getFieldName(Class<?> cls,
                  String fld)

getField

public Field getField(Class cls,
             String fld)

extended logic: Fld may be, the java field name, the name of the specified value in Property-Annotation or the translated underscored lowercase name (mongoId => mongo_id)

Parameters:

cls - - class to search

fld - - field name

Returns:

field, if found, null else

setValue

public void setValue(Object in,
            String fld,
            Object val)

getValue

public Object getValue(Object o,
              String fld)

getLongValue

public Long getLongValue(Object o,
                String fld)

getStringValue

public String getStringValue(Object o,
                    String fld)

getDateValue

public Date getDateValue(Object o,
                String fld)

getDoubleValue

public Double getDoubleValue(Object o,
                    String fld)

clearCachefor

public void clearCachefor(Class<?> cls)

Erase cache entries for the given type. is being called after every store depending on cache settings!

Parameters:

cls - - class

storeNoCache

public void storeNoCache(Object lst)

storeInBackground

public void storeInBackground(Object lst)

getId

public org.bson.types.ObjectId getId(Object o)

dropCollection

public void dropCollection(Class<?> cls)

ensureIndex

public void ensureIndex(Class<?> cls,
               Map<String,Object> index)

ensureIndex

public void ensureIndex(Class<?> cls,
               String... fldStr)

ensureIndex(CachedObject.class,"counter","-value"); ensureIndex(CachedObject.class,"counter:2d","-value); Similar to sorting

Parameters:

cls - - class

fldStr - - fields

ensureIndex

public void ensureIndex(Class<?> cls,
               Enum... fldStr)

store

public void store(Object o)

Stores a single Object. Clears the corresponding cache

Parameters:

o - - Object to store

storeList

public <T> void storeList(List<T> lst)

delete

public void delete(Query o)

delete

public void delete(Object o)

deletes a single object from morphium backend. Clears cache

Parameters:

o - - entity

resetCache

public void resetCache()

setCache

public void setCache(Hashtable<Class<?>,Hashtable<String,CacheElement>> cache)

getStatistics

public Map<String,Double> getStatistics()

removeEntryFromCache

public void removeEntryFromCache(Class cls,
                        org.bson.types.ObjectId id)

getStats

public Map<StatisticKeys,StatisticValue> getStats()

addShutdownListener

public void addShutdownListener(ShutdownListener l)

removeShutdownListener

public void removeShutdownListener(ShutdownListener l)

close

public void close()

createCamelCase

public String createCamelCase(String n)

isWriteCached

public boolean isWriteCached(Class<?> cls)

createAggregator

public <T,R> Aggregator<T,R> createAggregator(Class<? extends T> type,
                                     Class<? extends R> resultType)

aggregate

public <T,R> List<R> aggregate(Aggregator<T,R> a)

createPartiallyUpdateableEntity

public <T> T createPartiallyUpdateableEntity(T o)

create a proxy object, implementing the ParitallyUpdateable Interface these objects will be updated in mongo by only changing altered fields Attention: the field name if determined by the setter name for now. That means, it does not honor the @Property-Annotation!!! To make sure, you take the correct field - use the UpdatingField-Annotation for the setters!

Type Parameters:

T - - type

Parameters:

o - - entity

Returns:

Type

createLazyLoadedEntity

public <T> T createLazyLoadedEntity(Class<? extends T> cls,
                           org.bson.types.ObjectId id)

createMongoField

public <T> MongoField<T> createMongoField()

getLastChangeField

public String getLastChangeField(Class<?> cls)

getLastChangeByField

public String getLastChangeByField(Class<?> cls)

getLastAccessField

public String getLastAccessField(Class<?> cls)

getLastAccessByField

public String getLastAccessByField(Class<?> cls)

getCreationTimeField

public String getCreationTimeField(Class<?> cls)

getCreatedByField

public String getCreatedByField(Class<?> cls)

getSecurityManager

public MongoSecurityManager getSecurityManager()

setPrivileged

public void setPrivileged()

temporarily switch off security settings - needed by SecurityManagers

checkAccess

public boolean checkAccess(String domain,
                  Permission p)
                    throws MongoSecurityException

Throws:

MongoSecurityException

accessDenied

public boolean accessDenied(Class<?> cls,
                   Permission p)
                     throws MongoSecurityException

Throws:

MongoSecurityException

accessDenied

public boolean accessDenied(Object r,
                   Permission p)
                     throws MongoSecurityException

Throws:

MongoSecurityException