Package com.appiancorp.common.query

Class Query.Builder<T>

java.lang.Object

com.appiancorp.common.query.Query.Builder<T>

All Implemented Interfaces:

QueryBuilder<T>, QueryBuilder.Aggregating<T>, QueryBuilder.Filtering<T>, QueryBuilder.FilteringCriteria<T>, QueryBuilder.Grouping<T>, QueryBuilder.Paging<T>, QueryBuilder.Selecting<T>, QueryBuilder.Sorting<T>

Direct Known Subclasses:

GenericQuery.GenericBuilder, TypedValueQuery.TypedValueBuilder

Enclosing class:

Query<T>

public abstract static class Query.Builder<T>
extends Object
implements QueryBuilder<T>, QueryBuilder.Selecting<T>, QueryBuilder.Filtering<T>, QueryBuilder.FilteringCriteria<T>, QueryBuilder.Grouping<T>, QueryBuilder.Aggregating<T>, QueryBuilder.Paging<T>, QueryBuilder.Sorting<T>

A class for incrementally build a Query.

The objective of this builder is to help the developer to construct a Query in a more organic way to ease development and avoid invalid configurations.

Each method returns the same Builder instance, but it is bound by interface which the method returns. This way is simulating a flow and the available valid configurations after the current configuration.

Nested Class Summary

Nested classes/interfaces inherited from interface com.appiancorp.common.query.QueryBuilder

QueryBuilder.Aggregating<T>, QueryBuilder.Filtering<T>, QueryBuilder.FilteringCriteria<T>, QueryBuilder.Grouping<T>, QueryBuilder.Paging<T>, QueryBuilder.Selecting<T>, QueryBuilder.Sorting<T>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Initializes a newly created Builder
protected	Builder(Query query)	Constructs a Builder using the given Query as a base

Method Summary

Modifier and Type	Method	Description
QueryBuilder.Grouping<T>	aggregate(AggregationColumn... a)	Obtains the set of operations allowed after QueryBuilder.Aggregating<T>
QueryBuilder.Grouping<T>	aggregate(List<AggregationColumn> a)	Obtains the set of operations allowed after QueryBuilder.Aggregating<T>
QueryBuilder.Grouping<T>	and(Criteria... criteria)	Obtains the set of operations allowed after QueryBuilder.FilteringCriteria<T>
Query<T>	build()	Produces a Query<T> instance at any point in time its called.
QueryBuilder.Grouping<T>	criteria(Criteria criteria)	Obtains the set of operations allowed after QueryBuilder.FilteringCriteria<T>
QueryBuilder.Aggregating<T>	groupBy(Column... c)	Obtains the set of operations allowed after QueryBuilder.Grouping<T>
QueryBuilder.Aggregating<T>	groupBy(ColumnAlias... alias)	Obtains the set of operations allowed after QueryBuilder.Grouping<T>
QueryBuilder.Aggregating<T>	groupBy(String... c)	Obtains the set of operations allowed after QueryBuilder.Grouping<T>
protected abstract LogicalExpression<?>	newLogicalOperation(LogicalOperator lo, List<Criteria> conditions)	Returns a LogicalExpression instance
protected final Query<T>	newQuerySimplified(Projection<? extends Column> projection, Criteria criteria, PagingInfo pagingInfo)
QueryBuilder.Grouping<T>	or(Criteria... criteria)	Obtains the set of operations allowed after QueryBuilder.FilteringCriteria<T>
QueryBuilder.Sorting<T>	page(int startIndex, int batchSize)	Obtains the set of operations allowed after QueryBuilder.Paging<T>
QueryBuilder<T>	page(PagingInfo pagingInfo)	Defines query's PagingInfo
QueryBuilder.Grouping<T>	project(Aggregation a)	Obtains the set of operations allowed after QueryBuilder.Aggregating<T>
QueryBuilder.Filtering<T>	project(Selection s)	Obtains the set of operations allowed after QueryBuilder.Selecting<T>
QueryBuilder.Filtering<T>	select(Column... c)	Obtains the set of operations allowed after QueryBuilder.Selecting<T>
QueryBuilder.Filtering<T>	select(ColumnAlias... alias)	Obtains the set of operations allowed after QueryBuilder.Selecting<T>
QueryBuilder.Filtering<T>	select(String... c)	Obtains the set of operations allowed after QueryBuilder.Selecting<T>
QueryBuilder.Filtering<T>	select(Collection<String> c)	Obtains the set of operations allowed after QueryBuilder.Selecting<T>
QueryBuilder.Filtering<T>	select(List<Column> c)	Obtains the set of operations allowed after QueryBuilder.Selecting<T>
QueryBuilder.Filtering<T>	selectFirst(String column)
QueryBuilder<T>	sortBy(ReadOnlySortInfo... sortInfos)	Defines the query's sorting information
QueryBuilder<T>	sortBy(SortInfo... sortInfos)	Defines the query's sorting information
QueryBuilder<T>	sortBy(com.google.common.collect.ImmutableList<ReadOnlySortInfo> sortInfos)	Defines the query's sorting information
QueryBuilder<T>	sortBy(List<SortInfo> sortInfos)	Defines the query's sorting information

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Initializes a newly created Builder

Builder

protected Builder(Query query)

Constructs a Builder using the given Query as a base

Parameters:

query - a Query

Method Details

newQuerySimplified

protected final Query<T> newQuerySimplified(Projection<? extends Column> projection,
 Criteria criteria,
 PagingInfo pagingInfo)

select

public QueryBuilder.Filtering<T> select(String... c)

Description copied from interface: QueryBuilder.Selecting

Obtains the set of operations allowed after QueryBuilder.Selecting<T>

Specified by:

select in interface QueryBuilder.Selecting<T>

Parameters:

c - the array of column names which the query is going to select

Returns:

the QueryBuilder.Filtering<T> interface with the set of operations allowed after QueryBuilder.Selecting<T>

select

public QueryBuilder.Filtering<T> select(Collection<String> c)

Description copied from interface: QueryBuilder.Selecting

Obtains the set of operations allowed after QueryBuilder.Selecting<T>

Specified by:

select in interface QueryBuilder.Selecting<T>

Parameters:

c - the list of column names which the query is going to select

Returns:

the QueryBuilder.Filtering<T> interface with the set of operations allowed after QueryBuilder.Selecting<T>

selectFirst

public QueryBuilder.Filtering<T> selectFirst(String column)

select

public QueryBuilder.Filtering<T> select(ColumnAlias... alias)

Description copied from interface: QueryBuilder.Selecting

Obtains the set of operations allowed after QueryBuilder.Selecting<T>

Specified by:

select in interface QueryBuilder.Selecting<T>

Parameters:

alias - the array of ColumnAlias which the query is going to select

Returns:

the QueryBuilder.Filtering<T> interface with the set of operations allowed after QueryBuilder.Selecting<T>

select

public QueryBuilder.Filtering<T> select(Column... c)

Description copied from interface: QueryBuilder.Selecting

Obtains the set of operations allowed after QueryBuilder.Selecting<T>

Specified by:

select in interface QueryBuilder.Selecting<T>

Parameters:

c - the array of Column which the query is going to select

Returns:

the QueryBuilder.Filtering<T> interface with the set of operations allowed after QueryBuilder.Selecting<T>

select

public QueryBuilder.Filtering<T> select(List<Column> c)

Description copied from interface: QueryBuilder.Selecting

Obtains the set of operations allowed after QueryBuilder.Selecting<T>

Specified by:

select in interface QueryBuilder.Selecting<T>

Parameters:

c - the list of ColumnAlias which the query is going to select

Returns:

the QueryBuilder.Filtering<T> interface with the set of operations allowed after QueryBuilder.Selecting<T>

project

public QueryBuilder.Filtering<T> project(Selection s)

Description copied from interface: QueryBuilder.Selecting

Obtains the set of operations allowed after QueryBuilder.Selecting<T>

Specified by:

project in interface QueryBuilder.Selecting<T>

Parameters:

s - the Selection to be performed by the query

Returns:

the QueryBuilder.Filtering<T> interface with the set of operations allowed after QueryBuilder.Selecting<T>

criteria

public QueryBuilder.Grouping<T> criteria(Criteria criteria)

Description copied from interface: QueryBuilder.FilteringCriteria

Obtains the set of operations allowed after QueryBuilder.FilteringCriteria<T>

Specified by:

criteria in interface QueryBuilder.Filtering<T>

Specified by:

criteria in interface QueryBuilder.FilteringCriteria<T>

Parameters:

criteria - The Criteria used to bound the query.

Returns:

the QueryBuilder.Grouping<T> interface with the set of operations allowed after QueryBuilder.FilteringCriteria<T>

and

public QueryBuilder.Grouping<T> and(Criteria... criteria)

Description copied from interface: QueryBuilder.FilteringCriteria

Obtains the set of operations allowed after QueryBuilder.FilteringCriteria<T>

Specified by:

and in interface QueryBuilder.Filtering<T>

Specified by:

and in interface QueryBuilder.FilteringCriteria<T>

Parameters:

criteria - The Criteria that will be combined with the existing Criteria using the AND operator.

Returns:

the QueryBuilder.Grouping<T> interface with the set of operations allowed after QueryBuilder.Filtering<T>

or

public QueryBuilder.Grouping<T> or(Criteria... criteria)

Description copied from interface: QueryBuilder.FilteringCriteria

Obtains the set of operations allowed after QueryBuilder.FilteringCriteria<T>

Specified by:

or in interface QueryBuilder.Filtering<T>

Specified by:

or in interface QueryBuilder.FilteringCriteria<T>

Parameters:

criteria - The Criteria that will be combined with the existing Criteria using the OR operator.

Returns:

the QueryBuilder.Grouping<T> interface with the set of operations allowed after QueryBuilder.Filtering<T>

groupBy

public QueryBuilder.Aggregating<T> groupBy(String... c)

Description copied from interface: QueryBuilder.Grouping

Obtains the set of operations allowed after QueryBuilder.Grouping<T>

Specified by:

groupBy in interface QueryBuilder.Grouping<T>

Parameters:

c - the array of column names which the query is going to group by.

Returns:

the QueryBuilder.Aggregating<T> interface with the set of operations allowed after QueryBuilder.Grouping<T>

groupBy

public QueryBuilder.Aggregating<T> groupBy(ColumnAlias... alias)

Description copied from interface: QueryBuilder.Grouping

Obtains the set of operations allowed after QueryBuilder.Grouping<T>

Specified by:

groupBy in interface QueryBuilder.Grouping<T>

Parameters:

alias - the array of ColumnAlias which the query is going to group by.

Returns:

the QueryBuilder.Aggregating<T> interface with the set of operations allowed after QueryBuilder.Grouping<T>

groupBy

public QueryBuilder.Aggregating<T> groupBy(Column... c)

Description copied from interface: QueryBuilder.Grouping

Obtains the set of operations allowed after QueryBuilder.Grouping<T>

Specified by:

groupBy in interface QueryBuilder.Grouping<T>

Parameters:

c - the array of Column which the query is going to group by.

Returns:

the QueryBuilder.Aggregating<T> interface with the set of operations allowed after QueryBuilder.Grouping<T>

aggregate

public QueryBuilder.Grouping<T> aggregate(AggregationColumn... a)

Description copied from interface: QueryBuilder.Aggregating

Obtains the set of operations allowed after QueryBuilder.Aggregating<T>

Specified by:

aggregate in interface QueryBuilder.Aggregating<T>

Parameters:

a - the array of AggregationColumn where the query is going perform aggregation operations.

Returns:

the QueryBuilder.Grouping<T> interface with the set of operations allowed after QueryBuilder.Aggregating<T>

aggregate

public QueryBuilder.Grouping<T> aggregate(List<AggregationColumn> a)

Description copied from interface: QueryBuilder.Aggregating

Obtains the set of operations allowed after QueryBuilder.Aggregating<T>

Specified by:

aggregate in interface QueryBuilder.Aggregating<T>

Parameters:

a - the list of AggregationColumn where the query is going perform aggregation operations.

Returns:

the QueryBuilder.Grouping<T> interface with the set of operations allowed after QueryBuilder.Aggregating<T>

project

public QueryBuilder.Grouping<T> project(Aggregation a)

Description copied from interface: QueryBuilder.Aggregating

Obtains the set of operations allowed after QueryBuilder.Aggregating<T>

Specified by:

project in interface QueryBuilder.Aggregating<T>

Parameters:

a - the Aggregation to be performed by the query.

Returns:

the QueryBuilder.Grouping<T> interface with the set of operations allowed after QueryBuilder.Aggregating<T>

page

public QueryBuilder.Sorting<T> page(int startIndex,
 int batchSize)

Description copied from interface: QueryBuilder.Paging

Obtains the set of operations allowed after QueryBuilder.Paging<T>

Specified by:

page in interface QueryBuilder.Paging<T>

batchSize - the number of results to return in one page. If negative, the full result set should be returned.

Returns:

the QueryBuilder.Sorting<T> interface with the set of operations allowed after QueryBuilder.Paging<T>

page

public QueryBuilder<T> page(PagingInfo pagingInfo)

Description copied from interface: QueryBuilder.Paging

Defines query's PagingInfo

Specified by:

page in interface QueryBuilder.Paging<T>

Parameters:

pagingInfo - the PagingInfo describing how to page the results

Returns:

the QueryBuilder<T> which can produce a Query<T> instance.

sortBy

public QueryBuilder<T> sortBy(SortInfo... sortInfos)

Description copied from interface: QueryBuilder.Sorting

Defines the query's sorting information

Specified by:

sortBy in interface QueryBuilder.Sorting<T>

Parameters:

sortInfos - the array of SortInfo which the query is going to use to determine the order of the result data.

Returns:

the QueryBuilder<T> which can produce a Query<T> instance.

sortBy

public QueryBuilder<T> sortBy(List<SortInfo> sortInfos)

Description copied from interface: QueryBuilder.Sorting

Defines the query's sorting information

Specified by:

sortBy in interface QueryBuilder.Sorting<T>

Parameters:

sortInfos - the list of SortInfo which the query is going to use to determine the order of the result data.

Returns:

the QueryBuilder<T> which can produce a Query<T> instance.

sortBy

public QueryBuilder<T> sortBy(ReadOnlySortInfo... sortInfos)

Description copied from interface: QueryBuilder.Sorting

Defines the query's sorting information

Specified by:

sortBy in interface QueryBuilder.Sorting<T>

Parameters:

sortInfos - the array of ReadOnlySortInfo which the query is going to use to determine the order of the result data.

Returns:

the QueryBuilder<T> which can produce a Query<T> instance.

sortBy

public QueryBuilder<T> sortBy(com.google.common.collect.ImmutableList<ReadOnlySortInfo> sortInfos)

Description copied from interface: QueryBuilder.Sorting

Defines the query's sorting information

Specified by:

sortBy in interface QueryBuilder.Sorting<T>

Parameters:

sortInfos - the list of ReadOnlySortInfo which the query is going to use to determine the order of the result data.

Returns:

the QueryBuilder<T> which can produce a Query<T> instance.

build

public Query<T> build()

Description copied from interface: QueryBuilder

Produces a Query<T> instance at any point in time its called.

Specified by:

build in interface QueryBuilder<T>

Returns:

a Query<T> instance.

newLogicalOperation

protected abstract LogicalExpression<?> newLogicalOperation(LogicalOperator lo,
 List<Criteria> conditions)

Returns a LogicalExpression instance

Parameters:

lo - logical operation type represented by LogicalOperator

conditions -

Returns:

a LogicalExpression instance