com.dslplatform.patterns

Interface SearchableRepository<T extends Searchable>

Type Parameters:

T - domain object type.

All Known Subinterfaces:

PersistableRepository<T>, Repository<T>

All Known Implementing Classes:

ClientPersistableRepository, ClientRepository, ClientSearchableRepository

public interface SearchableRepository<T extends Searchable>

Service for searching and counting domain objects. Search can be performed using specification, paged using limit and offset arguments. Custom sort can be provided using list of property->direction pairs.

Specification can be declared in DSL or custom search can be built on client and sent to server.

When permissions are applied, server can restrict which results will be returned to the client. Service should be used when Future is a preferred way of interacting with the remote server.

Method Summary

Methods

Modifier and Type	Method and Description
SearchBuilder<T>	builder() Returns an instance of search builder for this repository.
java.util.concurrent.Future<java.lang.Long>	count(Specification<T> specification) Returns a number of elements satisfying provided specification.
java.util.concurrent.Future<java.lang.Long>	countAll() Returns a total number of domain objects.
java.util.concurrent.Future<java.util.List<T>>	findAll() Returns a list of all domain objects
java.util.concurrent.Future<java.util.List<T>>	findAll(java.lang.Integer limit, java.lang.Integer offset) Returns a list of all domain objects with up to limit results.
java.util.concurrent.Future<java.util.List<T>>	findAll(java.lang.Integer limit, java.lang.Integer offset, java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> order) Returns a list of all domain objects with up to limit results.
java.util.concurrent.Future<java.util.List<T>>	search(Specification<T> specification) Returns a list of domain objects satisfying specification
java.util.concurrent.Future<java.util.List<T>>	search(Specification<T> specification, java.lang.Integer limit, java.lang.Integer offset) Returns a list of domain objects satisfying specification with up to limit results.
java.util.concurrent.Future<java.util.List<T>>	search(Specification<T> specification, java.lang.Integer limit, java.lang.Integer offset, java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> order) Returns a list of domain objects satisfying specification with up to limit results.

Method Detail

search

java.util.concurrent.Future<java.util.List<T>> search(Specification<T> specification,
                                                    java.lang.Integer limit,
                                                    java.lang.Integer offset,
                                                    java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> order)

Returns a list of domain objects satisfying specification with up to limit results. offset can be used to skip initial results. order should be given as a list of pairs of <String, Boolean> where first is a property name and second is whether it should be sorted ascending over this property.

Parameters:

specification - search predicate

limit - maximum number of results

offset - number of results to be skipped

order - custom ordering

Returns:

future to domain objects which satisfy search predicate

search

java.util.concurrent.Future<java.util.List<T>> search(Specification<T> specification,
                                                    java.lang.Integer limit,
                                                    java.lang.Integer offset)

Returns a list of domain objects satisfying specification with up to limit results. offset can be used to skip initial results.

Parameters:

specification - search predicate

limit - maximum number of results

offset - number of results to be skipped

Returns:

future to domain objects which satisfy search predicate

search

java.util.concurrent.Future<java.util.List<T>> search(Specification<T> specification)

Returns a list of domain objects satisfying specification

Parameters:

specification - search predicate

Returns:

future to domain objects which satisfy search predicate

findAll

java.util.concurrent.Future<java.util.List<T>> findAll(java.lang.Integer limit,
                                                     java.lang.Integer offset,
                                                     java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> order)

Returns a list of all domain objects with up to limit results. offset can be used to skip initial results. order should be given as a list of pairs of <String, Boolean> where first is a property name and second is whether it should be sorted ascending over this property.

Parameters:

limit - maximum number of results

offset - number of results to be skipped

order - custom ordering

Returns:

future to found domain objects

findAll

java.util.concurrent.Future<java.util.List<T>> findAll(java.lang.Integer limit,
                                                     java.lang.Integer offset)

Returns a list of all domain objects with up to limit results. offset can be used to skip initial results.

Parameters:

limit - maximum number of results

offset - number of results to be skipped

Returns:

future to found domain objects

findAll

java.util.concurrent.Future<java.util.List<T>> findAll()

Returns a list of all domain objects

Returns:

future found domain objects

count

java.util.concurrent.Future<java.lang.Long> count(Specification<T> specification)

Returns a number of elements satisfying provided specification.

Parameters:

specification - search predicate

Returns:

future to number of domain objects which satisfy specification

countAll

java.util.concurrent.Future<java.lang.Long> countAll()

Returns a total number of domain objects.

Returns:

future to number of domain objects

builder

SearchBuilder<T> builder()

Returns an instance of search builder for this repository. Search builder is helper class with fluent API for building search.

Returns:

utility class for building a search.