co.codewizards.cloudstore.local.persistence

Class Dao<E extends Entity,D extends Dao<E,D>>

java.lang.Object

co.codewizards.cloudstore.local.persistence.Dao<E,D>

All Implemented Interfaces:

ContextWithPersistenceManager

Direct Known Subclasses:

CopyModificationDao, DeleteModificationDao, DirectoryDao, FileInProgressMarkerDao, LastSyncToRemoteRepoDao, LocalRepositoryDao, ModificationDao, NormalFileDao, RemoteRepositoryDao, RemoteRepositoryRequestDao, RepoFileDao

public abstract class Dao<E extends Entity,D extends Dao<E,D>>
extends Object
implements ContextWithPersistenceManager

Base class for all data access objects (Daos).

Usually an instance of a Dao is obtained using LocalRepoTransaction.getDao(...).

Author:

Marco หงุ่ยตระกูล-Schulze - marco at nightlabs dot de

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Dao.IdRange

Constructor Summary

Constructors

Constructor and Description
Dao() Instantiate the Dao.

Method Summary

Modifier and Type	Method and Description
protected String	buildIdRangePackageFilter(int idRangePackageSize)
protected Map<String,Object>	buildIdRangePackageQueryMap(List<Dao.IdRange> idRangePackage) Build the query-argument-map corresponding to #buildIdRangePackageFilter().
protected static List<List<Dao.IdRange>>	buildIdRangePackages(SortedSet<Long> entityIds) Organise the given entity-IDs in Dao.IdRanges, which itself are grouped into packages.
protected static List<List<Dao.IdRange>>	buildIdRangePackages(SortedSet<Long> entityIds, int idRangePackageSize) Deprecated. Only used for junit-test! Use buildIdRangePackages(SortedSet) instead! Don't use this method directly!
protected void	clearFetchGroups()
void	deletePersistent(E entity)
void	deletePersistentAll(Collection<? extends E> entities)
protected <T extends Dao<?,?>> T	getDao(Class<T> daoClass)
DaoProvider	getDaoProvider()
Class<E>	getEntityClass() Get the type of the entity.
E	getObjectByIdOrFail(long id) Get the entity-instance referenced by the specified identifier.
E	getObjectByIdOrNull(long id) Get the entity-instance referenced by the specified identifier.
Collection<E>	getObjects()
long	getObjectsCount()
PersistenceManager	getPersistenceManager() Gets the PersistenceManager assigned to this Dao.
protected Collection<E>	load(Collection<E> entities)
protected <T> List<T>	loadDtos(Collection<E> entities, Class<T> dtoClass, String queryResult)
<P extends E> P	makePersistent(P entity)
D	persistenceManager(PersistenceManager persistenceManager) Assigns the given PersistenceManager to this Dao and returns this.
protected PersistenceManager	pm()
void	setDaoProvider(DaoProvider daoProvider)
void	setPersistenceManager(PersistenceManager persistenceManager) Assigns the given PersistenceManager to this Dao.
protected static int	shrinkIdRangePackageSizeIfPossible(List<List<Dao.IdRange>> idRangePackages)
protected D	thisDao()

Methods inherited from class java.lang.Object

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

Constructor Detail

Dao

public Dao()

Instantiate the Dao.

It is recommended not to invoke this constructor directly, but instead use LocalRepoTransaction.getDao(...), if a LocalRepoTransaction is available (which should be in most situations).

After constructing, you must assign a PersistenceManager, before you can use the Dao. This is already done when using the LocalRepoTransaction's factory method.

Method Detail

getPersistenceManager

public PersistenceManager getPersistenceManager()

Gets the PersistenceManager assigned to this Dao.

Specified by:

getPersistenceManager in interface ContextWithPersistenceManager

Returns:

the PersistenceManager assigned to this Dao. May be null, if none was assigned, yet.

See Also:

setPersistenceManager(PersistenceManager), persistenceManager(PersistenceManager)

setPersistenceManager

public void setPersistenceManager(PersistenceManager persistenceManager)

Assigns the given PersistenceManager to this Dao.

The Dao cannot be used, before a non-null value was set using this method.

Parameters:

persistenceManager - the PersistenceManager to be used by this Dao. May be null, but a non-null value must be set to make this Dao usable.

See Also:

persistenceManager(PersistenceManager)

pm

protected PersistenceManager pm()

getDaoProvider

public DaoProvider getDaoProvider()

setDaoProvider

public void setDaoProvider(DaoProvider daoProvider)

persistenceManager

public D persistenceManager(PersistenceManager persistenceManager)

Assigns the given PersistenceManager to this Dao and returns this.

This method delegates to setPersistenceManager(PersistenceManager).

Parameters:

persistenceManager - the PersistenceManager to be used by this Dao. May be null, but a non-null value must be set to make this Dao usable.

Returns:

this for a fluent API.

See Also:

setPersistenceManager(PersistenceManager)

thisDao

protected D thisDao()

getEntityClass

public Class<E> getEntityClass()

Get the type of the entity.

Returns:

the type of the entity; never null.

getObjectByIdOrFail

public E getObjectByIdOrFail(long id)
                      throws JDOObjectNotFoundException

Get the entity-instance referenced by the specified identifier.

Parameters:

id - the identifier referencing the desired entity. Must not be null.

Returns:

the entity-instance referenced by the specified identifier. Never null.

Throws:

JDOObjectNotFoundException - if the entity referenced by the given identifier does not exist.

getObjectByIdOrNull

public E getObjectByIdOrNull(long id)

Get the entity-instance referenced by the specified identifier.

Parameters:

id - the identifier referencing the desired entity. Must not be null.

Returns:

the entity-instance referenced by the specified identifier or null, if no such entity exists.

getObjects

public Collection<E> getObjects()

getObjectsCount

public long getObjectsCount()

makePersistent

public <P extends E> P makePersistent(P entity)

deletePersistent

public void deletePersistent(E entity)

deletePersistentAll

public void deletePersistentAll(Collection<? extends E> entities)

load

protected Collection<E> load(Collection<E> entities)

loadDtos

protected <T> List<T> loadDtos(Collection<E> entities,
                               Class<T> dtoClass,
                               String queryResult)

shrinkIdRangePackageSizeIfPossible

protected static int shrinkIdRangePackageSizeIfPossible(List<List<Dao.IdRange>> idRangePackages)

buildIdRangePackageFilter

protected String buildIdRangePackageFilter(int idRangePackageSize)

buildIdRangePackageQueryMap

protected Map<String,Object> buildIdRangePackageQueryMap(List<Dao.IdRange> idRangePackage)

Build the query-argument-map corresponding to #buildIdRangePackageFilter().

Parameters:

idRangePackage - the id-range-package for which to build the argument-map. Never null.

Returns:

the query-argument-map used by Query.executeWithMap(Map). Never null.

buildIdRangePackages

protected static List<List<Dao.IdRange>> buildIdRangePackages(SortedSet<Long> entityIds)

Organise the given entity-IDs in Dao.IdRanges, which itself are grouped into packages.

Each package, i.e. each element in the returned main List has a fixed size of elements.

Parameters:

entityIds - entity-IDs to be organised in ranges. Must not be null.

Returns:

id-range-packages. Never null.

buildIdRangePackages

@Deprecated
protected static List<List<Dao.IdRange>> buildIdRangePackages(SortedSet<Long> entityIds,
                                                                          int idRangePackageSize)

Deprecated. Only used for junit-test! Use buildIdRangePackages(SortedSet) instead! Don't use this method directly!

getDao

protected <T extends Dao<?,?>> T getDao(Class<T> daoClass)

clearFetchGroups

protected void clearFetchGroups()