Module org.neo4j.cypherdsl.core

Package org.neo4j.cypherdsl.core

Interface RelationshipPattern

All Superinterfaces:

ExposesRelationships<RelationshipChain>, PatternElement, Visitable

All Known Subinterfaces:

Relationship

All Known Implementing Classes:

RelationshipBase, RelationshipChain

@API(status=STABLE,
     since="1.0")
public interface RelationshipPattern
extends PatternElement, ExposesRelationships<RelationshipChain>

A shared, public interface for relationships and chains of relationships. This interface reassembles the RelationshipPattern.

This interface can be used synonymous with the concept of a Path Pattern.

Since:

1.0

Author:

Michael J. Simons

Method Summary

Modifier and Type	Method	Description
Condition	asCondition()	Transform this pattern into a condition.
ExposesRelationships<RelationshipChain>	named(String name)	Turns the pattern into a named chain of relationships.
ExposesRelationships<RelationshipChain>	named(SymbolicName name)	Turns the pattern into a named chain of relationships.
default PatternElement	quantify(QuantifiedPathPattern.Quantifier quantifier)	Quantifies the pattern.
default PatternElement	quantifyRelationship(QuantifiedPathPattern.Quantifier quantifier)	Quantifies the relationship.

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

relationshipBetween, relationshipFrom, relationshipTo, relationshipWith

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

where

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

accept, toString

Method Details

named

@CheckReturnValue
ExposesRelationships<RelationshipChain> named(String name)

Turns the pattern into a named chain of relationships.

Parameters:

name - the name to be used.

Returns:

a named relationship that can be chained with more relationship definitions.

named

@CheckReturnValue
ExposesRelationships<RelationshipChain> named(SymbolicName name)

Turns the pattern into a named chain of relationships.

Parameters:

name - the name to be used.

Returns:

a named relationship that can be chained with more relationship definitions.

asCondition

Condition asCondition()

Transform this pattern into a condition. All names of the patterns must be known upfront in the final statement, as PatternExpressions are not allowed to introduce new variables.

Returns:

a condition based on this pattern.

Since:

2021.0.0

quantifyRelationship

default PatternElement quantifyRelationship(QuantifiedPathPattern.Quantifier quantifier)

Quantifies the relationship.

Parameters:

quantifier - the quantifier to use

Returns:

a quantified relationship

Since:

2023.9.0

quantify

default PatternElement quantify(QuantifiedPathPattern.Quantifier quantifier)

Quantifies the pattern.

Parameters:

quantifier - the quantifier to use

Returns:

a quantified path pattern

Since:

2023.9.0