com.dslplatform.patterns

Class SearchBuilder<T extends Searchable>

java.lang.Object

com.dslplatform.patterns.SearchBuilder<T>

Type Parameters:

T - domain object type.

public class SearchBuilder<T extends Searchable>
extends java.lang.Object

Utility class for building a search over a searchable repository. Search can be performed using more fluent API, by providing specification limit, offset and custom order

Constructor Summary

Constructors

Constructor and Description
SearchBuilder(SearchableRepository<T> repository) Constructor for SearchBuilder which requires a repository to perform a search.

Method Summary

Modifier and Type	Method and Description
SearchBuilder<T>	ascending(java.lang.String property) Order result ascending using a provided property
SearchBuilder<T>	descending(java.lang.String property) Order result descending using a provided property
SearchBuilder<T>	filter(Specification<T> specification) Provide search predicate for filtering results.
SearchBuilder<T>	limit(int limit) Define a maximum number of results
SearchBuilder<T>	offset(int offset) Define a number of results to be skipped.
java.util.concurrent.Future<java.util.List<T>>	search() Returns a list of domain objects which satisfy specification if it was set, otherwise all of them.
SearchBuilder<T>	skip(int offset) Define a number of results to be skipped.
SearchBuilder<T>	take(int limit) Define a maximum number of results.
SearchBuilder<T>	with(Specification<T> specification) Provide search predicate for filtering results.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchBuilder

public SearchBuilder(SearchableRepository<T> repository)

Constructor for SearchBuilder which requires a repository to perform a search.

Parameters:

repository - domain object repository

Method Detail

with

public SearchBuilder<T> with(Specification<T> specification)

Provide search predicate for filtering results.

Parameters:

specification - search predicate

Returns:

itself

filter

public SearchBuilder<T> filter(Specification<T> specification)

Provide search predicate for filtering results.

Parameters:

specification - search predicate

Returns:

itself

limit

public SearchBuilder<T> limit(int limit)

Define a maximum number of results

Parameters:

limit - maximum number of results

Returns:

itself

take

public SearchBuilder<T> take(int limit)

Define a maximum number of results.

Parameters:

limit - maximum number of results

Returns:

itself

offset

public SearchBuilder<T> offset(int offset)

Define a number of results to be skipped.

Parameters:

offset - number of results to be skipped

Returns:

itself

skip

public SearchBuilder<T> skip(int offset)

Define a number of results to be skipped.

Parameters:

offset - number of results to be skipped

Returns:

itself

ascending

public SearchBuilder<T> ascending(java.lang.String property)

Order result ascending using a provided property

Parameters:

property - name of domain objects property

Returns:

itself

descending

public SearchBuilder<T> descending(java.lang.String property)

Order result descending using a provided property

Parameters:

property - name of domain objects property

Returns:

itself

search

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

Returns a list of domain objects which satisfy specification if it was set, otherwise all of them. Parameters can be previously set to limit results, skip offset of initial results and order by some of this domain objects properties.

Returns:

future value of the resulting sequence