Package com.sap.cds.ql
Interface Expand<T extends StructuredType<?>>
- All Superinterfaces:
CqnEntitySelector
,CqnExpand
,CqnSelectList
,CqnSelectListItem
,CqnToken
,JSONizable
,Selectable
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
accept
(CqnVisitor visitor) Dispatches the handling of thisCqnExpand expand specification
to a given visitor.Sets the alias of the expand.Specifies that the total number of entities matching the expand ref shall be returned along with the expand result.inlineCount
(boolean inlineCount) Sets the inline count flag of this expand.items
(Iterable<? extends Selectable> items) limit
(long top) Sets the limit of the expand.limit
(long top, long skip) Sets the limit and offset of the expand.orderBy
(CqnSortSpecification... sortSpec) orderBy
(Function<T, CqnSortSpecification> sort) orderBy
(Function<T, CqnSortSpecification>... sortSpec) orderBy
(Function<T, CqnSortSpecification> sort1, Function<T, CqnSortSpecification> sort2) orderBy
(Function<T, CqnSortSpecification> sort1, Function<T, CqnSortSpecification> sort2, Function<T, CqnSortSpecification> sort3) orderBy
(Function<T, CqnSortSpecification> sort1, Function<T, CqnSortSpecification> sort2, Function<T, CqnSortSpecification> sort3, Function<T, CqnSortSpecification> sort4) orderBy
(Function<T, CqnSortSpecification> sort1, Function<T, CqnSortSpecification> sort2, Function<T, CqnSortSpecification> sort3, Function<T, CqnSortSpecification> sort4, Function<T, CqnSortSpecification> sort5) orderBy
(List<CqnSortSpecification> sortSpec) 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.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 interfaceCqnEntitySelector
- Specified by:
ref
in interfaceCqnSelectList
- Returns:
- the reference
-
limit
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
Sets the limit and offset of the expand.- Parameters:
top
- the maximum number of entries returned by the expand or -1 if unlimitedskip
- the number of entries that shall be skipped- Returns:
- this expand
-
items
-
orderBy
-
orderBy
-
orderBy
-
orderBy
-
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
-
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
Sets the inline count flag of this expand.- Parameters:
inlineCount
- true to enable inline count, false to disable- Returns:
- this expand
- See Also:
-
orderBy
-
as
Sets the alias of the expand.- Parameters:
alias
- the alias, or null- Returns:
- this expand
-
accept
Description copied from interface:CqnExpand
Dispatches the handling of thisCqnExpand expand specification
to a given visitor. Neither theref
nor theitems
or theorder by clause
of the expand specification are traversed.- Specified by:
accept
in interfaceCqnExpand
- Specified by:
accept
in interfaceCqnToken
- Parameters:
visitor
- theCqnVisitor
-