Module org.neo4j.cypherdsl.core

Package org.neo4j.cypherdsl.core

Class NamedPath

java.lang.Object

org.neo4j.cypherdsl.core.NamedPath

All Implemented Interfaces:

Visitable, IdentifiableElement, Named, PatternElement

@API(status=STABLE,
     since="1.1")
public final class NamedPath
extends Object
implements PatternElement, Named

Represents a named path. A named path can be either a RelationshipPattern that has been assigned to a variable as in p := (a)-->(b), a call to functions known to return paths or an existing, symbolic name that might come from an arbitrary procedure returning path elements.
Note: We cannot check a value that has been yielded from a procedure upfront to verify that it is a named path. This is up to the caller.

Since:

1.1

Author:

Michael J. Simons

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NamedPath.OngoingDefinitionWithName	Partial path that has a name (p = ).
static interface	NamedPath.OngoingNamedDefinition	Partial path that has a name, introduced as a superinterface for NamedPath.OngoingDefinitionWithName to avoid dragging NamedPath.OngoingDefinitionWithName.get().
static interface	NamedPath.OngoingShortestDefinition	Partial path with the number of paths to match.
static interface	NamedPath.OngoingShortestPathDefinitionWithName	Partial path that has a name (p = ) and is based on a graph algorithm function.

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor visitor)	Accept a Visitor visiting this Visitable and its nested Visitables if applicable.
Optional<SymbolicName>	getSymbolicName()	Returns an optional symbolic name.
static NamedPath	select(PatternSelector patternSelector, PatternElement patternElement)

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.Named

asExpression, getRequiredSymbolicName

Methods inherited from interface org.neo4j.cypherdsl.core.PatternElement

where

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

toString

Method Details

select

@API(status=INTERNAL,
     since="2024.7.0")
public static NamedPath select(PatternSelector patternSelector,
 PatternElement patternElement)

getSymbolicName

public Optional<SymbolicName> getSymbolicName()

Description copied from interface: Named

Returns an optional symbolic name.

Specified by:

getSymbolicName in interface Named

Returns:

an optional symbolic name

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.