sirius.db.mongo

Class Mango

java.lang.Object

sirius.db.mixing.BaseMapper<MongoEntity,MongoConstraint,MongoQuery<?>>

sirius.db.mongo.Mango

All Implemented Interfaces:

IndexDescription

public class Mango
extends BaseMapper<MongoEntity,MongoConstraint,MongoQuery<?>>
implements IndexDescription

Provides the mapper used to communicate with MongoDB.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INDEX_ASCENDING Defines the value used to desclare an index as sorted in ascending order.
static String	INDEX_DESCENDING Defines the value used to desclare an index as sorted in descending order.

Fields inherited from class sirius.db.mixing.BaseMapper

mixing, VERSION

Constructor Summary

Constructors

Constructor and Description
Mango()

Method Summary

Modifier and Type	Method and Description
protected void	createEntity(MongoEntity entity, EntityDescriptor ed) Creates a new entity in the underlying database.
void	createIndices(com.mongodb.client.MongoDatabase client) Invoked once the Mongo DB is first accessed and permits to create required indices.
protected void	deleteEntity(MongoEntity entity, boolean force, EntityDescriptor ed) Deletes the give entity from the database.
FilterFactory<MongoConstraint>	filters() Returns the filter factory which is used by this mapper.
protected <E extends MongoEntity> Optional<E>	findEntity(E entity)
protected <E extends MongoEntity> Optional<E>	findEntity(Object id, EntityDescriptor ed, Function<String,sirius.kernel.commons.Value> context) Tries to find the entity with the given id.
String	getCollection(Class<? extends MongoEntity> type)
static <E extends MongoEntity> E	make(EntityDescriptor ed, Doc doc) Creates a new entity for the given descriptor based on the given doc.
<E extends MongoEntity> MongoQuery<E>	select(Class<E> type) Creates a query for the given type.
protected void	updateEntity(MongoEntity entity, boolean force, EntityDescriptor ed) Updates an existing entity in the underlying database.

Methods inherited from class sirius.db.mixing.BaseMapper

delete, find, findOrFail, forceDelete, hasValidationWarnings, override, performDelete, performUpdate, refreshOrFail, resolve, resolveOrFail, tryDelete, tryRefresh, tryUpdate, update, validate

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_ASCENDING

public static final String INDEX_ASCENDING

Defines the value used to desclare an index as sorted in ascending order.

See Also:

Constant Field Values

INDEX_DESCENDING

public static final String INDEX_DESCENDING

Defines the value used to desclare an index as sorted in descending order.

See Also:

Constant Field Values

Constructor Detail

Mango

public Mango()

Method Detail

createEntity

protected void createEntity(MongoEntity entity,
                            EntityDescriptor ed)
                     throws Exception

Description copied from class: BaseMapper

Creates a new entity in the underlying database.

Specified by:

createEntity in class BaseMapper<MongoEntity,MongoConstraint,MongoQuery<?>>

Parameters:

entity - the entity to create

ed - the descriptor of the entity

Throws:

Exception - in case of an database error

updateEntity

protected void updateEntity(MongoEntity entity,
                            boolean force,
                            EntityDescriptor ed)
                     throws Exception

Description copied from class: BaseMapper

Updates an existing entity in the underlying database.

Specified by:

updateEntity in class BaseMapper<MongoEntity,MongoConstraint,MongoQuery<?>>

Parameters:

entity - the entity to update

force - ture if the update is forced and optimistic locking must be disabled

ed - the descriptor of the entity

Throws:

Exception - in case of an database error

deleteEntity

protected void deleteEntity(MongoEntity entity,
                            boolean force,
                            EntityDescriptor ed)
                     throws Exception

Description copied from class: BaseMapper

Deletes the give entity from the database.

Specified by:

deleteEntity in class BaseMapper<MongoEntity,MongoConstraint,MongoQuery<?>>

Parameters:

entity - the entity to delete

force - true if the delete is forced and optimistic locking must be disabled

ed - the descriptor of the entity

Throws:

Exception - in case of an database error

findEntity

protected <E extends MongoEntity> Optional<E> findEntity(Object id,
                                                         EntityDescriptor ed,
                                                         Function<String,sirius.kernel.commons.Value> context)
                                                  throws Exception

Description copied from class: BaseMapper

Tries to find the entity with the given id.

Specified by:

findEntity in class BaseMapper<MongoEntity,MongoConstraint,MongoQuery<?>>

Type Parameters:

E - the effective type of the entity

Parameters:

id - the id of the entity to find

ed - the descriptor of the entity to find

context - the advanced search context which can be populated using ContextInfo in BaseMapper.find(Class, Object, ContextInfo...)

Returns:

the entity wrapped as optional or an empty optional if the entity was not found

Throws:

Exception - in case of a database error

make

public static <E extends MongoEntity> E make(EntityDescriptor ed,
                                             Doc doc)

Creates a new entity for the given descriptor based on the given doc.

Type Parameters:

E - the effective type of the generated entity

Parameters:

ed - the descriptor of the entity to create

doc - the document to read the values from

Returns:

the generated entity

findEntity

protected <E extends MongoEntity> Optional<E> findEntity(E entity)

Specified by:

findEntity in class BaseMapper<MongoEntity,MongoConstraint,MongoQuery<?>>

select

public <E extends MongoEntity> MongoQuery<E> select(Class<E> type)

Description copied from class: BaseMapper

Creates a query for the given type.

Specified by:

select in class BaseMapper<MongoEntity,MongoConstraint,MongoQuery<?>>

Type Parameters:

E - the generic type of entities to be returned

Parameters:

type - the type of entities to query for.

Returns:

a query used to search for entities of the given type

filters

public FilterFactory<MongoConstraint> filters()

Description copied from class: BaseMapper

Returns the filter factory which is used by this mapper.

Specified by:

filters in class BaseMapper<MongoEntity,MongoConstraint,MongoQuery<?>>

Returns:

the filter factory used by this mapper

getCollection

public String getCollection(Class<? extends MongoEntity> type)

createIndices

public void createIndices(com.mongodb.client.MongoDatabase client)

Description copied from interface: IndexDescription

Invoked once the Mongo DB is first accessed and permits to create required indices.

Specified by:

createIndices in interface IndexDescription

Parameters:

client - can be used to create indices in the Mongo DB