com.ocs.dynamo.dao

Interface BaseDao<ID,T extends AbstractEntity<ID>>

Type Parameters:

ID - The type of the primary key of the entity managed by this DAO

T - The type of the entity managed by this DAO

All Known Subinterfaces:

TreeDao<ID,T>

public interface BaseDao<ID,T extends AbstractEntity<ID>>

Interface that all DAO objects must implement

Author:

bas.rutten

Method Summary

Modifier and Type	Method and Description
long	count() Returns the total number of entities of this type
long	count(Filter filter, boolean distinct) Returns the number of entities that match the provided filter
long	count(com.mysema.query.types.Predicate predicate) Returns the number of entities that match the provided predicate
void	delete(List<T> list) Deletes all entities in the provided list
void	delete(T entity) Deletes the provided entity
List<T>	fetch(Filter filter, FetchJoinInformation... joins) Fetches entities that match the provided filter
List<T>	fetch(Filter filter, Pageable pageable, FetchJoinInformation... joins) Fetches entities that match the provided filter
List<T>	fetch(Filter filter, SortOrders orders, FetchJoinInformation... joins) Fetches entities that match the provided filter
T	fetchById(ID id, FetchJoinInformation... joins) Fetches an entity (and its relations) based on its ID
List<T>	fetchByIds(List<ID> ids, SortOrders sortOrders, FetchJoinInformation... joins) Fetches the entities identified by the provided IDs
T	fetchByUniqueProperty(String propertyName, Object value, boolean caseSensitive, FetchJoinInformation... joins) Fetches an entity based on a unique property
List<T>	find(Filter filter) Returns all entities that match the provided filter
List<T>	find(Filter filter, SortOrder... orders) Returns all entities that match the provided filter
List<T>	find(com.mysema.query.types.Predicate predicate) Returns all entities that match a certain predicate
List<T>	find(com.mysema.query.types.Predicate predicate, int firstIndex, int maxResults, SortOrder... sorts) Finds the entities that match a certain predicate
List<T>	findAll() Returns a list of all entities.
List<T>	findAll(SortOrder... sortOrders) Returns a list of all entities.
T	findById(ID id) Finds an object based on its ID
T	findByUniqueProperty(String propertyName, Object value, boolean caseSensitive) Finds an object based on a unique property value
<S> List<S>	findDistinct(Filter filter, String distinctField, Class<S> elementType, SortOrder... orders) Returns all entities that match the provided filter and apply a distinct on the given column
<S> List<S>	findDistinctInCollectionTable(String tableName, String distinctField, Class<S> elementType) Returns all distinct values in a collection table
List<ID>	findIds(Filter filter, SortOrder... orders) Returns the IDS of the entities that match the provided filter
void	flushAndClear() Flushes and clears the entity manager (useful after an explicit update or delete)
Class<T>	getEntityClass() Returns the class of the entity managed by this DAO
List<T>	save(List<T> list) Saves the provide list of entities
T	save(T entity) Saves the provided entity

Method Detail

count

long count()

Returns the total number of entities of this type

Returns:

count

long count(Filter filter,
           boolean distinct)

Returns the number of entities that match the provided filter

Parameters:

filter - the filter

distinct - whether to return only distinct results

Returns:

count

long count(com.mysema.query.types.Predicate predicate)

Returns the number of entities that match the provided predicate

Parameters:

predicate - the predicate

Returns:

delete

void delete(List<T> list)

Deletes all entities in the provided list

Parameters:

list - the list of entities to delete

delete

void delete(T entity)

Deletes the provided entity

Parameters:

entity - the entity to delete

fetch

List<T> fetch(Filter filter,
              FetchJoinInformation... joins)

Fetches entities that match the provided filter

Parameters:

filter - the filter

joins - the desired relations to fetch

Returns:

fetch

List<T> fetch(Filter filter,
              Pageable pageable,
              FetchJoinInformation... joins)

Fetches entities that match the provided filter

Parameters:

filter - the filter

pageable - the page info

joins - the desired relations to fetch

Returns:

fetch

List<T> fetch(Filter filter,
              SortOrders orders,
              FetchJoinInformation... joins)

Fetches entities that match the provided filter

Parameters:

filter - the filter

pageable - the page info

joins - the desired relations to fetch

Returns:

fetchById

T fetchById(ID id,
            FetchJoinInformation... joins)

Fetches an entity (and its relations) based on its ID

Parameters:

id - the ID of the entity

joins - the desired relations to fetch

Returns:

fetchByIds

List<T> fetchByIds(List<ID> ids,
                   SortOrders sortOrders,
                   FetchJoinInformation... joins)

Fetches the entities identified by the provided IDs

Parameters:

ids - the IDs of the entities to fetch

sort - the sort order

joins - the desired relations to fetch

Returns:

fetchByUniqueProperty

T fetchByUniqueProperty(String propertyName,
                        Object value,
                        boolean caseSensitive,
                        FetchJoinInformation... joins)

Fetches an entity based on a unique property

Parameters:

propertyName - the name of the property

value - the value of the property

caseSensitive - indicates whether the value is case sensitive

joins - the desired relations to fetch

Returns:

find

List<T> find(Filter filter)

Returns all entities that match the provided filter

Parameters:

filter - the filter

Returns:

find

List<T> find(Filter filter,
             SortOrder... orders)

Returns all entities that match the provided filter

Parameters:

filter - the filter

sort - the sort info

Returns:

find

List<T> find(com.mysema.query.types.Predicate predicate)

Returns all entities that match a certain predicate

Parameters:

predicate - the predicate

Returns:

find

List<T> find(com.mysema.query.types.Predicate predicate,
             int firstIndex,
             int maxResults,
             SortOrder... sorts)

Finds the entities that match a certain predicate

Parameters:

predicate - the predicate

firstIndex - the index of the first result

maxResults - the maximum number of results

sorts - the sort order information

Returns:

findAll

List<T> findAll()

Returns a list of all entities. Use with caution

Returns:

findAll

List<T> findAll(SortOrder... sortOrders)

Returns a list of all entities. Use with caution

Parameters:

sort - the desired sorting information

Returns:

findById

T findById(ID id)

Finds an object based on its ID

Parameters:

id - the ID

Returns:

the object identified by the ID, or null if it cannot be found

findByUniqueProperty

T findByUniqueProperty(String propertyName,
                       Object value,
                       boolean caseSensitive)

Finds an object based on a unique property value

Parameters:

propertyName - the name of the property

value - the desired value of the property

caseSensitive - whether the match is case sensitive

Returns:

findIds

List<ID> findIds(Filter filter,
                 SortOrder... orders)

Returns the IDS of the entities that match the provided filter

Parameters:

filter - the filter

sort - the desired sorting

Returns:

flushAndClear

void flushAndClear()

Flushes and clears the entity manager (useful after an explicit update or delete)

getEntityClass

Class<T> getEntityClass()

Returns the class of the entity managed by this DAO

Returns:

save

List<T> save(List<T> list)

Saves the provide list of entities

Parameters:

list - the list of entities

Returns:

save

T save(T entity)

Saves the provided entity

Parameters:

entity - the entity to save

Returns:

findDistinct

<S> List<S> findDistinct(Filter filter,
                         String distinctField,
                         Class<S> elementType,
                         SortOrder... orders)

Returns all entities that match the provided filter and apply a distinct on the given column

Parameters:

filter - the filter

distinctField - the field used to remove duplicate rows

orders - the sort info

Returns:

findDistinctInCollectionTable

<S> List<S> findDistinctInCollectionTable(String tableName,
                                          String distinctField,
                                          Class<S> elementType)

Returns all distinct values in a collection table

Parameters:

tableName - the table name

distinctField - the distinct field

elementType - the element type

Returns: