Module org.neo4j.cypherdsl.core

Package org.neo4j.cypherdsl.core

Class RelationshipChain

java.lang.Object

org.neo4j.cypherdsl.core.RelationshipChain

All Implemented Interfaces:

Visitable, ExposesPatternLengthAccessors<RelationshipChain>, ExposesRelationships<RelationshipChain>, PatternElement, RelationshipPattern

@API(status=STABLE,
     since="1.0")
public final class RelationshipChain
extends Object
implements RelationshipPattern, ExposesPatternLengthAccessors<RelationshipChain>

Represents a chain of relationships. The chain is meant to be in order and the right node of an element is related to the left node of the next element.

Since:

1.0

Author:

Michael J. Simons

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor visitor)	Accept a Visitor visiting this Visitable and its nested Visitables if applicable.
Condition	asCondition()	Transform this pattern into a condition.
RelationshipChain	length(Integer minimum, Integer maximum)	Changes the length of the last element of this chain.
RelationshipChain	max(Integer maximum)	Changes the length of the last element of this chain to a new maximum length.
RelationshipChain	min(Integer minimum)	Changes the length of the last element of this chain to a new minimum length.
RelationshipChain	named(String newSymbolicName)	Replaces the last element of this chains with a copy of the relationship with the new symbolic name.
RelationshipChain	named(SymbolicName newSymbolicName)	Replaces the last element of this chains with a copy of the relationship with the new symbolic name.
RelationshipChain	properties(Object... keysAndValues)	Adds properties to the last element of this chain.
RelationshipChain	properties(MapExpression newProperties)	Adds properties to the last element of this chain.
QuantifiedPathPattern	quantify(QuantifiedPathPattern.Quantifier newQuantifier)	Quantifies the pattern.
RelationshipPattern	quantifyRelationship(QuantifiedPathPattern.Quantifier quantifier)	Quantifies the relationship.
RelationshipChain	relationshipBetween(Node other, String... types)	Starts building an undirected relationship between this node and the other.
RelationshipChain	relationshipFrom(Node other, String... types)	Starts building an incoming relationship starting at the other node.
RelationshipChain	relationshipTo(Node other, String... types)	Starts building an outgoing relationship to the other node.
String	toString()	Most visitables will render themselves into a Cypher fragment preceded with the actual classname.
RelationshipChain	unbounded()	Changes the length of the last element of this chain to an unbounded pattern.
RelationshipChain	where(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, wait, wait, wait

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

relationshipWith

Method Details

relationshipTo

public RelationshipChain relationshipTo(Node other,
 String... types)

Description copied from interface: ExposesRelationships

Starts building an outgoing relationship to the other node.

Specified by:

relationshipTo in interface ExposesRelationships<RelationshipChain>

Parameters:

other - the other end of the outgoing relationship

types - the types to match

Returns:

an ongoing relationship definition, that can be used to specify the type

relationshipFrom

public RelationshipChain relationshipFrom(Node other,
 String... types)

Description copied from interface: ExposesRelationships

Starts building an incoming relationship starting at the other node.

Specified by:

relationshipFrom in interface ExposesRelationships<RelationshipChain>

Parameters:

other - the source of the incoming relationship

types - the types to match

Returns:

an ongoing relationship definition, that can be used to specify the type

relationshipBetween

public RelationshipChain relationshipBetween(Node other,
 String... types)

Description copied from interface: ExposesRelationships

Starts building an undirected relationship between this node and the other.

Specified by:

relationshipBetween in interface ExposesRelationships<RelationshipChain>

Parameters:

other - the other end of the relationship

types - the types to match

Returns:

an ongoing relationship definition, that can be used to specify the type

named

public RelationshipChain named(String newSymbolicName)

Replaces the last element of this chains with a copy of the relationship with the new symbolic name.

Specified by:

named in interface RelationshipPattern

Parameters:

newSymbolicName - the new symbolic name to use

Returns:

a new chain

named

public RelationshipChain named(SymbolicName newSymbolicName)

Replaces the last element of this chains with a copy of the relationship with the new symbolic name.

Specified by:

named in interface RelationshipPattern

Parameters:

newSymbolicName - the new symbolic name to use

Returns:

a new chain

Since:

2021.1.1

where

public RelationshipChain where(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

quantifyRelationship

public RelationshipPattern quantifyRelationship(QuantifiedPathPattern.Quantifier quantifier)

Description copied from interface: RelationshipPattern

Quantifies the relationship.

Specified by:

quantifyRelationship in interface RelationshipPattern

Parameters:

quantifier - the quantifier to use

Returns:

a quantified relationship

quantify

public QuantifiedPathPattern quantify(QuantifiedPathPattern.Quantifier newQuantifier)

Description copied from interface: RelationshipPattern

Quantifies the pattern.

Specified by:

quantify in interface RelationshipPattern

Parameters:

newQuantifier - the quantifier to use

Returns:

a quantified path pattern

unbounded

public RelationshipChain unbounded()

Changes the length of the last element of this chain to an unbounded pattern.

Specified by:

unbounded in interface ExposesPatternLengthAccessors<RelationshipChain>

Returns:

a new chain

Since:

1.1.1

min

public RelationshipChain min(Integer minimum)

Changes the length of the last element of this chain to a new minimum length.

Specified by:

min in interface ExposesPatternLengthAccessors<RelationshipChain>

Parameters:

minimum - the new minimum

Returns:

a new chain

max

public RelationshipChain max(Integer maximum)

Changes the length of the last element of this chain to a new maximum length.

Specified by:

max in interface ExposesPatternLengthAccessors<RelationshipChain>

Parameters:

maximum - the new maximum

Returns:

a new chain

length

public RelationshipChain length(Integer minimum,
 Integer maximum)

Changes the length of the last element of this chain.

Specified by:

length in interface ExposesPatternLengthAccessors<RelationshipChain>

Parameters:

minimum - the new minimum

maximum - the new maximum

Returns:

a new chain

properties

public RelationshipChain properties(MapExpression newProperties)

Adds properties to the last element of this chain.

Parameters:

newProperties - the new properties (can be null to remove exiting properties).

Returns:

a new chain

properties

public RelationshipChain properties(Object... keysAndValues)

Adds properties to the last element of this chain.

Parameters:

keysAndValues - a list of key and values. Must be an even number, with alternating String and Expression.

Returns:

a new chain

asCondition

public Condition asCondition()

Description copied from interface: RelationshipPattern

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.

Specified by:

asCondition in interface RelationshipPattern

Returns:

a condition based on this pattern.

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.

toString

public String toString()

Description copied from interface: Visitable

Most visitables will render themselves into a Cypher fragment preceded with the actual classname. The representation however is not cached - in contrast to the ones for full statements. Using toString is recommended for debugging purposes mainly, and not for production use.

The concrete classname has been prepended to help debugging and actually to discourage using fragments to build queries without explicitly rendering them, either as statement or going through the renderer on purpose.

Specified by:

toString in interface Visitable

Overrides:

toString in class Object

Returns:

a string representation of this visitable formatted as Classname{cypher=value}