com.appiancorp.common.query

Class Query<T>

java.lang.Object

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

Type Parameters:

T - Type of value

Direct Known Subclasses:

GenericQuery, TypedValueQuery

@GwtCompatible
public abstract class Query<T>
extends java.lang.Object

An object-oriented representation of a query. This supports operations for projection, grouping, aggregation and filtering/searching prior to aggregating data.

If no selection is specified, all columns will be returned.

A Query instance is obtained by using QueryBuilder. Query instances are immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Query.Builder<T> A class for incrementally build a Query.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOCAL_PART
static javax.xml.namespace.QName	QNAME
protected static java.lang.String	XML_ROOT_ELEMENT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Query()
protected	Query(Projection<? extends Column> projection, Criteria criteria, PagingInfo pagingInfo)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Column	getColumnIgnoreCase(java.lang.String alias) Returns the Column associated with the given alias ignoring case sensitivity.
abstract Criteria	getCriteria() Gets the Criteria
PagingInfo	getPagingInfo() Gets the PagingInfo
Projection	getProjection() Gets the Projection
int	hashCode()
boolean	hasSearch() Checks if the search criteria is being used
boolean	hasSort() Checks if sorting information has been provided
boolean	isGrouping() Checks if at least once column is being grouped by
boolean	isProjection()
static com.appian.core.base.ToStringFunction<Query<?>>	multilineToString(int indent) Returns a multiline string representation of the Query by indenting each element with given number of characters.
protected abstract void	setCriteria(Criteria criteria) Sets the Criteria
java.lang.String	toString()
java.lang.String	toStringMultiline() Returns a multiline string representation of the Query

Methods inherited from class java.lang.Object

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

Field Detail

XML_ROOT_ELEMENT

protected static final java.lang.String XML_ROOT_ELEMENT

See Also:

Constant Field Values

LOCAL_PART

public static final java.lang.String LOCAL_PART

See Also:

Constant Field Values

QNAME

public static final javax.xml.namespace.QName QNAME

Constructor Detail

Query

protected Query()

Query

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

Method Detail

getProjection

public Projection getProjection()

Gets the Projection

Returns:

the Projection

getPagingInfo

public PagingInfo getPagingInfo()

Gets the PagingInfo

Returns:

the PagingInfo

getCriteria

public abstract Criteria getCriteria()

Gets the Criteria

Returns:

the Criteria

setCriteria

protected abstract void setCriteria(Criteria criteria)

Sets the Criteria

Parameters:

criteria - the Criteria

hasSort

public boolean hasSort()

Checks if sorting information has been provided

Returns:

true if the Query has sorting information; false otherwise

isGrouping

public boolean isGrouping()

Checks if at least once column is being grouped by

Returns:

true if there is at least one column which is grouped by; false otherwise

hasSearch

public boolean hasSearch()

Checks if the search criteria is being used

Returns:

true if the search criteria is being used; false otherwise

getColumnIgnoreCase

public Column getColumnIgnoreCase(java.lang.String alias)

Returns the Column associated with the given alias ignoring case sensitivity.

Parameters:

alias -

Returns:

the Column associated with the given alias

isProjection

public boolean isProjection()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringMultiline

public java.lang.String toStringMultiline()

Returns a multiline string representation of the Query

Returns:

a multiline string representation of the Query

multilineToString

public static com.appian.core.base.ToStringFunction<Query<?>> multilineToString(int indent)

Returns a multiline string representation of the Query by indenting each element with given number of characters.

Parameters:

indent - number of characters to indent

Returns:

a ToStringFunction for Query

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object