com.appiancorp.common.query

Class QueryBuilderTools.Aggregator

java.lang.Object

com.appiancorp.common.query.QueryBuilderTools.Aggregator

Direct Known Subclasses:

GenericQuery.GenericBuilder.Aggregator, TypedValueQuery.TypedValueBuilder.Aggregator

Enclosing interface:

QueryBuilderTools

public static class QueryBuilderTools.Aggregator
extends java.lang.Object

This class encapsulates all the available Aggregation Functions in a more object oriented way.

Constructor Summary

Constructors

Constructor and Description
Aggregator()

Method Summary

Modifier and Type	Method and Description
static AggregationColumn	aggregation(java.lang.String field, AggregationFunction function) Creates an AggregationColumn instance
static AggregationColumn	aggregation(java.lang.String field, java.lang.String alias, boolean visible, AggregationFunction function) Creates an AggregationColumn instance.
static AggregationColumn	avg(Column c) Apply a "average" aggregation function to the given Column
static AggregationColumn	avg(ColumnAlias alias) Apply a "average" aggregation function to the given ColumnAlias
static AggregationColumn	avg(ColumnAlias alias, boolean visibility) Apply a "average" aggregation function to the given ColumnAlias.
static AggregationColumn	avg(java.lang.String c, java.lang.String alias) Apply a "average" aggregation function to the given field name.
static AggregationColumn	avg(java.lang.String c, java.lang.String alias, boolean visibility) Apply a "average" aggregation function to the given field name.
static AggregationColumn	count(Column c) Apply a "count" aggregation function to the given Column
static AggregationColumn	count(ColumnAlias alias) Apply a "count" aggregation function to the given ColumnAlias
static AggregationColumn	count(ColumnAlias alias, boolean visibility) Apply a "count" aggregation function to the given ColumnAlias.
static AggregationColumn	count(java.lang.String c, java.lang.String alias) Apply a "count" aggregation function to the given field name.
static AggregationColumn	count(java.lang.String c, java.lang.String alias, boolean visibility) Apply a "count" aggregation function to the given field name.
static AggregationColumn	group(Column c) Creates a grouping projection for the given Column
static AggregationColumn	group(ColumnAlias ca) Creates a grouping projection for the given ColumnAlias This projection can be referred to by the given alias.
static AggregationColumn	group(java.lang.String field) Creates a grouping projection for the given field name
static AggregationColumn	group(java.lang.String field, boolean visible) Creates a visible or hidden grouping projection for the given field name
static AggregationColumn	group(java.lang.String field, java.lang.String alias) Creates a grouping projection for the given field name.
static AggregationColumn	group(java.lang.String field, java.lang.String alias, boolean visible) Creates a visible or hidden grouping projection for the given field name.
static AggregationColumn	group(java.lang.String field, java.lang.String alias, com.appiancorp.common.query.GroupingFunction groupingFunction, boolean visible)
static AggregationColumn	max(Column c) Apply a "maximum" aggregation function to the given Column
static AggregationColumn	max(ColumnAlias alias) Apply a "maximum" aggregation function to the given ColumnAlias
static AggregationColumn	max(ColumnAlias alias, boolean visibility) Apply a "maximum" aggregation function to the given ColumnAlias.
static AggregationColumn	max(java.lang.String c, java.lang.String alias) Apply a "maximum" aggregation function to the given field name.
static AggregationColumn	max(java.lang.String c, java.lang.String alias, boolean visibility) Apply a "maximum" aggregation function to the given field name.
static AggregationColumn	min(Column c) Apply a "minimum" aggregation function to the given Column
static AggregationColumn	min(ColumnAlias alias) Apply a "minimum" aggregation function to the given ColumnAlias
static AggregationColumn	min(ColumnAlias alias, boolean visibility) Apply a "minimum" aggregation function to the given ColumnAlias.
static AggregationColumn	min(java.lang.String c, java.lang.String alias) Apply a "minimum" aggregation function to the given field name.
static AggregationColumn	min(java.lang.String c, java.lang.String alias, boolean visibility) Apply a "minimum" aggregation function to the given field name.
static AggregationColumn	sum(Column c) Apply a "summation" aggregation function to the given Column
static AggregationColumn	sum(ColumnAlias alias) Apply a "summation" aggregation function to the given ColumnAlias
static AggregationColumn	sum(ColumnAlias alias, boolean visibility) Apply a "summation" aggregation function to the given ColumnAlias.
static AggregationColumn	sum(java.lang.String c, java.lang.String alias) Apply a "summation" aggregation function to the given field name.
static AggregationColumn	sum(java.lang.String c, java.lang.String alias, boolean visibility) Apply a "summation" aggregation function to the given field name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Aggregator

public Aggregator()

Method Detail

group

public static AggregationColumn group(java.lang.String field)

Creates a grouping projection for the given field name

Parameters:

field - a field name

Returns:

an AggregationColumn representing a grouping projection

group

public static AggregationColumn group(java.lang.String field,
                                      java.lang.String alias)

Creates a grouping projection for the given field name. This projection can be referred to by the given alias.

Parameters:

field - a field name

alias - an alias name to assign to the projection

Returns:

an AggregationColumn representing a grouping projection

group

public static AggregationColumn group(java.lang.String field,
                                      boolean visible)

Creates a visible or hidden grouping projection for the given field name

Parameters:

field - a field name

visible - if true the projection will be visible; otherwise it will be hidden

Returns:

an AggregationColumn representing a grouping projection

group

public static AggregationColumn group(ColumnAlias ca)

Creates a grouping projection for the given ColumnAlias This projection can be referred to by the given alias.

Parameters:

ca - a ColumnAlias to assign to the projection

Returns:

an AggregationColumn representing a grouping projection

group

public static AggregationColumn group(java.lang.String field,
                                      java.lang.String alias,
                                      boolean visible)

Creates a visible or hidden grouping projection for the given field name. This projection can be referred to by the given alias.

Parameters:

field - a field name

alias - an alias name to assign to the projection

visible - if true the projection will be visible; otherwise it will be hidden

Returns:

an AggregationColumn representing a grouping projection

group

public static AggregationColumn group(Column c)

Creates a grouping projection for the given Column

Parameters:

c - a Column

Returns:

an AggregationColumn representing a grouping projection

group

public static AggregationColumn group(java.lang.String field,
                                      java.lang.String alias,
                                      com.appiancorp.common.query.GroupingFunction groupingFunction,
                                      boolean visible)

aggregation

public static AggregationColumn aggregation(java.lang.String field,
                                            AggregationFunction function)

Creates an AggregationColumn instance

Parameters:

field - a field name

function - an aggregation function define by the AggregationFunction enum

Returns:

an AggregationColumn instance

aggregation

public static AggregationColumn aggregation(java.lang.String field,
                                            java.lang.String alias,
                                            boolean visible,
                                            AggregationFunction function)

Creates an AggregationColumn instance. This projection can be referred to by the given alias.

Parameters:

field - a field name

alias - an alias name to assign to the projection

visible - if true the projection will be visible; otherwise it will be hidden

function - an aggregation function define by the AggregationFunction enum

Returns:

an AggregationColumn instance

sum

public static AggregationColumn sum(ColumnAlias alias)

Apply a "summation" aggregation function to the given ColumnAlias

Parameters:

alias - a ColumnAlias to assign to the projection

Returns:

an AggregationColumn where "summation" is applied.

avg

public static AggregationColumn avg(ColumnAlias alias)

Apply a "average" aggregation function to the given ColumnAlias

Parameters:

alias - a ColumnAlias to assign to the projection

Returns:

an AggregationColumn where "average" is applied.

count

public static AggregationColumn count(ColumnAlias alias)

Apply a "count" aggregation function to the given ColumnAlias

Parameters:

alias - a ColumnAlias to assign to the projection

Returns:

an AggregationColumn where "count" is applied.

min

public static AggregationColumn min(ColumnAlias alias)

Apply a "minimum" aggregation function to the given ColumnAlias

Parameters:

alias - a ColumnAlias to assign to the projection

Returns:

an AggregationColumn where "minimum" is applied.

max

public static AggregationColumn max(ColumnAlias alias)

Apply a "maximum" aggregation function to the given ColumnAlias

Parameters:

alias - a ColumnAlias to assign to the projection

Returns:

an AggregationColumn where "maximum" is applied.

sum

public static AggregationColumn sum(java.lang.String c,
                                    java.lang.String alias)

Apply a "summation" aggregation function to the given field name. This projection can be referred to by the given alias.

Parameters:

c - field name

alias - an alias name to assign to the projection

Returns:

an AggregationColumn where "summation" is applied.

avg

public static AggregationColumn avg(java.lang.String c,
                                    java.lang.String alias)

Apply a "average" aggregation function to the given field name. This projection can be referred to by the given alias.

Parameters:

c - field name

alias - an alias name to assign to the projection

Returns:

an AggregationColumn where "average" is applied.

count

public static AggregationColumn count(java.lang.String c,
                                      java.lang.String alias)

Apply a "count" aggregation function to the given field name. This projection can be referred to by the given alias.

Parameters:

c - field name

alias - an alias name to assign to the projection

Returns:

an AggregationColumn where "count" is applied.

min

public static AggregationColumn min(java.lang.String c,
                                    java.lang.String alias)

Apply a "minimum" aggregation function to the given field name. This projection can be referred to by the given alias.

Parameters:

c - field name

alias - an alias name to assign to the projection

Returns:

an AggregationColumn where "minimum" is applied.

max

public static AggregationColumn max(java.lang.String c,
                                    java.lang.String alias)

Apply a "maximum" aggregation function to the given field name. This projection can be referred to by the given alias.

Parameters:

c - field name

alias - an alias name to assign to the projection

Returns:

an AggregationColumn where "maximum" is applied.

sum

public static AggregationColumn sum(java.lang.String c,
                                    java.lang.String alias,
                                    boolean visibility)

Apply a "summation" aggregation function to the given field name. This projection can be referred to by the given alias.

Parameters:

c - field name

alias - an alias name to assign to the projection

visibility - if true the projection will be visible; otherwise it will be hidden

Returns:

an AggregationColumn where "summation" is applied.

avg

public static AggregationColumn avg(java.lang.String c,
                                    java.lang.String alias,
                                    boolean visibility)

Apply a "average" aggregation function to the given field name. This projection can be referred to by the given alias.

Parameters:

c - field name

alias - an alias name to assign to the projection

visibility - if true the projection will be visible; otherwise it will be hidden

Returns:

an AggregationColumn where "average" is applied.

count

public static AggregationColumn count(java.lang.String c,
                                      java.lang.String alias,
                                      boolean visibility)

Apply a "count" aggregation function to the given field name. This projection can be referred to by the given alias.

Parameters:

c - field name

alias - an alias name to assign to the projection

visibility - if true the projection will be visible; otherwise it will be hidden

Returns:

an AggregationColumn where "count" is applied.

min

public static AggregationColumn min(java.lang.String c,
                                    java.lang.String alias,
                                    boolean visibility)

Apply a "minimum" aggregation function to the given field name. This projection can be referred to by the given alias.

Parameters:

c - field name

alias - an alias name to assign to the projection

visibility - if true the projection will be visible; otherwise it will be hidden

Returns:

an AggregationColumn where "minimum" is applied.

max

public static AggregationColumn max(java.lang.String c,
                                    java.lang.String alias,
                                    boolean visibility)

Apply a "maximum" aggregation function to the given field name. This projection can be referred to by the given alias.

Parameters:

c - field name

alias - an alias name to assign to the projection

visibility - if true the projection will be visible; otherwise it will be hidden

Returns:

an AggregationColumn where "maximum" is applied.

sum

public static AggregationColumn sum(ColumnAlias alias,
                                    boolean visibility)

Apply a "summation" aggregation function to the given ColumnAlias. This projection can be referred to by the given alias.

Parameters:

alias - a ColumnAlias to assign to the projection

visibility - if true the projection will be visible; otherwise it will be hidden

Returns:

an AggregationColumn where "summation" is applied.

avg

public static AggregationColumn avg(ColumnAlias alias,
                                    boolean visibility)

Apply a "average" aggregation function to the given ColumnAlias. This projection can be referred to by the given alias.

Parameters:

alias - a ColumnAlias to assign to the projection

visibility - if true the projection will be visible; otherwise it will be hidden

Returns:

an AggregationColumn where "average" is applied.

count

public static AggregationColumn count(ColumnAlias alias,
                                      boolean visibility)

Apply a "count" aggregation function to the given ColumnAlias. This projection can be referred to by the given alias.

Parameters:

alias - a ColumnAlias to assign to the projection

visibility - if true the projection will be visible; otherwise it will be hidden

Returns:

an AggregationColumn where "count" is applied.

min

public static AggregationColumn min(ColumnAlias alias,
                                    boolean visibility)

Apply a "minimum" aggregation function to the given ColumnAlias. This projection can be referred to by the given alias.

Parameters:

alias - a ColumnAlias to assign to the projection

visibility - if true the projection will be visible; otherwise it will be hidden

Returns:

an AggregationColumn where "minimum" is applied.

max

public static AggregationColumn max(ColumnAlias alias,
                                    boolean visibility)

Apply a "maximum" aggregation function to the given ColumnAlias. This projection can be referred to by the given alias.

Parameters:

alias - a ColumnAlias to assign to the projection

visibility - if true the projection will be visible; otherwise it will be hidden

Returns:

an AggregationColumn where "maximum" is applied.

sum

public static AggregationColumn sum(Column c)

Apply a "summation" aggregation function to the given Column

Parameters:

c - a Column

Returns:

an AggregationColumn where "summation" is applied.

avg

public static AggregationColumn avg(Column c)

Apply a "average" aggregation function to the given Column

Parameters:

c - a Column

Returns:

an AggregationColumn where "average" is applied.

count

public static AggregationColumn count(Column c)

Apply a "count" aggregation function to the given Column

Parameters:

c - a Column

Returns:

an AggregationColumn where "count" is applied.

min

public static AggregationColumn min(Column c)

Apply a "minimum" aggregation function to the given Column

Parameters:

c - a Column

Returns:

an AggregationColumn where "minimum" is applied.

max

public static AggregationColumn max(Column c)

Apply a "maximum" aggregation function to the given Column

Parameters:

c - a Column

Returns:

an AggregationColumn where "maximum" is applied.