org.terracotta.toolkit.search
Interface QueryBuilder

public interface QueryBuilder

This class encapsulates query building functionality. It can be thought of as a reusable factory to create queries from given specifications. Once created, however, search queries can no longer be modified.

See Also:

ToolkitSearchQuery

Method Summary

QueryBuilder	addClause(Clause clause) Add a constraining clause to query to be built by this builder
QueryBuilder	addGroupBy(Attribute<?>... attr)
QueryBuilder	addOrderBy(Attribute<?> attr, SortDirection dir)
ToolkitSearchQuery	build() Build the (immutable) query instance
QueryBuilder	includeAggregator(AggregateFunction... aggregators)
QueryBuilder	includeAttribute(Attribute<?>... attr)
QueryBuilder	includeKeys(boolean choice)
QueryBuilder	includeValues(boolean choice)
QueryBuilder	maxResults(int max)
QueryBuilder	resultPageSize(int size)

Method Detail

includeKeys

QueryBuilder includeKeys(boolean choice)

includeValues

QueryBuilder includeValues(boolean choice)

maxResults

QueryBuilder maxResults(int max)

includeAttribute

QueryBuilder includeAttribute(Attribute<?>... attr)

addGroupBy

QueryBuilder addGroupBy(Attribute<?>... attr)

addOrderBy

QueryBuilder addOrderBy(Attribute<?> attr,
                        SortDirection dir)

includeAggregator

QueryBuilder includeAggregator(AggregateFunction... aggregators)

resultPageSize

QueryBuilder resultPageSize(int size)

addClause

QueryBuilder addClause(Clause clause)

Add a constraining clause to query to be built by this builder

build

ToolkitSearchQuery build()

Build the (immutable) query instance