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=EXPERIMENTAL,
     since="1.0")
public final class RelationshipChain
extends java.lang.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.
@NotNull Condition	asCondition()	Transform this pattern into a condition.
@NotNull RelationshipChain	length(java.lang.Integer minimum, java.lang.Integer maximum)	Changes the length of the last element of this chain
@NotNull RelationshipChain	max(java.lang.Integer maximum)	Changes the length of the last element of this chain to a new maximum length
@NotNull RelationshipChain	min(java.lang.Integer minimum)	Changes the length of the last element of this chain to a new minimum length
@NotNull RelationshipChain	named(java.lang.String newSymbolicName)	Replaces the last element of this chains with a copy of the relationship with the new symbolic name.
@NotNull RelationshipChain	named(SymbolicName newSymbolicName)	Replaces the last element of this chains with a copy of the relationship with the new symbolic name.
@NotNull RelationshipChain	properties(java.lang.Object... keysAndValues)	Adds properties to the last element of this chain.
@NotNull RelationshipChain	properties(MapExpression newProperties)	Adds properties to the last element of this chain.
@NotNull RelationshipChain	relationshipBetween(Node other, java.lang.String... types)	Starts building an undirected relationship between this node and the other.
@NotNull RelationshipChain	relationshipFrom(Node other, java.lang.String... types)	Starts building an incoming relationship starting at the other node.
@NotNull RelationshipChain	relationshipTo(Node other, java.lang.String... types)	Starts building an outgoing relationship to the other node.
@NotNull RelationshipChain	unbounded()	Changes the length of the last element of this chain to an unbounded pattern.

Methods inherited from class java.lang.Object

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

Method Detail

relationshipTo

@NotNull
public @NotNull RelationshipChain relationshipTo(Node other,
                                                 java.lang.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

@NotNull
public @NotNull RelationshipChain relationshipFrom(Node other,
                                                   java.lang.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

@NotNull
public @NotNull RelationshipChain relationshipBetween(Node other,
                                                      java.lang.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

@NotNull
public @NotNull RelationshipChain named(java.lang.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

@NotNull
public @NotNull 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

unbounded

@NotNull
@Contract(pure=true)
public @NotNull 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

@NotNull
@Contract(pure=true)
public @NotNull RelationshipChain min(java.lang.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

@NotNull
@Contract(pure=true)
public @NotNull RelationshipChain max(java.lang.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

@NotNull
@Contract(pure=true)
public @NotNull RelationshipChain length(java.lang.Integer minimum,
                                         java.lang.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

@NotNull
@Contract(pure=true)
public @NotNull 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

@NotNull
@Contract(pure=true)
public @NotNull RelationshipChain properties(java.lang.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

@NotNull
public @NotNull 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.