org.nuiton.topia

Interface TopiaPersistenceContext

All Known Subinterfaces:

TopiaContext, TopiaContextImplementor

All Known Implementing Classes:

AbstractTopiaContext

public interface TopiaPersistenceContext

This API provides all methods related to persistence :

• Generic entity find
• Persistence customization
• DAO factory
• Schema management

Since:

3.0

Author:

Arnaud Thimel

Method Summary

Methods

Modifier and Type	Method and Description
void	createSchema() Triggers database schema creation
void	dropSchema() Triggers database schema drop
<E extends TopiaEntity> E	findByTopiaId(String topiaId) Retrieve TopiaEntity using its unique topiaId.
Properties	getConfig()
<E extends TopiaEntity> TopiaDAO<E>	getDAO(Class<E> entityClass) Get DAO for specified class.
<E extends TopiaEntity,D extends TopiaDAO<E>> D	getDAO(Class<E> entityClass, Class<D> daoClass) Get DAO for specified class.
List<Class<?>>	getPersistenceClasses()
String	getSchemaName()
TopiaIdFactory	getTopiaIdFactory() Get the currently configured TopiaIdFactory.
boolean	isSchemaEmpty() Detects if the db associated to the current context contains at least one entity table.
boolean	isTableExists(Class<?> clazz) Detects if the table is created on storage for a given persistent class.
void	setUseFlushMode(boolean useFlushMode) Tells to the context if it has to use a flush mode before each query.
void	showCreateSchema() Displays the SQL queries that would be used for a schema creation
void	update(TopiaEntity entity) Add into this TopiaContext an entity created by another TopiaContext
void	updateSchema() Triggers database schema update

Method Detail

findByTopiaId

<E extends TopiaEntity> E findByTopiaId(String topiaId)

Retrieve TopiaEntity using its unique topiaId.

Parameters:

topiaId - unique identifier of the entity in all the application.

Returns:

the entity found or null

update

void update(TopiaEntity entity)

Add into this TopiaContext an entity created by another TopiaContext

Parameters:

entity - the entity to add

getTopiaIdFactory

TopiaIdFactory getTopiaIdFactory()

Get the currently configured TopiaIdFactory.

Returns:

the TopiaIdFactory in use

Since:

3.0

See Also:

TopiaIdFactory}

getPersistenceClasses

List<Class<?>> getPersistenceClasses()

Returns:

the list of classes managed by this TopiaPersistenceContext

setUseFlushMode

void setUseFlushMode(boolean useFlushMode)

Tells to the context if it has to use a flush mode before each query.

By default, we use a flush mode, but in some case it costs to much doing this, that's why you can disable it setting the value to false.

Parameters:

useFlushMode - the new value to set

Since:

2.5

getConfig

Properties getConfig()

Returns:

Returns the config.

getDAO

<E extends TopiaEntity> TopiaDAO<E> getDAO(Class<E> entityClass)

Get DAO for specified class. If Specialized DAO exists then it returned otherwize TopiaDAO<entityClass> is returned

Parameters:

entityClass - type of entity

Returns:

the expected dao

getDAO

<E extends TopiaEntity,D extends TopiaDAO<E>> D getDAO(Class<E> entityClass,
                                                     Class<D> daoClass)

Get DAO for specified class. If Specialized DAO exists then it returned otherwize TopiaDAO<entityClass> is returned

Parameters:

entityClass - type of entity

daoClass - the concrete dao class to use

Returns:

the expected dao

isSchemaEmpty

boolean isSchemaEmpty()

Detects if the db associated to the current context contains at least one entity table.

Returns:

true if there is no schema for any of the dealed entities, false otherwise.

Since:

3.0

isTableExists

boolean isTableExists(Class<?> clazz)

Detects if the table is created on storage for a given persistent class.

Parameters:

clazz - the researched class

Returns:

true if the table exists on storage

Since:

3.0

getSchemaName

String getSchemaName()

Returns:

the current schema name

Since:

3.0

createSchema

void createSchema()

Triggers database schema creation

showCreateSchema

void showCreateSchema()

Displays the SQL queries that would be used for a schema creation

updateSchema

void updateSchema()

Triggers database schema update

dropSchema

void dropSchema()

Triggers database schema drop

Since:

3.0