Package com.devonfw.module.jpa.dataaccess.base

Class AbstractGenericRevisionedDao<ID,ENTITY extends com.devonfw.module.basic.common.api.entity.RevisionedPersistenceEntity<ID>>

java.lang.Object

com.devonfw.module.jpa.dataaccess.api.QueryHelper

com.devonfw.module.jpa.dataaccess.base.AbstractGenericDao<ID,ENTITY>

com.devonfw.module.jpa.dataaccess.base.AbstractGenericRevisionedDao<ID,ENTITY>

Type Parameters:

ID - is the type of the primary key of the managed entity.

ENTITY - is the type of the managed entity.

All Implemented Interfaces:

com.devonfw.module.jpa.dataaccess.api.feature.FeatureForceIncrementModificationCounter<ENTITY>, GenericDao<ID,ENTITY>, GenericRevisionedDao<ID,ENTITY>

Direct Known Subclasses:

AbstractRevisionedDao

public abstract class AbstractGenericRevisionedDao<ID,ENTITY extends com.devonfw.module.basic.common.api.entity.RevisionedPersistenceEntity<ID>>
extends AbstractGenericDao<ID,ENTITY>
implements GenericRevisionedDao<ID,ENTITY>

This is the abstract base-implementation of a AbstractGenericDao using to manage the revision-control.

Since:

3.0.0

Field Summary

Fields inherited from class com.devonfw.module.jpa.dataaccess.api.QueryHelper

QUERY_PROPERTY_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
AbstractGenericRevisionedDao()	The constructor.

Method Summary

Modifier and Type	Method	Description
protected org.hibernate.envers.AuditReader	getAuditReader()
List<Number>	getRevisionHistory(ID id)	This method will get the List of historic revisions of the entity with the given id. If the entity is NOT revision controlled, an empty list is returned.
List<com.devonfw.module.basic.common.api.RevisionMetadata>	getRevisionHistoryMetadata(Object id)	This method will get the List of RevisionMetadata from the revision-history of the entity with the given id.
ENTITY	load(ID id, Number revision)	This method loads a historic revision of the RevisionedEntity with the given id from the persistent store.
protected ENTITY	loadRevision(Object id, Number revision)	This method gets a historic revision of the entity with the given id.

Methods inherited from class com.devonfw.module.jpa.dataaccess.base.AbstractGenericDao

delete, delete, delete, exists, find, findAll, findAll, findOne, forceIncrementModificationCounter, get, getEntityClass, getEntityManager, getEntityName, isNew, save, save, setEntityManager, toCollection

Methods inherited from class com.devonfw.module.jpa.dataaccess.api.QueryHelper

applySort, applyTimeout, findPaginatedGeneric, newInClause, newLikeClause, newLikeClause, newNotLikeClause, newStringClause, newStringClause, whereIn, whereLike, whereNotLike, whereString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.devonfw.module.jpa.dataaccess.api.feature.FeatureForceIncrementModificationCounter

forceIncrementModificationCounter

Methods inherited from interface com.devonfw.module.jpa.dataaccess.api.GenericDao

delete, delete, exists, find, findAll, findOne, get, save, save

Methods inherited from interface com.devonfw.module.jpa.dataaccess.api.GenericRevisionedDao

delete

Constructor Detail

AbstractGenericRevisionedDao

public AbstractGenericRevisionedDao()

The constructor.

Method Detail

getAuditReader

protected org.hibernate.envers.AuditReader getAuditReader()

Returns:

the auditReader

load

public ENTITY load(ID id,
                   Number revision)

Description copied from interface: GenericRevisionedDao

This method loads a historic revision of the RevisionedEntity with the given id from the persistent store.
However if the given revision is RevisionedEntity.LATEST_REVISION the latest revision will be loaded.
ATTENTION:
You should not make assumptions about the revision numbering of the underlying implementation. Please use GenericRevisionedDao.getRevisionHistory(Object) or GenericRevisionedDao.getRevisionHistoryMetadata(Object) to find revision numbers.

Specified by:

load in interface GenericRevisionedDao<ID,ENTITY extends com.devonfw.module.basic.common.api.entity.RevisionedPersistenceEntity<ID>>

Parameters:

id - is the primary key of the requested entity.

revision - is the revision of the requested entity or RevisionedEntity.LATEST_REVISION to get the latest revision. A specific revision has to be greater than 0.

Returns:

the requested entity.

loadRevision

protected ENTITY loadRevision(Object id,
                              Number revision)

This method gets a historic revision of the entity with the given id.

Parameters:

id - is the ID of the requested entity.

revision - is the revision

Returns:

the requested entity.

getRevisionHistory

public List<Number> getRevisionHistory(ID id)

Description copied from interface: GenericRevisionedDao

This method will get the List of historic revisions of the entity with the given id.
If the entity is NOT revision controlled, an empty list is returned.

Specified by:

getRevisionHistory in interface GenericRevisionedDao<ID,ENTITY extends com.devonfw.module.basic.common.api.entity.RevisionedPersistenceEntity<ID>>

Parameters:

id - the primary key of the entity to retrieve the history for.

Returns:

the List of historic revisions.

getRevisionHistoryMetadata

public List<com.devonfw.module.basic.common.api.RevisionMetadata> getRevisionHistoryMetadata(Object id)

Description copied from interface: GenericRevisionedDao

This method will get the List of RevisionMetadata from the revision-history of the entity with the given id.

Specified by:

getRevisionHistoryMetadata in interface GenericRevisionedDao<ID,ENTITY extends com.devonfw.module.basic.common.api.entity.RevisionedPersistenceEntity<ID>>

Parameters:

id - is the primary key of the entity for which the history-metadata is requested.

Returns:

the requested List of RevisionMetadata.