Package org.neo4j.cypherdsl.core

Class RelationshipChain

java.lang.Object

org.neo4j.cypherdsl.core.RelationshipChain

All Implemented Interfaces:

ExposesRelationships<RelationshipChain>, PatternElement, RelationshipPattern, Visitable

@API(status=EXPERIMENTAL,
     since="1.0")
public final class RelationshipChain
extends java.lang.Object
implements RelationshipPattern

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

Constructor Summary

Constructors

Constructor	Description
RelationshipChain()

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(java.lang.Integer minimum, java.lang.Integer maximum)	Changes the length of the last element of this chain
RelationshipChain	max(java.lang.Integer maximum)	Changes the length of the last element of this chain to a new maximum length
RelationshipChain	min(java.lang.Integer minimum)	Changes the length of the last element of this chain to a new minimum length
RelationshipChain	named(java.lang.String newSymbolicName)	Replaces the last element of this chains with a copy of the relationship with the new symbolic name.
RelationshipChain	properties(java.lang.Object... keysAndValues)	Adds properties to the last element of this chain.
RelationshipChain	properties(MapExpression newProperties)	Adds properties to the last element of this chain.
RelationshipChain	relationshipBetween(Node other, java.lang.String... types)	Starts building an undirected relationship between this node and the other.
RelationshipChain	relationshipFrom(Node other, java.lang.String... types)	Starts building an incoming relationship starting at the other node.
RelationshipChain	relationshipTo(Node other, java.lang.String... types)	Starts building an outgoing relationship to the other node.
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

Constructor Detail

RelationshipChain

public RelationshipChain()

Method Detail

relationshipTo

public 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

public 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

public 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

public 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:

This chain

unbounded

public RelationshipChain unbounded()

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

Returns:

This chain

Since:

1.1.1

min

public RelationshipChain min(java.lang.Integer minimum)

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

Parameters:

minimum - the new minimum

Returns:

This chain

max

public RelationshipChain max(java.lang.Integer maximum)

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

Parameters:

maximum - the new maximum

Returns:

This chain

length

public RelationshipChain length(java.lang.Integer minimum,
                                java.lang.Integer maximum)

Changes the length of the last element of this chain

Parameters:

minimum - the new minimum

maximum - the new maximum

Returns:

This 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:

This chain

properties

public 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:

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