sirius.db.jdbc

Class OMA

java.lang.Object

sirius.db.mixing.BaseMapper<SQLEntity,SQLConstraint,SmartQuery<? extends SQLEntity>>

sirius.db.jdbc.OMA

public class OMA
extends BaseMapper<SQLEntity,SQLConstraint,SmartQuery<? extends SQLEntity>>

Provides the mapper used to communicate with JDBC / SQL databases.

Field Summary

Fields

Modifier and Type	Field and Description
static SQLFilterFactory	FILTERS Constains the factory used to generate filters for a SmartQuery.
static sirius.kernel.health.Log	LOG Contains the central logger for the OMA facility.

Fields inherited from class sirius.db.mixing.BaseMapper

mixing, VERSION

Constructor Summary

Constructors

Constructor and Description
OMA()

Method Summary

Modifier and Type	Method and Description
protected void	createEntity(SQLEntity entity, EntityDescriptor ed) Creates a new entity in the underlying database.
protected void	deleteEntity(SQLEntity entity, boolean force, EntityDescriptor ed) Deletes the give entity from the database.
protected <E extends SQLEntity> Optional<E>	execFind(Object id, EntityDescriptor ed, Connection c)
FilterFactory<SQLConstraint>	filters() Returns the filter factory which is used by this mapper.
protected <E extends SQLEntity> Optional<E>	findEntity(E entity)
protected <E extends SQLEntity> Optional<E>	findEntity(Object id, EntityDescriptor ed, Function<String,sirius.kernel.commons.Value> context) Tries to find the entity with the given id
Database	getDatabase(String realm) Provides the underlying database instance used to perform the actual statements.
sirius.kernel.async.Future	getReadyFuture() Provides a Future which is fullfilled once the framework is ready.
boolean	isReady() Determines if the framework is ready yet.
static void	loadCreatedId(SQLEntity entity, Row keys) Loads an auto generated id from the given row.
<E extends SQLEntity> SmartQuery<E>	select(Class<E> type) Creates a query for the given type.
<E extends SQLEntity> TransformedQuery<E>	transform(Class<E> type, SQLQuery qry) Transforms a plain SQLQuery to directly return entities of the given type.
<E extends SQLEntity> TransformedQuery<E>	transform(Class<E> type, String alias, SQLQuery qry) Same as transform(Class, SQLQuery) but with support for aliased columns.
protected void	updateEntity(SQLEntity 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

LOG

public static final sirius.kernel.health.Log LOG

Contains the central logger for the OMA facility.

FILTERS

public static final SQLFilterFactory FILTERS

Constains the factory used to generate filters for a SmartQuery.

Constructor Detail

OMA

public OMA()

Method Detail

getDatabase

@Nullable
public Database getDatabase(String realm)

Provides the underlying database instance used to perform the actual statements.

Parameters:

realm - the realm to determine the database for

Returns:

the database used by the framework

getReadyFuture

public sirius.kernel.async.Future getReadyFuture()

Provides a Future which is fullfilled once the framework is ready.

Returns:

a future which can be used to delay startup actions until the framework is fully functional.

isReady

public boolean isReady()

Determines if the framework is ready yet.

Returns:

true if the framework is ready, false otherwise.

createEntity

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

Description copied from class: BaseMapper

Creates a new entity in the underlying database.

Specified by:

createEntity in class BaseMapper<SQLEntity,SQLConstraint,SmartQuery<? extends SQLEntity>>

Parameters:

entity - the entity to create

ed - the descriptor of the entity

Throws:

Exception - in case of an database error

loadCreatedId

public static void loadCreatedId(SQLEntity entity,
                                 Row keys)

Loads an auto generated id from the given row.

Parameters:

entity - the target entity to write the id to

keys - the row to read the id from

updateEntity

protected void updateEntity(SQLEntity 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<SQLEntity,SQLConstraint,SmartQuery<? extends SQLEntity>>

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(SQLEntity 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<SQLEntity,SQLConstraint,SmartQuery<? extends SQLEntity>>

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

select

public <E extends SQLEntity> SmartQuery<E> select(Class<E> type)

Description copied from class: BaseMapper

Creates a query for the given type.

Specified by:

select in class BaseMapper<SQLEntity,SQLConstraint,SmartQuery<? extends SQLEntity>>

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<SQLConstraint> filters()

Description copied from class: BaseMapper

Returns the filter factory which is used by this mapper.

Specified by:

filters in class BaseMapper<SQLEntity,SQLConstraint,SmartQuery<? extends SQLEntity>>

Returns:

the filter factory used by this mapper

transform

public <E extends SQLEntity> TransformedQuery<E> transform(Class<E> type,
                                                           SQLQuery qry)

Transforms a plain SQLQuery to directly return entities of the given type.

Type Parameters:

E - the generic type of entities to read from the query result

Parameters:

type - the type of entites to read from the query result

qry - the query to transform

Returns:

a transformed query which returns entities instead of result rows.

transform

public <E extends SQLEntity> TransformedQuery<E> transform(Class<E> type,
                                                           String alias,
                                                           SQLQuery qry)

Same as transform(Class, SQLQuery) but with support for aliased columns.

If the columns to read from the result set are aliased, this method can be used to specify the alias to use.

Type Parameters:

E - the generic type of entities to read from the query result

Parameters:

type - the type of entites to read from the query result

alias - the alias which is appended to all column names to readl

qry - the query to transform

Returns:

a transformed query which returns entities instead of result rows.

findEntity

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

Tries to find the entity with the given id

Specified by:

findEntity in class BaseMapper<SQLEntity,SQLConstraint,SmartQuery<? extends SQLEntity>>

Type Parameters:

E - the generic type of the entity tp find

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 context info elements.

Returns:

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

Throws:

Exception - in case of a database or system error

execFind

protected <E extends SQLEntity> Optional<E> execFind(Object id,
                                                     EntityDescriptor ed,
                                                     Connection c)
                                              throws Exception

Throws:

Exception

findEntity

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

Specified by:

findEntity in class BaseMapper<SQLEntity,SQLConstraint,SmartQuery<? extends SQLEntity>>