Package org.neo4j.cypherdsl.core

Interface Node

All Superinterfaces:

ExposesProperties<Node>, ExposesRelationships<Relationship>, IdentifiableElement, Named, PatternElement, PropertyContainer, Visitable

All Known Implementing Classes:

NodeBase

@API(status=STABLE,
     since="1.0")
public interface Node
extends PatternElement, PropertyContainer, ExposesProperties<Node>, ExposesRelationships<Relationship>

See NodePattern.

Since:

1.0

Author:

Michael J. Simons

Method Summary

Modifier and Type	Method	Description
@NotNull AliasedExpression	as(String alias)	Creates an alias for this node.
@NotNull SortItem	ascending()	Creates a new sort item of this node in ascending order.
@NotNull SortItem	descending()	Creates a new sort item of this node in descending order.
default @NotNull FunctionInvocation	elementId()
@NotNull List<NodeLabel>	getLabels()
@NotNull Condition	hasLabels(String... labelsToQuery)	A condition that checks for the presence of labels on a node.
@NotNull FunctionInvocation	internalId()	Deprecated. Use elementId()
@NotNull Condition	isEqualTo(Node otherNode)	Creates a new condition whether this node is equal to otherNode.
@NotNull Condition	isNotEqualTo(Node otherNode)	Creates a new condition whether this node is not equal to otherNode.
@NotNull Condition	isNotNull()	Creates a new condition based on this node whether it is not null.
@NotNull Condition	isNull()	Creates a new condition based on this node whether it is null.
@NotNull FunctionInvocation	labels()
@NotNull Node	named(String newSymbolicName)	Creates a copy of this node with a new symbolic name.
@NotNull Node	named(SymbolicName newSymbolicName)	Creates a copy of this node with a new symbolic name.

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

withProperties, withProperties, withProperties

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

relationshipBetween, relationshipFrom, relationshipTo

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

asExpression, getRequiredSymbolicName, getSymbolicName

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

mutate, mutate, project, project, property, property, property, set, set

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

accept

Method Detail

getLabels

@NotNull
@Contract(pure=true)
@NotNull List<NodeLabel> getLabels()

named

@NotNull
@Contract(pure=true)
@NotNull Node named(String newSymbolicName)

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

Parameters:

newSymbolicName - the new symbolic name.

Returns:

The new node.

named

@NotNull
@Contract(pure=true)
@NotNull Node named(SymbolicName newSymbolicName)

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

Parameters:

newSymbolicName - the new symbolic name.

Returns:

The new node.

hasLabels

@NotNull
@Contract(pure=true)
@NotNull Condition hasLabels(String... labelsToQuery)

A condition that checks for the presence of labels on a node.

Parameters:

labelsToQuery - A list of labels to query

Returns:

A condition that checks whether this node has all of the labels to query

isEqualTo

@NotNull
@Contract(pure=true)
@NotNull Condition isEqualTo(Node otherNode)

Creates a new condition whether this node is equal to otherNode.

Parameters:

otherNode - The node to compare this node to.

Returns:

A condition.

isNotEqualTo

@NotNull
@Contract(pure=true)
@NotNull Condition isNotEqualTo(Node otherNode)

Creates a new condition whether this node is not equal to otherNode.

Parameters:

otherNode - The node to compare this node to.

Returns:

A condition.

isNull

@NotNull
@Contract(pure=true)
@NotNull Condition isNull()

Creates a new condition based on this node whether it is null.

Returns:

A condition.

isNotNull

@NotNull
@Contract(pure=true)
@NotNull Condition isNotNull()

Creates a new condition based on this node whether it is not null.

Returns:

A condition.

descending

@NotNull
@Contract(pure=true)
@NotNull SortItem descending()

Creates a new sort item of this node in descending order.

Returns:

A sort item.

ascending

@NotNull
@Contract(pure=true)
@NotNull SortItem ascending()

Creates a new sort item of this node in ascending order.

Returns:

A sort item.

as

@NotNull
@Contract(pure=true)
@NotNull AliasedExpression as(String alias)

Creates an alias for this node.

Parameters:

alias - The alias to use.

Returns:

The aliased expression.

internalId

@NotNull
@Contract(pure=true)
@Deprecated
@NotNull FunctionInvocation internalId()

Deprecated.

Use elementId()

Returns:

A new function invocation returning the internal id of this node.

elementId

@NotNull
@Contract(pure=true)
default @NotNull FunctionInvocation elementId()

Returns:

A new function invocation returning the element id of this node.

Since:

2022.6.0

labels

@NotNull
@Contract(pure=true)
@NotNull FunctionInvocation labels()

Returns:

A new function invocation returning the labels of this node.