Query.Builder (Appian API)

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 java.lang.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 and Description
`protected`	`Builder()` Initializes a newly created `Builder`
`protected`	`Builder(Query query)` Constructs a `Builder` using the given `Query` as a base

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`QueryBuilder.Grouping<T>`	`aggregate(AggregationColumn... a)` Obtains the set of operations allowed after `Aggregating`
`QueryBuilder.Grouping<T>`	`aggregate(java.util.List<AggregationColumn> a)` Obtains the set of operations allowed after `Aggregating`
`QueryBuilder.Grouping<T>`	`and(Criteria... criteria)` Obtains the set of operations allowed after `FilteringCriteria`
`Query<T>`	`build()` Produces a `Query` instance at any point in time its called.
`QueryBuilder.Grouping<T>`	`criteria(Criteria criteria)` Obtains the set of operations allowed after `FilteringCriteria`
`QueryBuilder.Aggregating<T>`	`groupBy(Column... c)` Obtains the set of operations allowed after `Grouping`
`QueryBuilder.Aggregating<T>`	`groupBy(ColumnAlias... alias)` Obtains the set of operations allowed after `Grouping`
`QueryBuilder.Aggregating<T>`	`groupBy(java.lang.String... c)` Obtains the set of operations allowed after `Grouping`
`protected abstract LogicalExpression<?>`	`newLogicalOperation(LogicalOperator lo, java.util.List<Criteria> conditions)` Returns a `LogicalExpression` instance
`protected Query<T>`	`newQuerySimplified(Projection<? extends Column> projection, Criteria criteria, PagingInfo pagingInfo)`
`QueryBuilder.Grouping<T>`	`or(Criteria... criteria)` Obtains the set of operations allowed after `FilteringCriteria`
`QueryBuilder.Sorting<T>`	`page(int startIndex, int batchSize)` Obtains the set of operations allowed after `Paging`
`QueryBuilder<T>`	`page(PagingInfo pagingInfo)` Defines query's `PagingInfo`
`QueryBuilder.Grouping<T>`	`project(Aggregation a)` Obtains the set of operations allowed after `Aggregating`
`QueryBuilder.Filtering<T>`	`project(Selection s)` Obtains the set of operations allowed after `Selecting`
`QueryBuilder.Filtering<T>`	`select(java.util.Collection<java.lang.String> c)` Obtains the set of operations allowed after `Selecting`
`QueryBuilder.Filtering<T>`	`select(Column... c)` Obtains the set of operations allowed after `Selecting`
`QueryBuilder.Filtering<T>`	`select(ColumnAlias... alias)` Obtains the set of operations allowed after `Selecting`
`QueryBuilder.Filtering<T>`	`select(java.util.List<Column> c)` Obtains the set of operations allowed after `Selecting`
`QueryBuilder.Filtering<T>`	`select(java.lang.String... c)` Obtains the set of operations allowed after `Selecting`
`QueryBuilder.Filtering<T>`	`selectFirst(java.lang.String column)`
`QueryBuilder<T>`	`sortBy(com.google.common.collect.ImmutableList<ReadOnlySortInfo> sortInfos)` Defines the query's sorting information
`QueryBuilder<T>`	`sortBy(java.util.List<SortInfo> sortInfos)` Defines the query's sorting information
`QueryBuilder<T>`	`sortBy(ReadOnlySortInfo... sortInfos)` Defines the query's sorting information
`QueryBuilder<T>`	`sortBy(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 Detail
  - 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 Detail
  - newQuerySimplified
```
protected final Query<T> newQuerySimplified(Projection<? extends Column> projection,
                                            Criteria criteria,
                                            PagingInfo pagingInfo)
```
  - select
```
public QueryBuilder.Filtering<T> select(java.lang.String... c)
```
    Description copied from interface: QueryBuilder.Selecting
    
    Obtains the set of operations allowed after Selecting
    
    Specified by:
    
    select in interface QueryBuilder.Selecting<T>
    
    Parameters:
    
    c - the array of column names which the query is going to select
    
    Returns:
    
    the Filtering interface with the set of operations allowed after Selecting
  - select
```
public QueryBuilder.Filtering<T> select(java.util.Collection<java.lang.String> c)
```
    Description copied from interface: QueryBuilder.Selecting
    
    Obtains the set of operations allowed after Selecting
    
    Specified by:
    
    select in interface QueryBuilder.Selecting<T>
    
    Parameters:
    
    c - the list of column names which the query is going to select
    
    Returns:
    
    the Filtering interface with the set of operations allowed after Selecting
  - selectFirst
```
public QueryBuilder.Filtering<T> selectFirst(java.lang.String column)
```
  - select
```
public QueryBuilder.Filtering<T> select(ColumnAlias... alias)
```
    Description copied from interface: QueryBuilder.Selecting
    
    Obtains the set of operations allowed after Selecting
    
    Specified by:
    
    select in interface QueryBuilder.Selecting<T>
    
    Parameters:
    
    alias - the array of ColumnAlias which the query is going to select
    
    Returns:
    
    the Filtering interface with the set of operations allowed after Selecting
  - select
```
public QueryBuilder.Filtering<T> select(Column... c)
```
    Description copied from interface: QueryBuilder.Selecting
    
    Obtains the set of operations allowed after Selecting
    
    Specified by:
    
    select in interface QueryBuilder.Selecting<T>
    
    Parameters:
    
    c - the array of Column which the query is going to select
    
    Returns:
    
    the Filtering interface with the set of operations allowed after Selecting
  - select
```
public QueryBuilder.Filtering<T> select(java.util.List<Column> c)
```
    Description copied from interface: QueryBuilder.Selecting
    
    Obtains the set of operations allowed after Selecting
    
    Specified by:
    
    select in interface QueryBuilder.Selecting<T>
    
    Parameters:
    
    c - the list of ColumnAlias which the query is going to select
    
    Returns:
    
    the Filtering interface with the set of operations allowed after Selecting
  - project
```
public QueryBuilder.Filtering<T> project(Selection s)
```
    Description copied from interface: QueryBuilder.Selecting
    
    Obtains the set of operations allowed after Selecting
    
    Specified by:
    
    project in interface QueryBuilder.Selecting<T>
    
    Parameters:
    
    s - the Selection to be performed by the query
    
    Returns:
    
    the Filtering interface with the set of operations allowed after Selecting
  - criteria
```
public QueryBuilder.Grouping<T> criteria(Criteria criteria)
```
    Description copied from interface: QueryBuilder.FilteringCriteria
    
    Obtains the set of operations allowed after FilteringCriteria
    
    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 Grouping interface with the set of operations allowed after FilteringCriteria
  - and
```
public QueryBuilder.Grouping<T> and(Criteria... criteria)
```
    Description copied from interface: QueryBuilder.FilteringCriteria
    
    Obtains the set of operations allowed after FilteringCriteria
    
    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 Grouping interface with the set of operations allowed after Filtering
  - or
```
public QueryBuilder.Grouping<T> or(Criteria... criteria)
```
    Description copied from interface: QueryBuilder.FilteringCriteria
    
    Obtains the set of operations allowed after FilteringCriteria
    
    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 Grouping interface with the set of operations allowed after Filtering
  - groupBy
```
public QueryBuilder.Aggregating<T> groupBy(java.lang.String... c)
```
    Description copied from interface: QueryBuilder.Grouping
    
    Obtains the set of operations allowed after Grouping
    
    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 Aggregating interface with the set of operations allowed after Grouping
  - groupBy
```
public QueryBuilder.Aggregating<T> groupBy(ColumnAlias... alias)
```
    Description copied from interface: QueryBuilder.Grouping
    
    Obtains the set of operations allowed after Grouping
    
    Specified by:
    
    groupBy in interface QueryBuilder.Grouping<T>
    
    Parameters:
    
    alias - the array of ColumnAlias which the query is going to group by.
    
    Returns:
    
    the Aggregating interface with the set of operations allowed after Grouping
  - groupBy
```
public QueryBuilder.Aggregating<T> groupBy(Column... c)
```
    Description copied from interface: QueryBuilder.Grouping
    
    Obtains the set of operations allowed after Grouping
    
    Specified by:
    
    groupBy in interface QueryBuilder.Grouping<T>
    
    Parameters:
    
    c - the array of Column which the query is going to group by.
    
    Returns:
    
    the Aggregating interface with the set of operations allowed after Grouping
  - aggregate
```
public QueryBuilder.Grouping<T> aggregate(AggregationColumn... a)
```
    Description copied from interface: QueryBuilder.Aggregating
    
    Obtains the set of operations allowed after Aggregating
    
    Specified by:
    
    aggregate in interface QueryBuilder.Aggregating<T>
    
    Parameters:
    
    a - the array of AggregationColumn where the query is going perform aggregation operations.
    
    Returns:
    
    the Grouping interface with the set of operations allowed after Aggregating
  - aggregate
```
public QueryBuilder.Grouping<T> aggregate(java.util.List<AggregationColumn> a)
```
    Description copied from interface: QueryBuilder.Aggregating
    
    Obtains the set of operations allowed after Aggregating
    
    Specified by:
    
    aggregate in interface QueryBuilder.Aggregating<T>
    
    Parameters:
    
    a - the list of AggregationColumn where the query is going perform aggregation operations.
    
    Returns:
    
    the Grouping interface with the set of operations allowed after Aggregating
  - project
```
public QueryBuilder.Grouping<T> project(Aggregation a)
```
    Description copied from interface: QueryBuilder.Aggregating
    
    Obtains the set of operations allowed after Aggregating
    
    Specified by:
    
    project in interface QueryBuilder.Aggregating<T>
    
    Parameters:
    
    a - the Aggregation to be performed by the query.
    
    Returns:
    
    the Grouping interface with the set of operations allowed after Aggregating
  - page
```
public QueryBuilder.Sorting<T> page(int startIndex,
                                    int batchSize)
```
    Description copied from interface: QueryBuilder.Paging
    
    Obtains the set of operations allowed after Paging
    
    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 Sorting interface with the set of operations allowed after Paging
  - 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 which can produce a Query 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 which can produce a Query instance.
  - sortBy
```
public QueryBuilder<T> sortBy(java.util.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 which can produce a Query 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 which can produce a Query 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 which can produce a Query instance.
  - build
```
public Query<T> build()
```
    Description copied from interface: QueryBuilder
    
    Produces a Query instance at any point in time its called.
    
    Specified by:
    
    build in interface QueryBuilder<T>
    
    Returns:
    
    a Query instance.
  - newLogicalOperation
```
protected abstract LogicalExpression<?> newLogicalOperation(LogicalOperator lo,
                                                            java.util.List<Criteria> conditions)
```
    Returns a LogicalExpression instance
    
    Parameters:
    
    lo - logical operation type represented by LogicalOperator
    
    conditions -
    
    Returns:
    
    a LogicalExpression instance

Class Query.Builder<T>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Builder

Method Detail

newQuerySimplified

select

select

selectFirst

select

select

select

project

criteria

and

or

groupBy

groupBy

groupBy

aggregate

aggregate

project

page

page

sortBy

sortBy

sortBy

sortBy

build

newLogicalOperation