Package io.jans.orm.model

Class SearchProjection

java.lang.Object

io.jans.orm.model.SearchProjection

All Implemented Interfaces:

Serializable

public class SearchProjection
extends Object
implements Serializable

Describes the SELECT-clause shape of a server-side GROUP BY or DISTINCT query. A projection is either grouping (groupBy(String...)) or distinct (distinct(String...)). Grouping projections may carry aggregates (COUNT/SUM/MIN/MAX/AVG); distinct projections may not. Result ordering is restricted to projection attributes and aggregate aliases.

Author:

Yuriy Movchan

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchProjection.Aggregate
static enum	SearchProjection.AggregateType
static class	SearchProjection.ProjectionSort

Method Summary

Modifier and Type	Method	Description
SearchProjection	avg(String attributeName)
SearchProjection	avg(String attributeName, String alias)
SearchProjection	count()
SearchProjection	count(String alias)
static SearchProjection	distinct(String... attributes)	Select distinct combinations of the specified attributes.
List<SearchProjection.Aggregate>	getAggregates()
String[]	getAttributes()
List<SearchProjection.ProjectionSort>	getOrderBy()
static SearchProjection	groupBy(String... attributes)	Group result rows by the specified attributes.
boolean	hasAggregates()
boolean	isDistinct()
SearchProjection	max(String attributeName)
SearchProjection	max(String attributeName, String alias)
SearchProjection	min(String attributeName)
SearchProjection	min(String attributeName, String alias)
SearchProjection	orderBy(String attributeOrAlias, SortOrder sortOrder)	Order result rows by a projection attribute or an aggregate alias.
SearchProjection	sum(String attributeName)
SearchProjection	sum(String attributeName, String alias)
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

groupBy

public static SearchProjection groupBy(String... attributes)

Group result rows by the specified attributes.

distinct

public static SearchProjection distinct(String... attributes)

Select distinct combinations of the specified attributes.

count

public SearchProjection count()

count

public SearchProjection count(String alias)

sum

public SearchProjection sum(String attributeName)

sum

public SearchProjection sum(String attributeName,
 String alias)

min

public SearchProjection min(String attributeName)

min

public SearchProjection min(String attributeName,
 String alias)

max

public SearchProjection max(String attributeName)

max

public SearchProjection max(String attributeName,
 String alias)

avg

public SearchProjection avg(String attributeName)

avg

public SearchProjection avg(String attributeName,
 String alias)

orderBy

public SearchProjection orderBy(String attributeOrAlias,
 SortOrder sortOrder)

Order result rows by a projection attribute or an aggregate alias.

isDistinct

public boolean isDistinct()

getAttributes

public String[] getAttributes()

getAggregates

public List<SearchProjection.Aggregate> getAggregates()

getOrderBy

public List<SearchProjection.ProjectionSort> getOrderBy()

hasAggregates

public boolean hasAggregates()

toString

public String toString()

Overrides:

toString in class Object