sirius.db.mongo.types

Class MongoRef<E extends MongoEntity>

java.lang.Object

sirius.db.mixing.types.BaseEntityRef<String,E>

sirius.db.mongo.types.MongoRef<E>

Type Parameters:

E - the generic type of the referenced entity

public class MongoRef<E extends MongoEntity>
extends BaseEntityRef<String,E>

Represents a reference from one entity to another.

Instead of directly keeping the entity in a Java field, it is wrapped in an EntityRef. This leads to clean semantics for lazy loading as both the ID and (if fetched) the value are stored in this wrapper.

Nested Class Summary

Nested classes/interfaces inherited from class sirius.db.mixing.types.BaseEntityRef

BaseEntityRef.OnDelete

Field Summary

Fields inherited from class sirius.db.mixing.types.BaseEntityRef

deleteHandler, id, type, value

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MongoRef(Class<E> type, BaseEntityRef.OnDelete deleteHandler)

Method Summary

Modifier and Type	Method and Description
protected String	coerceToId(Object id) Converts the given object into an id.
protected Optional<E>	find(Class<E> type, String id) Performs the lookup of the entity with the given id.
static <E extends MongoEntity> MongoRef<E>	on(Class<E> type, BaseEntityRef.OnDelete deleteHandler) Generates an entity reference to the given entity type.

Methods inherited from class sirius.db.mixing.types.BaseEntityRef

containsNonpersistentValue, getDeleteHandler, getId, getType, getUniqueObjectName, getValue, is, isEmpty, isFilled, isValueLoaded, setId, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoRef

protected MongoRef(Class<E> type,
                   BaseEntityRef.OnDelete deleteHandler)

Method Detail

on

public static <E extends MongoEntity> MongoRef<E> on(Class<E> type,
                                                     BaseEntityRef.OnDelete deleteHandler)

Generates an entity reference to the given entity type.

Type Parameters:

E - the generic type of the referenced entity

Parameters:

type - the target type to reference

deleteHandler - determines what happens if the referenced entity is deleted

Returns:

a new entity ref, representing the given settings

find

protected Optional<E> find(Class<E> type,
                           String id)

Description copied from class: BaseEntityRef

Performs the lookup of the entity with the given id.

Specified by:

find in class BaseEntityRef<String,E extends MongoEntity>

Parameters:

type - the type to search for

id - the id to lookup

Returns:

the matching entity wrapped as optional or an empty optional of the entity doesn't exist

coerceToId

protected String coerceToId(Object id)

Description copied from class: BaseEntityRef

Converts the given object into an id.

Specified by:

coerceToId in class BaseEntityRef<String,E extends MongoEntity>

Parameters:

id - the value to coerce

Returns:

the value represented in the correct type