com.ocs.dynamo.service

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

Type Parameters:

ID - the type of the primary key of the entity

T - the type of the entity

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

The interface for a service that manages an entity

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
T	createNewEntity() Creates a new entity
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, int pageNumber, int pageSize, FetchJoinInformation... joins) Fetches a page of entities that match the provided filter
List<T>	fetch(Filter filter, int pageNumber, int pageSize, SortOrders sortOrders, FetchJoinInformation... joins) Fetches a page of 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, FetchJoinInformation... joins) Fetches the entities identified by the provided IDs
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, sorted according to the provided sort orders
List<T>	findAll() Returns a list of all entities.
List<T>	findAll(SortOrder... sortOrders) Returns a list of all entities, sorted according to the provided sort orders
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> resultType, SortOrder... orders) Returns all distinct values that appear in a certain field for all entities that match the provided filter
<S> List<S>	findDistinctInCollectionTable(String tableName, String distinctField, Class<S> elementType) Finds distinct elements in a collection table
List<ID>	findIds(Filter filter, SortOrder... orders) Returns the IDS of the entities that match the provided filter
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
void	update(List<T> toUpdate, List<T> toAdd, List<T> toDelete) Updates, adds, and deletes

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:

createNewEntity

T createNewEntity()

Creates a new entity

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,
              int pageNumber,
              int pageSize,
              FetchJoinInformation... joins)

Fetches a page of entities that match the provided filter

Parameters:

filter - the filter

pageNumber - the page number of the page to fetch

pageSize - the page size

joins - the desired relations to fetch

Returns:

fetch

List<T> fetch(Filter filter,
              int pageNumber,
              int pageSize,
              SortOrders sortOrders,
              FetchJoinInformation... joins)

Fetches a page of entities that match the provided filter

Parameters:

filter - the filter

pageNumber - the page number of the page to fetch

pageSize - the page size

sortOrders - any sort orders to apply to the search results

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,
                   FetchJoinInformation... joins)

Fetches the entities identified by the provided IDs

Parameters:

ids - the IDs

joins - 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, sorted according to the provided sort orders

Parameters:

filter - the filter

orders - the sort order

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, sorted according to the provided sort orders

Parameters:

sort - the desired sort orders

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:

findDistinct

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

Returns all distinct values that appear in a certain field for all entities that match the provided filter

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)

Finds distinct elements in a collection table

Parameters:

tableName - the name of the table

distinctField - the name of the field

elementType - the element type

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:

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:

update

void update(List<T> toUpdate,
            List<T> toAdd,
            List<T> toDelete)

Updates, adds, and deletes

Parameters:

toUpdate - to update

toAdd - to add

toDelete - to delete