com.edorasware.api.query

Class Query

java.lang.Object

com.edorasware.api.query.Query

public class Query
extends Object

Defines a work object / definition query.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Query.Builder

Method Summary

Modifier and Type	Method and Description
static Query.Builder	builder() Returns a new query builder.
static Query.Builder	builder(Query template) Returns a new query builder based on a template query.
static Query	byPredicate(Predicate predicate) Convenience method to create a Query with the given predicate.
Set<QueryHint>	getHints() The hints to apply when executing the query.
Integer	getLimit() The maximum number of results.
Integer	getOffset() The offset of the first result.
Predicate	getPredicate() The predicate to match.
List<Ordering>	getSorting() The order criteria to sort the results.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getPredicate

public Predicate getPredicate()

The predicate to match.

Returns:

the predicate to match.

getOffset

public Integer getOffset()

The offset of the first result.

Returns:

the first result, index starts at 0

getLimit

public Integer getLimit()

The maximum number of results.

Returns:

the maximum number of results

getSorting

public List<Ordering> getSorting()

The order criteria to sort the results.

Returns:

the order criteria

getHints

public Set<QueryHint> getHints()

The hints to apply when executing the query.

Returns:

the query hints

builder

public static Query.Builder builder()

Returns a new query builder.

Returns:

the query builder

builder

public static Query.Builder builder(Query template)

Returns a new query builder based on a template query.

Parameters:

template - the template query

Returns:

the query builder

byPredicate

public static Query byPredicate(Predicate predicate)

Convenience method to create a Query with the given predicate.

To create a query with paging, sorting, etc., use the full API of the Query.Builder.

Parameters:

predicate - the predicate to match

Returns:

the query

toString

public String toString()

Overrides:

toString in class Object