Package com.sap.cds.ql.cqn

Interface CqnSelect

All Superinterfaces:

CqnEntitySelector, CqnSource, CqnStatement, CqnToken, JSONizable

All Known Implementing Classes:

Select

public interface CqnSelect
extends CqnStatement, CqnEntitySelector, CqnToken, CqnSource

Method Summary

Modifier and Type	Method	Description
default void	accept(CqnVisitor visitor)	Traverses the clauses of this CqnSelect with a given visitor.
default CqnSelect	asSelect()	Casts this CQN statement to CqnSelect.
default List<CqnSelectListItem>	columns()	Deprecated. instead use CqnEntitySelector.items()
default void	dispatch(CqnVisitor visitor)	Dispatches a given visitor to all clause except the ref or source of this entity selector
List<String>	excluding()
CqnSource	from()	The from clause of this select statement.
Optional<CqnLock>	getLock()
List<CqnValue>	groupBy()
boolean	hasInlineCount()
Optional<CqnPredicate>	having()
boolean	isDistinct()
default boolean	isSelect()	Returns true if this is a CqnSelect statement.
Optional<CqnPredicate>	search()
Optional<CqnPredicate>	where()

Methods inherited from interface com.sap.cds.ql.cqn.CqnEntitySelector

hasLimit, items, limit, orderBy, ref, skip, top

Methods inherited from interface com.sap.cds.ql.cqn.CqnSource

asJoin, asQuery, asRef, isJoin, isQuery, isRef

Methods inherited from interface com.sap.cds.ql.cqn.CqnStatement

asDelete, asInsert, asUpdate, asUpsert, hints, isDelete, isInsert, isUpdate, isUpsert, ref

Methods inherited from interface com.sap.cds.ql.cqn.CqnToken

tokens

Methods inherited from interface com.sap.cds.JSONizable

toJson

Method Detail

from

CqnSource from()

The from clause of this select statement.

Returns:

a reference to this statement's CqnSource

isDistinct

boolean isDistinct()

Returns:

whether statement is a SELECT DISTINCT

hasInlineCount

boolean hasInlineCount()

Returns:

whether the statement returns an inline count

columns

@Deprecated
default List<CqnSelectListItem> columns()

Deprecated.

instead use CqnEntitySelector.items()

Returns:

the select list items

groupBy

List<CqnValue> groupBy()

excluding

List<String> excluding()

where

Optional<CqnPredicate> where()

having

Optional<CqnPredicate> having()

getLock

Optional<CqnLock> getLock()

search

Optional<CqnPredicate> search()

isSelect

default boolean isSelect()

Description copied from interface: CqnStatement

Returns true if this is a CqnSelect statement.

Specified by:

isSelect in interface CqnSource

Specified by:

isSelect in interface CqnStatement

Returns:

true if this is a select statement, otherwise false

asSelect

default CqnSelect asSelect()

Description copied from interface: CqnStatement

Casts this CQN statement to CqnSelect.

Specified by:

asSelect in interface CqnSource

Specified by:

asSelect in interface CqnStatement

Returns:

this statement as a CqnSelect

accept

default void accept(CqnVisitor visitor)

Traverses the clauses of this CqnSelect with a given visitor. If the source of this select is a structured type reference it is visited first. The other clauses are traversed depth-first in the following order:

• items
• where
• search
• group by
• having
• order by

Afterwards this CqnSelect is passed to the CqnVisitor.visit(CqnSelect) method.

Specified by:

accept in interface CqnToken

Parameters:

visitor - the CqnVisitor

dispatch

default void dispatch(CqnVisitor visitor)

Description copied from interface: CqnEntitySelector

Dispatches a given visitor to all clause except the ref or source of this entity selector

Specified by:

dispatch in interface CqnEntitySelector

Parameters:

visitor - the visitor