Module org.neo4j.cypherdsl.core

Package org.neo4j.cypherdsl.core

Class QuantifiedPathPattern

java.lang.Object

org.neo4j.cypherdsl.core.QuantifiedPathPattern

All Implemented Interfaces:

Visitable, PatternElement

@Neo4jVersion(minimum="5.9")
@API(status=STABLE,
     since="2023.9.0")
public final class QuantifiedPathPattern
extends Object
implements PatternElement

Since:

2023.9.0

Author:

Michael J. Simons

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QuantifiedPathPattern.Quantifier	Quantifier for path patterns.
static final class	QuantifiedPathPattern.TargetPattern	Synthetic element for the Cypher-DSL AST.

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor visitor)	Accept a Visitor visiting this Visitable and its nested Visitables if applicable.
static QuantifiedPathPattern.Quantifier	interval(Integer lowerBound, Integer upperBound)	Creates an interval quantifier
static QuantifiedPathPattern.Quantifier	plus()	Returns the + quantifier.
static QuantifiedPathPattern.Quantifier	star()	Returns the * quantifier.
@NotNull PatternElement	where(@Nullable Expression predicate)	Creates a new PatternElement which including an additional filter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

toString

Method Details

interval

public static QuantifiedPathPattern.Quantifier interval(Integer lowerBound,
 Integer upperBound)

Creates an interval quantifier

Parameters:

lowerBound - lower bound, must be greater than or equal to 0

upperBound - upper bound, must be greater than or equal to the lower bound

Returns:

a quantifier

plus

public static QuantifiedPathPattern.Quantifier plus()

Returns the + quantifier.

Returns:

the + quantifier

star

public static QuantifiedPathPattern.Quantifier star()

Returns the * quantifier.

Returns:

the * quantifier

accept

public void accept(Visitor visitor)

Description copied from interface: Visitable

Accept a Visitor visiting this Visitable and its nested Visitables if applicable.

Specified by:

accept in interface Visitable

Parameters:

visitor - the visitor to notify, must not be null.

where

@NotNull
public @NotNull PatternElement where(@Nullable
 @Nullable Expression predicate)

Description copied from interface: PatternElement

Creates a new PatternElement which including an additional filter. Returns this pattern. when predicate is literal null.

The pattern might be a node pattern or a relationship pattern.

A WHERE on a pattern is only supported from Neo4j 5.0 onwards.

Specified by:

where in interface PatternElement

Parameters:

predicate - the predicate to filter on

Returns:

a new pattern element or this instance if the predicate to this method was literal null