com.sap.cds.ql.cqn

Interface CqnInPredicate

All Superinterfaces:

CqnExpression, CqnPredicate, CqnToken, CqnValue, JSONizable

public interface CqnInPredicate
extends CqnPredicate

The in predicate tests wether an actual value is equal to any value from a defined value set. It evaluates to false if the value set is empty.

Method Summary

Modifier and Type	Method and Description
default void	accept(CqnVisitor visitor) Traverses the expression tree represented by this token with a given visitor.
CqnValue	value() The actual CqnValue that is tested against the values given by valueSet().
default Collection<CqnValue>	values() Returns the collection of expected values in case valueSet() is a CqnListValue, otherwise a ClassCastException is thrown.
CqnValue	valueSet() Defines the set of expected values the actual value is tested against.

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

asPredicate, isPredicate

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

asArithmeticExpression, asExpression, asNegation, isArithmeticExpression, isExpression, isNegation, toJson

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

as, asFunction, asList, asLiteral, asNullValue, asParameter, asPlain, asRef, isFunction, isList, isLiteral, isNullValue, isParameter, isPlain, isRef, ofRef, type

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

tokens

Method Detail

value

CqnValue value()

The actual CqnValue that is tested against the values given by valueSet().

Returns:

the actual CqnValue

values

default Collection<CqnValue> values()

Returns the collection of expected values in case valueSet() is a CqnListValue, otherwise a ClassCastException is thrown.

Returns:

the expected values

Throws:

ClassCastException - if this value is not a CqnListValue

valueSet

CqnValue valueSet()

Defines the set of expected values the actual value is tested against. Given as a CqnListValue containing all expected values, as a CqnReference pointing to a collection-valued element or a CqnParameter pointing to a collection of values.

Returns:

the set of expected values

accept

default void accept(CqnVisitor visitor)

Description copied from interface: CqnToken

Traverses the expression tree represented by this token with a given visitor. The traversal order is depth-first. If this token has child nodes they are traversed first by dispatching the visitor to the children's accept methods. Afterwards this token is passed to the visitor's visit method specific for this token's type.

Specified by:

accept in interface CqnExpression

Specified by:

accept in interface CqnToken

Parameters:

visitor - the CqnVisitor