Package com.sap.cds.ql.cqn

Interface Modifier

public interface Modifier

Provider interface for modifying CQN Predicates, Values and Statements copied with CQL.copy. Override the default methods to replace specific parts of the statement / predicate.

Method Summary

Modifier and Type	Method	Description
default CqnPredicate	between(CqnValue value, CqnValue low, CqnValue high)	Override this method to replace a between predicate that that tests if this value is within a closed interval with given bounds of low and high.
default CqnPredicate	booleanFunction(String name, List<Value<?>> args)	Override this method to replace a predicate function call.
default CqnValue	caseExpression(List<CqnCaseExpression.Case> cases, CqnValue defaultValue, String type)	Override this method to replace an case expression.
default CqnPredicate	comparison(Value<?> lhs, CqnComparisonPredicate.Operator op, Value<?> rhs)	Override this method to replace a comparison predicate.
default CqnPredicate	connective(CqnConnectivePredicate.Operator op, List<Predicate> predicates)	Override this method to replace a logical connection predicate, which connects multiple predicates with the given operator.
default CqnPredicate	containment(CqnContainmentTest.Position position, CqnValue value, CqnValue term, boolean caseInsensitive)	Override this method to replace a containment test predicate.
default boolean	distinct(boolean distinct)	Override this method to set the distinct flag of Select statements.
default CqnPredicate	eTag(CqnElementRef ref, CqnListValue values)	Override this method to replace a eTag predicate that checks if an ETag matches any value from the given values list.
default Set<String>	excluding(Set<String> excluding)	Override this method to modify the exclude list of Select statements.
default CqnPredicate	exists(Select<?> subQuery)	Override this method to replace an exist subquery.
default CqnSelectListItem	expand(CqnExpand expand)	Override this method to replace expand lists.
default CqnValue	expression(Value<Number> left, CqnArithmeticExpression.Operator op, Value<Number> right, String type)	Override this method to replace an arithmetic expression.
default CqnValue	function(String name, List<Value<?>> args, String type)	Override this method to replace a function call.
default List<CqnValue>	groupBy(List<CqnValue> values)	Override this method to modify the groupBy clause of Select statements.
default CqnPredicate	having(Predicate having)	Override this method to modify the having clause of Select statements.
default CqnPredicate	in(CqnInSubquery inSubquery)	Override this method to replace an in subquery predicate that checks if the given value is equal to any value returned by the subquery.
default CqnPredicate	in(Value<?> value, CqnValue valueSet)	Override this method to replace an in predicate that checks if the given value is equal to any value in the valueSet.
default CqnSelectListItem	inline(CqnInline inline)	Override this method to replace inline lists.
default boolean	inlineCount(boolean inlineCount)	Override this method to set the inline count flag of Select statements.
default List<CqnSelectListItem>	items(List<CqnSelectListItem> items)	Override this method to modify the select list items of Select statements.
default CqnValue	list(List<Value<?>> values)	Override this method to replace a list value with another CqnValue.
default CqnValue	literal(CqnLiteral<?> value)	Override this method to replace a literal value with another CqnValue.
default CqnPredicate	match(CqnMatchPredicate match)	Override this method to replace a match predicate.
default CqnPredicate	negation(Predicate predicate)	Override this method to replace a logical negation.
default List<CqnSortSpecification>	orderBy(List<CqnSortSpecification> sortSpecs)	Override this method to modify the orderBy clause of Select statements.
default CqnValue	parameter(CqnParameter param)	Override this method to replace parameters.
default CqnPredicate	passThroughSearch(CqnPassThroughSearchPredicate search)	Override this method to replace a search predicate.
default CqnValue	plain(CqnPlain plain)
default CqnValue	ref(CqnElementRef ref)	Override this method to replace an element ref with another CqnValue.
default CqnStructuredTypeRef	ref(CqnStructuredTypeRef ref)	Override this method to replace a structured type ref.
default CqnPredicate	search(Predicate search)	Override this method to set the search clause of Select statements.
default CqnPredicate	search(String term)	Deprecated, for removal: This API element is subject to removal in a future version. use searchTerm(CqnSearchTermPredicate) instead
default Set<String>	searchableElements(Set<String> searchableElements)	Override this method to set the searchable elements of Select statements.
default CqnPredicate	searchTerm(CqnSearchTermPredicate search)	Override this method to replace a search predicate.
default List<CqnSelectListItem>	selectAll()	Override this method to replace asterisk (*) on the select list of Select statements.
default CqnSelectListItem	selectListValue(SelectableValue value, String alias)	Override this method to replace values on the select list of Select statements.
default CqnSelectListItem	selectListValue(Value<?> value, String alias)	Deprecated, for removal: This API element is subject to removal in a future version. use selectListValue(SelectableValue, String) instead
default long	skip(long skip)	Override this method to set skip of Select statements.
default CqnSortSpecification	sort(Value<?> value, CqnSortSpecification.Order order)	Override this method to replace specific sort specs in the orderBy clause of Select statements.
default long	top(long top)	Override this method to set the top limit of Select statements.
default CqnPredicate	where(Predicate where)	Override this method to set the where clause of filterable statements.
default CqnValue	windowFunction(CqnWindowFunc func)	Override this method to replace a window function call.

Method Details

ref

default CqnStructuredTypeRef ref(CqnStructuredTypeRef ref)

Override this method to replace a structured type ref.

Parameters:

ref - the immutable CqnStructuredTypeRef

Returns:

the replacement ref

See Also:

• CQL.to(segments).asRef() to create a new ref
• CQL.copy(ref) to create a modifiable copy of the ref

ref

default CqnValue ref(CqnElementRef ref)

Override this method to replace an element ref with another CqnValue.

Parameters:

ref - the immutable CqnElementRef

Returns:

a value replacing the ref

See Also:

• CQL.get(segments) to create a new ref
• CQL.copy(ref) to create a modifiable copy of the ref

literal

default CqnValue literal(CqnLiteral<?> value)

Override this method to replace a literal value with another CqnValue.

Parameters:

value - the immutable CqnLiteral value

Returns:

a value replacing the CqnLiteral

See Also:

• CQL.val(T)
• CQL.constant(T)

parameter

default CqnValue parameter(CqnParameter param)

Override this method to replace parameters.

Parameters:

param - the CqnParameter

Returns:

a CqnValue replacing the parameter

plain

@Beta
default CqnValue plain(CqnPlain plain)

list

default CqnValue list(List<Value<?>> values)

Override this method to replace a list value with another CqnValue.

Parameters:

values - the list of values

Returns:

a CqnValue replacing the CqnListValue

See Also:

• CQL.list(java.util.List<? extends com.sap.cds.ql.cqn.CqnValue>)

expression

default CqnValue expression(Value<Number> left,
 CqnArithmeticExpression.Operator op,
 Value<Number> right,
 String type)

Override this method to replace an arithmetic expression.

Parameters:

left - the left-hand side of the expression

op - the operator

right - the right-hand side of the expression

type - the return type of the expression

Returns:

a CqnValue replacing the arithmetic expression

See Also:

• CQL.expression(com.sap.cds.ql.cqn.CqnValue, com.sap.cds.ql.cqn.CqnArithmeticExpression.Operator, com.sap.cds.ql.cqn.CqnValue)

caseExpression

@Beta
default CqnValue caseExpression(List<CqnCaseExpression.Case> cases,
 CqnValue defaultValue,
 String type)

Override this method to replace an case expression.

Parameters:

cases - the cases

defaultValue - the default value

type - the return type of the expression

Returns:

a CqnValue replacing the case expression

windowFunction

default CqnValue windowFunction(CqnWindowFunc func)

Override this method to replace a window function call.

Parameters:

func - the window function

Returns:

a CqnValue replacing the window function call

function

default CqnValue function(String name,
 List<Value<?>> args,
 String type)

Override this method to replace a function call.

Parameters:

name - the name of the function

args - the arguments of the function

type - the return type of the function call

Returns:

a CqnValue replacing the function call

See Also:

• CQL.func(java.lang.String, com.sap.cds.ql.cqn.CqnValue...)

booleanFunction

default CqnPredicate booleanFunction(String name,
 List<Value<?>> args)

Override this method to replace a predicate function call.

Parameters:

name - the name of the function

args - the arguments of the function

Returns:

a CqnPredicate replacing the Boolean function call

See Also:

• CQL.booleanFunc(java.lang.String, java.util.List<? extends com.sap.cds.ql.cqn.CqnValue>)

comparison

default CqnPredicate comparison(Value<?> lhs,
 CqnComparisonPredicate.Operator op,
 Value<?> rhs)

Override this method to replace a comparison predicate.

Parameters:

lhs - the left-hand side of the comparison

op - the comparison operator

rhs - the right-hand side of the comparison

Returns:

a CqnPredicate replacing the comparison

See Also:

• CQL.comparison(com.sap.cds.ql.cqn.CqnValue, com.sap.cds.ql.cqn.CqnComparisonPredicate.Operator, com.sap.cds.ql.cqn.CqnValue)

in

default CqnPredicate in(Value<?> value,
 CqnValue valueSet)

Override this method to replace an in predicate that checks if the given value is equal to any value in the valueSet.

Parameters:

value - the value to be checked if it's contained in the set

valueSet - the value set

Returns:

a CqnPredicate replacing the CqnInPredicate

See Also:

• CQL.in(com.sap.cds.ql.cqn.CqnValue, java.util.Collection<? extends com.sap.cds.ql.cqn.CqnValue>)

in

@Beta
default CqnPredicate in(CqnInSubquery inSubquery)

Override this method to replace an in subquery predicate that checks if the given value is equal to any value returned by the subquery.

Parameters:

inSubquery - the in subquery predicate

Returns:

a CqnPredicate replacing the CqnInSubquery

between

default CqnPredicate between(CqnValue value,
 CqnValue low,
 CqnValue high)

Override this method to replace a between predicate that that tests if this value is within a closed interval with given bounds of low and high.

Parameters:

value - the value to be checked if it's contained in a closed interval

low - the lower bound

high - the upper bound

Returns:

a CqnPredicate replacing the CqnBetweenPredicate

See Also:

• CQL.between(com.sap.cds.ql.cqn.CqnValue, com.sap.cds.ql.cqn.CqnValue, com.sap.cds.ql.cqn.CqnValue)

eTag

@Beta
default CqnPredicate eTag(CqnElementRef ref,
 CqnListValue values)

Override this method to replace a eTag predicate that checks if an ETag matches any value from the given values list.

Parameters:

values - the list of values

Returns:

a CqnPredicate replacing the CqnEtagPredicate

connective

default CqnPredicate connective(CqnConnectivePredicate.Operator op,
 List<Predicate> predicates)

Override this method to replace a logical connection predicate, which connects multiple predicates with the given operator.

Parameters:

op - the connective operator (AND/OR)

predicates - the list of connected predicates

Returns:

a CqnPredicate replacing the logical connection

See Also:

• CQL.connect(com.sap.cds.ql.cqn.CqnConnectivePredicate.Operator, java.lang.Iterable<? extends com.sap.cds.ql.cqn.CqnPredicate>)
• CQL.and(com.sap.cds.ql.cqn.CqnPredicate, com.sap.cds.ql.cqn.CqnPredicate)
• CQL.or(com.sap.cds.ql.cqn.CqnPredicate, com.sap.cds.ql.cqn.CqnPredicate)

negation

default CqnPredicate negation(Predicate predicate)

Override this method to replace a logical negation.

Parameters:

predicate - the predicate of the negation

Returns:

a CqnPredicate replacing the negation

See Also:

• CQL.not(com.sap.cds.ql.cqn.CqnPredicate)

exists

default CqnPredicate exists(Select<?> subQuery)

Override this method to replace an exist subquery.

Parameters:

subQuery - the query of the exists predicate

Returns:

a CqnPredicate replacing the CqnExistsSubquery

See Also:

• CQL.exists(com.sap.cds.ql.cqn.CqnSelect)

match

default CqnPredicate match(CqnMatchPredicate match)

Override this method to replace a match predicate.

Parameters:

match - the match predicate

Returns:

a CqnPredicate replacing the CqnMatchPredicate

See Also:

• CQL.match(com.sap.cds.ql.cqn.CqnStructuredTypeRef, com.sap.cds.ql.cqn.CqnPredicate, com.sap.cds.ql.cqn.CqnMatchPredicate.Quantifier)

containment

default CqnPredicate containment(CqnContainmentTest.Position position,
 CqnValue value,
 CqnValue term,
 boolean caseInsensitive)

Override this method to replace a containment test predicate.

Parameters:

position - the position

value - the string value

term - the term to test for

caseInsensitive - whether the test should be case insensitive

Returns:

a CqnPredicate replacing the CqnContainmentTest

See Also:

• CQL.containment(com.sap.cds.ql.cqn.CqnContainmentTest.Position, com.sap.cds.ql.cqn.CqnValue, com.sap.cds.ql.cqn.CqnValue, boolean)

searchTerm

default CqnPredicate searchTerm(CqnSearchTermPredicate search)

Override this method to replace a search predicate.

Parameters:

search - the search term predicate

Returns:

a CqnPredicate replacing the CqnSearchTermPredicate

See Also:

• CQL.search(java.lang.String)

search

@Deprecated(since="3.0",
            forRemoval=true)
default CqnPredicate search(String term)

Deprecated, for removal: This API element is subject to removal in a future version.

use searchTerm(CqnSearchTermPredicate) instead

passThroughSearch

default CqnPredicate passThroughSearch(CqnPassThroughSearchPredicate search)

Override this method to replace a search predicate.

Parameters:

search - the pass-through search predicate

Returns:

a CqnPredicate replacing the CqnPassThroughSearchPredicate

where

default CqnPredicate where(Predicate where)

Override this method to set the where clause of filterable statements.

Parameters:

where - the where clause of the statement, or null

Returns:

a CqnPredicate replacing the where clause

search

default CqnPredicate search(Predicate search)

Override this method to set the search clause of Select statements.

Parameters:

search - the search clause of the statement, or null

Returns:

a CqnPredicate replacing the search clause

searchableElements

default Set<String> searchableElements(Set<String> searchableElements)

Override this method to set the searchable elements of Select statements.

Parameters:

searchableElements - the searchable elements of the statement

Returns:

the set of searchable elements

inline

default CqnSelectListItem inline(CqnInline inline)

Override this method to replace inline lists. Use CQL.to(segments).inline(items) to create a new inline.

Parameters:

inline - the CqnInline

Returns:

a CqnSelectListItem replacing the inline

expand

default CqnSelectListItem expand(CqnExpand expand)

Override this method to replace expand lists. To create a new expand, use CQL.to(segments).expand(items). To create a modifiable copy of the expand, use CQL.copy(expand).

Parameters:

expand - the CqnExpand

Returns:

a CqnSelectListItem replacing the expand

selectListValue

@Beta
default CqnSelectListItem selectListValue(SelectableValue value,
 String alias)

Override this method to replace values on the select list of Select statements.

Parameters:

value - the value

alias - the alias

Returns:

a CqnSelectListItem replacing the value

selectListValue

@Deprecated(since="3.7",
            forRemoval=true)
default CqnSelectListItem selectListValue(Value<?> value,
 String alias)

Deprecated, for removal: This API element is subject to removal in a future version.

use selectListValue(SelectableValue, String) instead

selectAll

default List<CqnSelectListItem> selectAll()

Override this method to replace asterisk (*) on the select list of Select statements.

Returns:

a CqnSelectListItem replacing the asterisk

items

default List<CqnSelectListItem> items(List<CqnSelectListItem> items)

Override this method to modify the select list items of Select statements.

Parameters:

items - the list of selected items

Returns:

the new list of items

excluding

default Set<String> excluding(Set<String> excluding)

Override this method to modify the exclude list of Select statements.

Parameters:

excluding - the names of the excluded elements

Returns:

a set of names to be excluded from the Select result

groupBy

default List<CqnValue> groupBy(List<CqnValue> values)

Override this method to modify the groupBy clause of Select statements.

Parameters:

values - the groupBy list of the Select statement

Returns:

a list of values to group by

having

@Beta
default CqnPredicate having(Predicate having)

Override this method to modify the having clause of Select statements.

Parameters:

having - the having clause of the Select statement

Returns:

a Predicate replacing the having clause

orderBy

default List<CqnSortSpecification> orderBy(List<CqnSortSpecification> sortSpecs)

Override this method to modify the orderBy clause of Select statements.

Parameters:

sortSpecs - the orderBy list of the Select statement

Returns:

a list of CqnSortSpecification defining the order of the result

sort

default CqnSortSpecification sort(Value<?> value,
 CqnSortSpecification.Order order)

Override this method to replace specific sort specs in the orderBy clause of Select statements.

Parameters:

value - the value of the sort spec

order - the sort order

Returns:

a sort spec

See Also:

• CQL.sort(com.sap.cds.ql.cqn.CqnValue, com.sap.cds.ql.cqn.CqnSortSpecification.Order)

distinct

default boolean distinct(boolean distinct)

Override this method to set the distinct flag of Select statements.

Parameters:

distinct - the distinct flag of the Select statement

Returns:

the new distinct flag

inlineCount

default boolean inlineCount(boolean inlineCount)

Override this method to set the inline count flag of Select statements.

Parameters:

inlineCount - the inline count flag of the Select statement

Returns:

the new inline count flag

top

default long top(long top)

Override this method to set the top limit of Select statements.

Parameters:

top - the top limit of the Select statement

Returns:

the new maximum number of rows to be selected or -1 for unlimited

skip

default long skip(long skip)

Override this method to set skip of Select statements.

Parameters:

skip - the skip number of the Select statement

Returns:

the new number of rows that shall be skipped