Package com.appiancorp.common.query

Class AggregationColumn

java.lang.Object

com.appiancorp.common.query.ColumnAlias

com.appiancorp.common.query.Column

com.appiancorp.common.query.AggregationColumn

@GwtCompatible
public class AggregationColumn
extends Column

Immutable bean representing the column dot notation, alias, visibility (if it's should be shown to the client or not). Along with this it indicates if this function should be grouped by or which aggregation function is applied to this column instead.

This column can either be grouped or aggregated but not both, since they are mutually exclusive.

An instance can only be obtain by using the helper class QueryBuilder.Selecting or in a more object oriented way by using the helper class QueryBuilder.Aggregating

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOCAL_PART
static final QName	QNAME

Constructor Summary

Constructors

Modifier	Constructor	Description
	AggregationColumn(AggregationColumn ac)	Copy constructor
protected	AggregationColumn(String field, String alias, boolean visible)	Constructs a new AggregationColumn which groups by the given field name with the given alias name.
protected	AggregationColumn(String field, String alias, boolean visible, boolean isGrouping, AggregationFunction aggregationFunction, com.appiancorp.common.query.GroupingFunction groupingFunction)
protected	AggregationColumn(String field, String alias, boolean visible, AggregationFunction function)	Constructs a new AggregationColumn which groups by the given field name with the given alias name.
protected	AggregationColumn(String field, String alias, boolean visible, AggregationFunction aggregationFunction, com.appiancorp.common.query.GroupingFunction groupingFunction)	Constructs a new AggregationColumn which groups by the given field name with the given alias name.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEquals(Object obj)	Checks if this instance can compare against the given object.
boolean	equals(Object obj)
AggregationFunction	getFunction()
com.appiancorp.common.query.GroupingFunction	getGroupingFunction()
int	hashCode()
boolean	isGrouping()
String	toString()

Methods inherited from class com.appiancorp.common.query.Column

appendForToString, getAliasToFieldPathMap, isVisible

Methods inherited from class com.appiancorp.common.query.ColumnAlias

appendForToString, getAlias, getField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LOCAL_PART

public static final String LOCAL_PART

See Also:

• Constant Field Values

QNAME

public static final QName QNAME

Constructor Details

AggregationColumn

protected AggregationColumn(String field,
 String alias,
 boolean visible)

Constructs a new AggregationColumn which groups by the given field name with the given alias name.

Parameters:

field - a field name

alias - an alias name

visible - determines if this column will be visible or not.

AggregationColumn

protected AggregationColumn(String field,
 String alias,
 boolean visible,
 AggregationFunction function)

Constructs a new AggregationColumn which groups by the given field name with the given alias name.

Parameters:

field - a field name

alias - an alias name

visible - determines if this column will be visible or not.

function - the AggregationFunction which will be apply for this column

AggregationColumn

protected AggregationColumn(String field,
 String alias,
 boolean visible,
 AggregationFunction aggregationFunction,
 com.appiancorp.common.query.GroupingFunction groupingFunction)

Constructs a new AggregationColumn which groups by the given field name with the given alias name.

Parameters:

field - a field name

alias - an alias name

visible - determines if this column will be visible or not.

aggregationFunction - the AggregationFunction which will be applied for this column

groupingFunction - the GroupingFunction which will be applied for this column

AggregationColumn

protected AggregationColumn(String field,
 String alias,
 boolean visible,
 boolean isGrouping,
 AggregationFunction aggregationFunction,
 com.appiancorp.common.query.GroupingFunction groupingFunction)

AggregationColumn

public AggregationColumn(AggregationColumn ac)

Copy constructor

Parameters:

ac - an AggregationColumn

Method Details

isGrouping

public boolean isGrouping()

getFunction

public AggregationFunction getFunction()

getGroupingFunction

public com.appiancorp.common.query.GroupingFunction getGroupingFunction()

hashCode

public int hashCode()

Overrides:

hashCode in class Column

equals

public boolean equals(Object obj)

Overrides:

equals in class Column

canEquals

protected boolean canEquals(Object obj)

Description copied from class: ColumnAlias

Checks if this instance can compare against the given object.

Overrides:

canEquals in class Column

Parameters:

obj - an Object

Returns:

true if the given object is an instanceof this class.

toString

public String toString()

Overrides:

toString in class Column