com.edorasware.commons.core.persistence.entity.jdbc

Class JdbcEntityPersistence<T extends EntityId,P extends Id,E extends Entity<T,P>,EB extends Entity.EntityBuilder<T,P,E,EB>,Q extends EntityQuery,QB extends EntityQuery.EntityQueryBuilder<Q,QB>,M extends EntityManager<T,P,E,EB,Q,QB,?,?,?>,R extends EntityResult<T,P,E,EB,M>,PC extends EntityPersistenceConfiguration<T,P,E,EB,M,R>>

java.lang.Object

com.edorasware.commons.core.persistence.entity.jdbc.JdbcEntityPersistence<T,P,E,EB,Q,QB,M,R,PC>

All Implemented Interfaces:

EntityPersistence<T,E,Q>

Direct Known Subclasses:

JdbcDomainObjectDefinitionPersistence, JdbcDomainObjectPersistence

public abstract class JdbcEntityPersistence<T extends EntityId,P extends Id,E extends Entity<T,P>,EB extends Entity.EntityBuilder<T,P,E,EB>,Q extends EntityQuery,QB extends EntityQuery.EntityQueryBuilder<Q,QB>,M extends EntityManager<T,P,E,EB,Q,QB,?,?,?>,R extends EntityResult<T,P,E,EB,M>,PC extends EntityPersistenceConfiguration<T,P,E,EB,M,R>>
extends Object
implements EntityPersistence<T,E,Q>

Field Summary

Fields

Modifier and Type	Field and Description
protected static Map<String,Object>	EMPTY_CONTEXT
protected static int	MAX_QUERY_ID_COUNT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JdbcEntityPersistence(DataSource dataSource, PrimaryKeyGenerator primaryKeyGenerator, TimeProvider timeProvider, PC configuration, boolean isHierarchyValuesProfileActive, boolean isDelayModificationUpdateQuery)

Method Summary

Modifier and Type	Method and Description
protected Set<String>	collectEntityIds(String id, String path, boolean includeIdsOnPath)
long	count(Q query) Returns how many entities match the given query.
GlobalId	createUniqueGlobalId(E entity) Returns a unique global id.
T	createUniqueId(E entity) Returns a unique id with the next available primary key that can be used to persist an entity.
void	delete(T id) Deletes the entity with the given id.
E	getByExternalId(T externalId) Retrieves the entity with the given external id.
E	getByGlobalId(GlobalId globalId, TenantId tenantId) Retrieves the entity with the given global id and tenant id.
E	getById(T id) Retrieves the entity with the given id.
protected PC	getConfiguration()
protected ConverterProvider	getConverterProvider()
protected JdbcPersistence	getJdbcPersistence()
protected M	getManager()
protected String	getMappingId(String mappingKey)
String	getNextPrimaryKey() Returns the next available primary key that can be used to persist an entity.
protected Map<String,Object>	getQueryContext(Q query)
protected SqlQueryRenderer	getSqlQueryRenderer()
TimeProvider	getTimeProvider()
T	insert(E entity) Inserts a new entity.
protected abstract void	insertChildren(E entity)
protected boolean	isDelayModificationUpdateQuery()
protected boolean	isHierarchyValuesEnabled()
List<E>	queryList(Q query) Retrieves all entities that match the given query.
E	querySingle(Q query) Retrieves the single entity that matches the given query.
protected Predicate	restrictType(Predicate predicate)
protected abstract void	setChildren(List<R> results, Set<? extends QueryHint> hints)
protected void	setHierarchyValuesProfileActive(boolean hierarchyValuesProfileActive)
protected Collection<String>	transformResultIdsToValues(Collection<? extends IdentifiableResult<E>> identifiableResults)
protected Collection<EntityId>	transformToEntityIds(Collection<String> entityIds)
void	update(E entity, Collection<FieldChange> fieldChanges) Updates the given entity.
protected abstract void	updateChildren(E entity, EB updatedEntityBuilder, Collection<FieldChange> fieldChanges)
protected abstract void	updateEntityInDb(E entity, EB updatedEntityBuilder, IdentifiableParameter entityParameter, Collection<FieldChange> fieldChanges)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_QUERY_ID_COUNT

protected static final int MAX_QUERY_ID_COUNT

See Also:

Constant Field Values

EMPTY_CONTEXT

protected static final Map<String,Object> EMPTY_CONTEXT

Constructor Detail

JdbcEntityPersistence

protected JdbcEntityPersistence(DataSource dataSource,
                                PrimaryKeyGenerator primaryKeyGenerator,
                                TimeProvider timeProvider,
                                PC configuration,
                                boolean isHierarchyValuesProfileActive,
                                boolean isDelayModificationUpdateQuery)
                         throws Exception

Throws:

Exception

Method Detail

getJdbcPersistence

protected JdbcPersistence getJdbcPersistence()

getMappingId

protected String getMappingId(String mappingKey)

getConverterProvider

protected ConverterProvider getConverterProvider()

getSqlQueryRenderer

protected SqlQueryRenderer getSqlQueryRenderer()

getManager

protected M getManager()

getConfiguration

protected PC getConfiguration()

getNextPrimaryKey

public String getNextPrimaryKey()

Description copied from interface: EntityPersistence

Returns the next available primary key that can be used to persist an entity.

Specified by:

getNextPrimaryKey in interface EntityPersistence<T extends EntityId,E extends Entity<T,P>,Q extends EntityQuery>

Returns:

the next available primary key

createUniqueId

public T createUniqueId(E entity)

Description copied from interface: EntityPersistence

Returns a unique id with the next available primary key that can be used to persist an entity.

Specified by:

createUniqueId in interface EntityPersistence<T extends EntityId,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

entity - the entity for which to generate a unique id

Returns:

a unique id with the next available primary key

createUniqueGlobalId

public GlobalId createUniqueGlobalId(E entity)

Description copied from interface: EntityPersistence

Returns a unique global id.

Specified by:

createUniqueGlobalId in interface EntityPersistence<T extends EntityId,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

entity - the entity for which to generate a unique global id

Returns:

a unique global id

insert

public T insert(E entity)

Description copied from interface: EntityPersistence

Inserts a new entity.

Specified by:

insert in interface EntityPersistence<T extends EntityId,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

entity - the entity to be inserted into the entity persistence

Returns:

the unique id of the inserted entity, either already set by the contributor of the entity or generated by this implementation

insertChildren

protected abstract void insertChildren(E entity)

delete

public void delete(T id)

Description copied from interface: EntityPersistence

Deletes the entity with the given id.

Specified by:

delete in interface EntityPersistence<T extends EntityId,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

id - the id of the entity to be deleted from the entity persistence

update

public void update(E entity,
                   Collection<FieldChange> fieldChanges)

Description copied from interface: EntityPersistence

Updates the given entity.

Specified by:

update in interface EntityPersistence<T extends EntityId,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

entity - the entity to be updated in the entity persistence

fieldChanges - optional list of field changes that encapsulate the fine-grained entity changes

updateEntityInDb

protected abstract void updateEntityInDb(E entity,
                                         EB updatedEntityBuilder,
                                         IdentifiableParameter entityParameter,
                                         Collection<FieldChange> fieldChanges)

updateChildren

protected abstract void updateChildren(E entity,
                                       EB updatedEntityBuilder,
                                       Collection<FieldChange> fieldChanges)

getById

public E getById(T id)

Description copied from interface: EntityPersistence

Retrieves the entity with the given id. If no entity can be found for the given id, null is returned.

Specified by:

getById in interface EntityPersistence<T extends EntityId,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

id - the id of the entity to be retrieved

Returns:

the entity with the given id, or null, if no entity with the given id can be found in the entity persistence

getByGlobalId

public E getByGlobalId(GlobalId globalId,
                       TenantId tenantId)

Description copied from interface: EntityPersistence

Retrieves the entity with the given global id and tenant id. If no entity can be found, null is returned.

Specified by:

getByGlobalId in interface EntityPersistence<T extends EntityId,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

globalId - the global id of the entity to be retrieved

tenantId - the tenant id for the tenant to be searched (may be TenantId.UNDEFINED if running in single-tenant mode)

Returns:

the entity with the given global id, or null, if no entity with the given global id and tenant id can be found in the entity persistence

getByExternalId

public E getByExternalId(T externalId)

Description copied from interface: EntityPersistence

Retrieves the entity with the given external id. If no entity can be found for the given external id, null is returned.

Specified by:

getByExternalId in interface EntityPersistence<T extends EntityId,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

externalId - the external id of the entity to be retrieved

Returns:

the entity with the given external id, or null, if no entity with the given external id can be found in the entity persistence

querySingle

public E querySingle(Q query)

Description copied from interface: EntityPersistence

Retrieves the single entity that matches the given query.

Specified by:

querySingle in interface EntityPersistence<T extends EntityId,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

query - the query to match

Returns:

the matching entity, or null, if no entity that matches the given query can be found in the entity persistence

queryList

public List<E> queryList(Q query)

Description copied from interface: EntityPersistence

Retrieves all entities that match the given query.

Specified by:

queryList in interface EntityPersistence<T extends EntityId,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

query - the query to match

Returns:

a list of matching entities, or an empty list, if no entities that match the given query can be found in the entity persistence

getQueryContext

protected Map<String,Object> getQueryContext(Q query)

setChildren

protected abstract void setChildren(List<R> results,
                                    Set<? extends QueryHint> hints)

count

public long count(Q query)

Description copied from interface: EntityPersistence

Returns how many entities match the given query.

Specified by:

count in interface EntityPersistence<T extends EntityId,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

query - the entity query to match

Returns:

the number of matching entities

restrictType

protected Predicate restrictType(Predicate predicate)

transformResultIdsToValues

protected Collection<String> transformResultIdsToValues(Collection<? extends IdentifiableResult<E>> identifiableResults)

transformToEntityIds

protected Collection<EntityId> transformToEntityIds(Collection<String> entityIds)

collectEntityIds

protected Set<String> collectEntityIds(String id,
                                       String path,
                                       boolean includeIdsOnPath)

getTimeProvider

public TimeProvider getTimeProvider()

setHierarchyValuesProfileActive

protected void setHierarchyValuesProfileActive(boolean hierarchyValuesProfileActive)

isHierarchyValuesEnabled

protected boolean isHierarchyValuesEnabled()

isDelayModificationUpdateQuery

protected boolean isDelayModificationUpdateQuery()