com.edorasware.commons.core.query

Class BaseQuery.BaseQueryBuilder<Q extends BaseQuery,SELF extends BaseQuery.BaseQueryBuilder<Q,SELF>>

java.lang.Object

com.edorasware.commons.core.query.BaseQuery.BaseQueryBuilder<Q,SELF>

Direct Known Subclasses:

EntityQuery.EntityQueryBuilder

Enclosing class:

BaseQuery

public abstract static class BaseQuery.BaseQueryBuilder<Q extends BaseQuery,SELF extends BaseQuery.BaseQueryBuilder<Q,SELF>>
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseQueryBuilder() Creates an empty builder instance.
protected	BaseQueryBuilder(Q template) Creates a builder instance initialized from the given query.

Method Summary

Modifier and Type	Method and Description
abstract Q	build()
protected BaseQuery.QueryData	getQueryData() Returns the actual query data.
protected abstract SELF	getThis()
SELF	hints(QueryHint hint) Sets a single query execution hint.
SELF	hints(Set<QueryHint> hints) Sets query execution hints.
SELF	limit(Integer limit) The maximum number of results to retrieve.
SELF	offset(Integer offset) The offset of the first result to retrieve.
SELF	predicate(Predicate predicate) The predicate to match.
SELF	sorting(List<Ordering> sorting) Sets order criteria to sort the results.
SELF	sorting(Ordering sorting) Sets a single order criterion to sort the results.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseQueryBuilder

protected BaseQueryBuilder()

Creates an empty builder instance.

BaseQueryBuilder

protected BaseQueryBuilder(Q template)

Creates a builder instance initialized from the given query.

Parameters:

template - the template query

Method Detail

getQueryData

protected final BaseQuery.QueryData getQueryData()

Returns the actual query data.

Returns:

the query data

predicate

public SELF predicate(Predicate predicate)

The predicate to match.

Parameters:

predicate - the predicate to match

Returns:

this builder instance

offset

public SELF offset(Integer offset)

The offset of the first result to retrieve.

Parameters:

offset - the first result to retrieve, index starts at 0

Returns:

this builder instance

limit

public SELF limit(Integer limit)

The maximum number of results to retrieve.

Parameters:

limit - the maximum number of results to retrieve

Returns:

this builder instance

sorting

public SELF sorting(Ordering sorting)

Sets a single order criterion to sort the results.

Parameters:

sorting - the order criterion

Returns:

this builder instance

sorting

public SELF sorting(List<Ordering> sorting)

Sets order criteria to sort the results. An empty set resets to default order.

Parameters:

sorting - the order criteria

Returns:

this builder instance

hints

public SELF hints(QueryHint hint)

Sets a single query execution hint.

Parameters:

hint - the query execution hint

Returns:

this builder instance

hints

public SELF hints(Set<QueryHint> hints)

Sets query execution hints. An empty set clears all hints.

Parameters:

hints - the query execution hints

Returns:

this builder instance

getThis

protected abstract SELF getThis()

build

public abstract Q build()