org.iternine.jeppetto.dao

Interface GenericDAO<T,ID>

Type Parameters:

T - Type of entity

ID - ID type for the entity.

All Known Subinterfaces:

AccessControlDAO<T,ID>, QueryModelDAO<T,ID>

public interface GenericDAO<T,ID>

A GenericDAO is the root interface for DAOs that fit within the Jeppetto framework. This defines base functionality such as finding a specific entity by its identifier and saving an entity to the underlying data store.

Method Summary

Modifier and Type	Method and Description
void	delete(T entity) Delete the specified object from the persistent store.
void	deleteById(ID id) Delete an object from the persistent store based on the id.
void	deleteByIds(ID... ids) Delete objects from the persistent store based on the passed in id values.
java.lang.Iterable<T>	findAll() Find all objects of type T.
T	findById(ID id) Find an object T with the specified id.
java.lang.Iterable<T>	findByIds(ID... ids) Find objects of type T with the specified ids.
void	flush() If the implementation supports lazy writes, manually flush changes to the external database
<U extends T> U	getUpdateObject() Get an object that can be used to capture a set of changes to be applied to one ore more persisted objects.
void	save(T entity) Call save to insert a new object into the persistent store or update a preexisting object that has been modified.
<U extends T> T	updateById(U updateObject, ID id) Apply the set of changes described in the update object to the persisted item with the specified id.
<U extends T> java.lang.Iterable<T>	updateByIds(U updateObject, ID... ids) Apply the set of changes described in the update object to persisted items with the specified ids.

Method Detail

findById

T findById(ID id)
    throws NoSuchItemException,
           JeppettoException

Find an object T with the specified id.

Parameters:

id - of the desired object.

Returns:

Object with the specified id

Throws:

NoSuchItemException - if the object identified by the id is not found

JeppettoException - if any other failure occurs

findByIds

java.lang.Iterable<T> findByIds(ID... ids)
                         throws JeppettoException

Find objects of type T with the specified ids.

Parameters:

ids - of the desired object.

Returns:

Iterable of T

Throws:

JeppettoException - if any other failure occurs

findAll

java.lang.Iterable<T> findAll()
                       throws JeppettoException

Find all objects of type T.

Returns:

Iterable of T

Throws:

JeppettoException - if any underlying failure occurs

save

void save(T entity)
   throws OptimisticLockException,
          JeppettoException

Call save to insert a new object into the persistent store or update a preexisting object that has been modified.

Parameters:

entity - to save.

Throws:

OptimisticLockException - if optimistic locking is enabled and a save is attempted on an already modified object.

JeppettoException - if any other failure occurs

delete

void delete(T entity)
     throws JeppettoException

Delete the specified object from the persistent store.

Parameters:

entity - to delete.

Throws:

JeppettoException - if any underlying failure occurs

deleteById

void deleteById(ID id)
         throws JeppettoException

Delete an object from the persistent store based on the id.

Parameters:

id - of the object to delete.

Throws:

JeppettoException - if any underlying failure occurs

deleteByIds

void deleteByIds(ID... ids)
          throws FailedBatchException,
                 JeppettoException

Delete objects from the persistent store based on the passed in id values.

Parameters:

ids - of the objects to delete.

Throws:

FailedBatchException - if some (or all) of the ids were not successfully deleted. The exception contains a list of the ids that failed to delete.

JeppettoException - if any underlying failure occurs

getUpdateObject

<U extends T> U getUpdateObject()

Get an object that can be used to capture a set of changes to be applied to one ore more persisted objects.

Returns:

An update object that is either a T or a subclass of T

Throws:

JeppettoException - if any underlying failure occurs

updateById

<U extends T> T updateById(U updateObject,
                           ID id)
                    throws JeppettoException

Apply the set of changes described in the update object to the persisted item with the specified id.

Parameters:

updateObject - that describes the set of changes to be applied.

id - of the object to update.

Throws:

JeppettoException - if any underlying failure occurs

updateByIds

<U extends T> java.lang.Iterable<T> updateByIds(U updateObject,
                                                ID... ids)
                                         throws FailedBatchException,
                                                JeppettoException

Apply the set of changes described in the update object to persisted items with the specified ids.

Parameters:

updateObject - that describes the set of changes to be applied.

ids - of the objects to update.

Throws:

FailedBatchException - if some (or all) of the referenced items were not successfully updated. The exception contains a list of the ids that failed to update.

JeppettoException - if any underlying failure occurs

flush

void flush()
    throws JeppettoException

If the implementation supports lazy writes, manually flush changes to the external database

Throws:

JeppettoException - if any underlying failure occurs