All Superinterfaces:

Visitable

All Known Subinterfaces:

Case.CaseEnding, Condition, Literal<T>, Property

All Known Implementing Classes:

AliasedExpression, Asterisk, BooleanLiteral, Case.GenericCase.EndingGenericCase, Case.SimpleCase.EndingSimpleCase, Comparison, CompoundCondition, ConstantCondition, ExistentialSubquery, FunctionInvocation, HasLabelCondition, KeyValueMapEntry, ListComprehension, ListExpression, ListLiteral, ListOperator, MapExpression, MapProjection, Namespace, NestedExpression, NotCondition, NullLiteral, NumberLiteral, Operation, Parameter, PatternComprehension, PropertyLookup, StringLiteral, SymbolicName, TemporalLiteral
```
@API(status=EXPERIMENTAL,
     since="1.0")
public interface Expression
extends Visitable
```
An expression can be used in many places, i.e. in return statements, pattern elements etc.

Since:

1.0

Author:

Michael J. Simons

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default Operation`	`add(Expression addend)`	Creates a `+` operation of this (the augend) and the `addend`.
`default AliasedExpression`	`as(java.lang.String alias)`	Creates an expression with an alias.
`default AliasedExpression`	`as(SymbolicName alias)`	Reuse an existing symbolic name to alias this expression
`default SortItem`	`ascending()`	The property does not track the sort items created here.
`default Operation`	`concat(Expression expression)`	Creates an expression concatenating two string or list expressions.
`default Condition`	`contains(Expression expression)`	Creates a condition that checks whether this `expression` contains that `expression`.
`default SortItem`	`descending()`	The property does not track the sort items created here.
`default Operation`	`divide(Expression dividend)`	Creates a `/` operation of this (the divisor) and the `dividend`.
`default Condition`	`endsWith(Expression expression)`	Creates a condition that checks whether this `expression` ends with that `expression`.
`default Condition`	`eq(Expression rhs)`	An alias for `isEqualTo(Expression)`.
`default Condition`	`gt(Expression rhs)`	Creates a `lhs > rhs` condition.
`default Condition`	`gte(Expression rhs)`	Creates a `lhs >= rhs` condition.
`default Condition`	`in(Expression haystack)`	Creates a `IN` operation for this expression and that `expression`.
`default Condition`	`isEmpty()`	Creates a condition that evaluates to true if this expression is empty.
`default Condition`	`isEqualTo(Expression rhs)`	Creates a `lhs = rhs` condition.
`default Condition`	`isFalse()`	Creates a condition that checks whether this `expression` is false.
`default Condition`	`isNotEqualTo(Expression rhs)`	Creates a `lhs <> rhs` condition.
`default Condition`	`isNotNull()`	Creates a `IS NOT NULL` operation for this `expression`.
`default Condition`	`isNull()`	Creates a `IS NULL` operation for this `expression`.
`default Condition`	`isTrue()`	Creates a condition that checks whether this `expression` is true.
`default Condition`	`lt(Expression rhs)`	Creates a `lhs < rhs` condition.
`default Condition`	`lte(Expression rhs)`	Creates a `lhs <= rhs` condition.
`default Condition`	`matches(java.lang.String pattern)`	Creates a condition that checks whether this `expression` matches the given `pattern`.
`default Condition`	`matches(Expression expression)`	Creates a condition that checks whether this `expression` matches that `expression`.
`default Operation`	`multiply(Expression multiplicand)`	Creates a `*` operation of this (the multiplier) and the `multiplicand`.
`default Condition`	`ne(Expression rhs)`	An alias for `isNotEqualTo(Expression)`.
`default Operation`	`pow(Expression n)`	Returns the power of n of this value.
`default Property`	`property(java.lang.String... names)`	Assumes that this expressions refers to a container of some type allowing to reference properties from it.
`default Operation`	`remainder(Expression dividend)`	Returns the remainder of this value and the `dividend`.
`default Condition`	`startsWith(Expression expression)`	Creates a condition that checks whether this `expression` starts with that `expression`.
`default Operation`	`subtract(Expression subtrahend)`	Creates a `-` operation of this (the minuend) and the `subtrahend`.

Methods inherited from interface org.neo4j.cypherdsl.core.support.Visitable
accept

- Method Detail
  - as
```
default AliasedExpression as(java.lang.String alias)
```
    Creates an expression with an alias. This expression does not track which or how many aliases have been created.
    
    Parameters:
    
    alias - The alias to use
    
    Returns:
    
    An aliased expression.
  - as
```
default AliasedExpression as(SymbolicName alias)
```
    Reuse an existing symbolic name to alias this expression
    
    Parameters:
    
    alias - A symbolic name
    
    Returns:
    
    An aliased expression.
    
    Since:
    
    2021.0.2
  - isEqualTo
```
default Condition isEqualTo(Expression rhs)
```
    Creates a lhs = rhs condition.
    
    Parameters:
    
    rhs - The right hand side of the condition
    
    Returns:
    
    A new condition
  - eq
```
default Condition eq(Expression rhs)
```
    An alias for isEqualTo(Expression).
    
    Parameters:
    
    rhs - The right hand side of the condition
    
    Returns:
    
    A new condition
  - isNotEqualTo
```
default Condition isNotEqualTo(Expression rhs)
```
    Creates a lhs <> rhs condition.
    
    Parameters:
    
    rhs - The right hand side of the condition
    
    Returns:
    
    A new condition
  - ne
```
default Condition ne(Expression rhs)
```
    An alias for isNotEqualTo(Expression).
    
    Parameters:
    
    rhs - The right hand side of the condition
    
    Returns:
    
    A new condition
  - lt
```
default Condition lt(Expression rhs)
```
    Creates a lhs < rhs condition.
    
    Parameters:
    
    rhs - The right hand side of the condition
    
    Returns:
    
    A new condition
  - lte
```
default Condition lte(Expression rhs)
```
    Creates a lhs <= rhs condition.
    
    Parameters:
    
    rhs - The right hand side of the condition
    
    Returns:
    
    A new condition
  - gt
```
default Condition gt(Expression rhs)
```
    Creates a lhs > rhs condition.
    
    Parameters:
    
    rhs - The right hand side of the condition
    
    Returns:
    
    A new condition
  - gte
```
default Condition gte(Expression rhs)
```
    Creates a lhs >= rhs condition.
    
    Parameters:
    
    rhs - The right hand side of the condition
    
    Returns:
    
    A new condition
  - isTrue
```
default Condition isTrue()
```
    Creates a condition that checks whether this expression is true.
    
    Returns:
    
    A new condition
  - isFalse
```
default Condition isFalse()
```
    Creates a condition that checks whether this expression is false.
    
    Returns:
    
    A new condition
  - matches
```
default Condition matches(Expression expression)
```
    Creates a condition that checks whether this expression matches that expression.
    
    Parameters:
    
    expression - The expression to match against. Must evaluate into a string during runtime.
    
    Returns:
    
    A new condition.
  - matches
```
default Condition matches(java.lang.String pattern)
```
    Creates a condition that checks whether this expression matches the given pattern.
    
    Parameters:
    
    pattern - The pattern to match
    
    Returns:
    
    A new condition.
  - startsWith
```
default Condition startsWith(Expression expression)
```
    Creates a condition that checks whether this expression starts with that expression.
    
    Parameters:
    
    expression - The expression to match against. Must evaluate into a string during runtime.
    
    Returns:
    
    A new condition.
  - contains
```
default Condition contains(Expression expression)
```
    Creates a condition that checks whether this expression contains that expression.
    
    Parameters:
    
    expression - The expression to match against. Must evaluate into a string during runtime.
    
    Returns:
    
    A new condition.
  - endsWith
```
default Condition endsWith(Expression expression)
```
    Creates a condition that checks whether this expression ends with that expression.
    
    Parameters:
    
    expression - The expression to match against. Must evaluate into a string during runtime.
    
    Returns:
    
    A new condition.
  - concat
```
default Operation concat(Expression expression)
```
    Creates an expression concatenating two string or list expressions.
    
    Parameters:
    
    expression - The expression to concat to this expression.
    
    Returns:
    
    A new expression.
  - add
```
default Operation add(Expression addend)
```
    Creates a + operation of this (the augend) and the addend.
    
    Parameters:
    
    addend - The addend
    
    Returns:
    
    A new operation.
    
    Since:
    
    1.0.1
  - subtract
```
default Operation subtract(Expression subtrahend)
```
    Creates a - operation of this (the minuend) and the subtrahend.
    
    Parameters:
    
    subtrahend - The subtrahend
    
    Returns:
    
    A new operation.
    
    Since:
    
    1.0.1
  - multiply
```
default Operation multiply(Expression multiplicand)
```
    Creates a * operation of this (the multiplier) and the multiplicand.
    
    Parameters:
    
    multiplicand - The multiplicand
    
    Returns:
    
    A new operation.
    
    Since:
    
    1.0.1
  - divide
```
default Operation divide(Expression dividend)
```
    Creates a / operation of this (the divisor) and the dividend.
    
    Parameters:
    
    dividend - The dividend
    
    Returns:
    
    A new operation.
    
    Since:
    
    1.0.1
  - remainder
```
default Operation remainder(Expression dividend)
```
    Returns the remainder of this value and the dividend.
    
    Parameters:
    
    dividend - The dividend
    
    Returns:
    
    A new operation.
  - pow
```
default Operation pow(Expression n)
```
    Returns the power of n of this value.
    
    Parameters:
    
    n - power to raise this Expression to.
    
    Returns:
    
    A new operation.
  - isNull
```
default Condition isNull()
```
    Creates a IS NULL operation for this expression. The expression does not track the condition created here.
    
    Returns:
    
    A condition based on this expression that evaluates to true when this expression is null.
  - isNotNull
```
default Condition isNotNull()
```
    Creates a IS NOT NULL operation for this expression. The expression does not track the condition created here.
    
    Returns:
    
    A condition based on this expression that evaluates to true when this expression is not null.
  - in
```
default Condition in(Expression haystack)
```
    Creates a IN operation for this expression and that expression. The expression does not track the condition created here.
    
    Parameters:
    
    haystack - The expression to search for this expression
    
    Returns:
    
    A new condition.
  - isEmpty
```
default Condition isEmpty()
```
    Creates a condition that evaluates to true if this expression is empty.
    
    Returns:
    
    A new condition.
  - descending
```
default SortItem descending()
```
    The property does not track the sort items created here.
    
    Returns:
    
    A sort item for this property in descending order
  - ascending
```
default SortItem ascending()
```
    The property does not track the sort items created here.
    
    Returns:
    
    A sort item for this property in ascending order
  - property
```
default Property property(java.lang.String... names)
```
    Assumes that this expressions refers to a container of some type allowing to reference properties from it. Note: The expression does not track property creation and there is no possibility to enumerate all properties that have been created for it.
    
    Parameters:
    
    names - At least one non empty name. If multiple names are specified, the expression creates a nested property like this.name1.name2.
    
    Returns:
    
    a new Property associated with this expression
    
    Since:
    
    2021.0.0

Interface Expression

Method Summary

Methods inherited from interface org.neo4j.cypherdsl.core.support.Visitable

Method Detail

as

as

isEqualTo

eq

isNotEqualTo

ne

lt

lte

gt

gte

isTrue

isFalse

matches

matches

startsWith

contains

endsWith

concat

add

subtract

multiply

divide

remainder

pow

isNull

isNotNull

in

isEmpty

descending

ascending

property