Package com.sap.cds.ql

Interface Expand<T extends StructuredType<?>>

All Superinterfaces:

CqnEntitySelector, CqnExpand, CqnSelectList, CqnSelectListItem, CqnToken, JSONizable, Selectable

public interface Expand<T extends StructuredType<?>>
extends CqnExpand

Method Summary

Modifier and Type	Method	Description
default void	accept(CqnVisitor visitor)	Dispatches the handling of this CqnExpand expand specification to a given visitor.
Expand<T>	as(String alias)	Sets the alias of the expand.
Expand<T>	inlineCount()	Specifies that the total number of entities matching the expand ref shall be returned along with the expand result.
Expand<T>	inlineCount(boolean inlineCount)	Sets the inline count flag of this expand.
Expand<T>	items(Iterable<? extends Selectable> items)
default Expand<T>	limit(long top)	Sets the limit of the expand.
Expand<T>	limit(long top, long skip)	Sets the limit and offset of the expand.
default Expand<T>	orderBy(CqnSortSpecification... sortSpec)
Expand<T>	orderBy(String... refs)
Expand<T>	orderBy(Function<T,CqnSortSpecification> sort)
Expand<T>	orderBy(Function<T,CqnSortSpecification>... sortSpec)
Expand<T>	orderBy(Function<T,CqnSortSpecification> sort1, Function<T,CqnSortSpecification> sort2)
Expand<T>	orderBy(Function<T,CqnSortSpecification> sort1, Function<T,CqnSortSpecification> sort2, Function<T,CqnSortSpecification> sort3)
Expand<T>	orderBy(Function<T,CqnSortSpecification> sort1, Function<T,CqnSortSpecification> sort2, Function<T,CqnSortSpecification> sort3, Function<T,CqnSortSpecification> sort4)
Expand<T>	orderBy(Function<T,CqnSortSpecification> sort1, Function<T,CqnSortSpecification> sort2, Function<T,CqnSortSpecification> sort3, Function<T,CqnSortSpecification> sort4, Function<T,CqnSortSpecification> sort5)
Expand<T>	orderBy(List<CqnSortSpecification> sortSpec)
StructuredTypeRef	ref()	Returns the reference to the entity set of this selector.

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

dispatch, hasInlineCount, hasLimit, items, orderBy, skip, top

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

alias, asExpand, displayName, isExpand

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

asInline, asSelectList, isInline, isSelectList, items

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

asRef, asValue, isRef, isStar, isValue, ofRef, ofValue, token, unfold

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

tokens

Methods inherited from interface com.sap.cds.JSONizable

toJson

Method Details

ref

StructuredTypeRef ref()

Description copied from interface: CqnEntitySelector

Returns the reference to the entity set of this selector.

Specified by:

ref in interface CqnEntitySelector

Specified by:

ref in interface CqnSelectList

Returns:

the reference

limit

default Expand<T> limit(long top)

Sets the limit of the expand.

Parameters:

top - the maximum number of entries returned by the expand or -1 if unlimited

Returns:

this expand

limit

Expand<T> limit(long top,
 long skip)

Sets the limit and offset of the expand.

Parameters:

top - the maximum number of entries returned by the expand or -1 if unlimited

skip - the number of entries that shall be skipped

Returns:

this expand

items

Expand<T> items(Iterable<? extends Selectable> items)

orderBy

Expand<T> orderBy(String... refs)

orderBy

Expand<T> orderBy(List<CqnSortSpecification> sortSpec)

orderBy

Expand<T> orderBy(Function<T,CqnSortSpecification> sort)

orderBy

Expand<T> orderBy(Function<T,CqnSortSpecification> sort1,
 Function<T,CqnSortSpecification> sort2)

orderBy

Expand<T> orderBy(Function<T,CqnSortSpecification> sort1,
 Function<T,CqnSortSpecification> sort2,
 Function<T,CqnSortSpecification> sort3)

orderBy

Expand<T> orderBy(Function<T,CqnSortSpecification> sort1,
 Function<T,CqnSortSpecification> sort2,
 Function<T,CqnSortSpecification> sort3,
 Function<T,CqnSortSpecification> sort4)

orderBy

Expand<T> orderBy(Function<T,CqnSortSpecification> sort1,
 Function<T,CqnSortSpecification> sort2,
 Function<T,CqnSortSpecification> sort3,
 Function<T,CqnSortSpecification> sort4,
 Function<T,CqnSortSpecification> sort5)

orderBy

Expand<T> orderBy(Function<T,CqnSortSpecification>... sortSpec)

inlineCount

@Beta
Expand<T> inlineCount()

Specifies that the total number of entities matching the expand ref shall be returned along with the expand result. Upon the calculation of the inline count the limit clause of the expand is ignored. Inline count is not supported in combination with distinct and groupBy. The inline count is currently added to the result under the alias of the expand suffixed with "@count". This may be subject to change in future releases.

Returns:

this expand

inlineCount

@Beta
Expand<T> inlineCount(boolean inlineCount)

Sets the inline count flag of this expand.

Parameters:

inlineCount - true to enable inline count, false to disable

Returns:

this expand

See Also:

• inlineCount()

orderBy

default Expand<T> orderBy(CqnSortSpecification... sortSpec)

as

Expand<T> as(String alias)

Sets the alias of the expand.

Parameters:

alias - the alias, or null

Returns:

this expand

accept

default void accept(CqnVisitor visitor)

Description copied from interface: CqnExpand

Dispatches the handling of this CqnExpand expand specification to a given visitor. Neither the ref nor the items or the order by clause of the expand specification are traversed.

Specified by:

accept in interface CqnExpand

Specified by:

accept in interface CqnToken

Parameters:

visitor - the CqnVisitor