Package org.neo4j.cypherdsl.core

Class Relationship

java.lang.Object

org.neo4j.cypherdsl.core.Relationship

All Implemented Interfaces:

ExposesProperties<Relationship>, ExposesRelationships<RelationshipChain>, Named, PatternElement, PropertyContainer, RelationshipPattern, Visitable

@API(status=EXPERIMENTAL,
     since="1.0")
public final class Relationship
extends java.lang.Object
implements RelationshipPattern, PropertyContainer, ExposesProperties<Relationship>

See RelationshipPattern.

Since:

1.0

Author:

Michael J. Simons, Philipp Tölle

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Relationship.Details	See RelationshipDetail.
static class	Relationship.Direction	While the direction in the schema package is centered around the node, the direction here is the direction between two nodes.

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor visitor)	Accept a Visitor visiting this Visitable and its nested Visitables if applicable.
Relationship.Details	getDetails()
SymbolicName	getRequiredSymbolicName()
java.util.Optional<SymbolicName>	getSymbolicName()
Relationship	length(java.lang.Integer minimum, java.lang.Integer maximum)	Creates a new relationship with a new length
Relationship	max(java.lang.Integer maximum)	Creates a new relationship with a new maximum length
Relationship	min(java.lang.Integer minimum)	Creates a new relationship with a new minimum length
Relationship	named(java.lang.String newSymbolicName)	Creates a copy of this relationship with a new symbolic name.
Relationship	named(SymbolicName newSymbolicName)	Creates a copy of this relationship with a new symbolic name.
MapProjection	project(java.lang.Object... entries)	Creates a map projection based on this relationship.
Property	property(java.lang.String name)	Creates a new Property associated with this property container.
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.
Relationship	unbounded()	Creates a new relationship with an unbound length minimum length
Relationship	withProperties(java.lang.Object... keysAndValues)	Creates a a copy of this property container with additional properties.
Relationship	withProperties(MapExpression newProperties)	Creates a a copy of this property container with additional properties.

Methods inherited from class java.lang.Object

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

Method Detail

getDetails

public Relationship.Details getDetails()

named

public Relationship named(java.lang.String newSymbolicName)

Creates a copy of this relationship with a new symbolic name.

Specified by:

named in interface RelationshipPattern

Parameters:

newSymbolicName - the new symbolic name.

Returns:

The new relationship.

named

public Relationship named(SymbolicName newSymbolicName)

Creates a copy of this relationship with a new symbolic name.

Parameters:

newSymbolicName - the new symbolic name.

Returns:

The new relationship.

unbounded

public Relationship unbounded()

Creates a new relationship with an unbound length minimum length

Returns:

the new relationship

Since:

1.1.1

min

public Relationship min(java.lang.Integer minimum)

Creates a new relationship with a new minimum length

Parameters:

minimum - the new minimum

Returns:

the new relationship

max

public Relationship max(java.lang.Integer maximum)

Creates a new relationship with a new maximum length

Parameters:

maximum - the new maximum

Returns:

the new relationship

length

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

Creates a new relationship with a new length

Parameters:

minimum - the new minimum

maximum - the new maximum

Returns:

the new relationship

withProperties

public Relationship withProperties(MapExpression newProperties)

Description copied from interface: ExposesProperties

Creates a a copy of this property container with additional properties. Creates a property container without properties when no properties are passed to this method.

Specified by:

withProperties in interface ExposesProperties<Relationship>

Parameters:

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

Returns:

The new property container.

withProperties

public Relationship withProperties(java.lang.Object... keysAndValues)

Description copied from interface: ExposesProperties

Creates a a copy of this property container with additional properties. Creates a property container without properties when no properties are passed to this method.

Specified by:

withProperties in interface ExposesProperties<Relationship>

Parameters:

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

Returns:

The new property container.

property

public Property property(java.lang.String name)

Description copied from interface: PropertyContainer

Creates a new Property associated with this property container. This property can be used as a lookup in other expressions. It does not add a value to the property.

Note: The property container does not track property creation and there is no possibility to enumerate all properties that have been created for this property container.

Specified by:

property in interface PropertyContainer

Parameters:

name - property name, must not be null or empty.

Returns:

a new Property associated with this Relationship.

getSymbolicName

public java.util.Optional<SymbolicName> getSymbolicName()

Specified by:

getSymbolicName in interface Named

getRequiredSymbolicName

public SymbolicName getRequiredSymbolicName()

Specified by:

getRequiredSymbolicName in interface Named

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

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.

project

public MapProjection project(java.lang.Object... entries)

Creates a map projection based on this relationship. The relationship needs a symbolic name for this to work.

Entries of type String in entries followed by an Expression will be treated as map keys pointing to the expression in the projection, String entries alone will be treated as property lookups on the node.

Parameters:

entries - A list of entries for the projection

Returns:

A map projection.