com.sap.cds.ql.cqn

Interface CqnEntitySelector

All Known Subinterfaces:

CqnExpand, CqnSelect, Expand<T>

All Known Implementing Classes:

Select

public interface CqnEntitySelector

The entity selector describes a basic selection from an entity set.

Method Summary

Modifier and Type	Method and Description
default void	dispatch(CqnVisitor visitor) Dispatches a given visitor to all clause except the ref or source of this entity selector
default boolean	hasLimit() Returns whether this entity selector has a top or skip
List<CqnSelectListItem>	items() Returns the selected items
Optional<CqnLimit>	limit() Deprecated. - use top() and skip()
List<CqnSortSpecification>	orderBy() Returns the order of the selection result
CqnStructuredTypeRef	ref() Returns the reference to the entity set of this selector.
long	skip() Returns the number of rows to be skipped
long	top() Returns the maximum number of rows to be returned

Method Detail

ref

CqnStructuredTypeRef ref()

Returns the reference to the entity set of this selector.

Returns:

the reference

Throws:

CdsException - if this selector does not have a reference

items

List<CqnSelectListItem> items()

Returns the selected items

Returns:

the select list items

orderBy

List<CqnSortSpecification> orderBy()

Returns the order of the selection result

Returns:

the result order

limit

@Deprecated
Optional<CqnLimit> limit()

Deprecated. - use top() and skip()

Returns the limit and offset of this selector

Returns:

the limit and offset

dispatch

default void dispatch(CqnVisitor visitor)

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

Parameters:

visitor - the visitor

top

long top()

Returns the maximum number of rows to be returned

Returns:

the maximum number of rows to be returned or -1 if unlimited

skip

long skip()

Returns the number of rows to be skipped

Returns:

the number of rows to be skipped

hasLimit

default boolean hasLimit()

Returns whether this entity selector has a top or skip

Returns:

true if there is a top or skip