Package org.neo4j.cypherdsl.core

Class SymbolicName

java.lang.Object

org.neo4j.cypherdsl.core.SymbolicName

All Implemented Interfaces:

Visitable, Expression, IdentifiableElement

@API(status=EXPERIMENTAL,
     since="1.0")
public final class SymbolicName
extends Object
implements Expression, IdentifiableElement

A symbolic name to identify nodes, relationships and aliased items.

See SchemaName SymbolicName

While OpenCypher extends the UNICODE IDENTIFIER AND PATTERN SYNTAX with some characters, this DSL uses the same identifier Java itself uses for simplicity and until otherwise needed.

Since:

1.0

Author:

Michael J. Simons, Andreas Berger

Method Summary

Modifier and Type	Method	Description
@NotNull Expression	asExpression()	Transform this element into an expression
@NotNull SymbolicName	concat(String otherValue)	Creates a new symbolic name by concatenating otherValue to this names value.
boolean	equals(Object o)
String	getValue()
int	hashCode()
@NotNull MapProjection	project(Object... entries)	Creates a map projection based on this node.
@NotNull MapProjection	project(List<Object> entries)	A list will never be a valid entry for a map projection, so this convenient method prevents trying to create one from a list of objects.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

add, as, as, ascending, asCondition, concat, contains, descending, divide, endsWith, eq, gt, gte, in, isEmpty, isEqualTo, isFalse, isNotEqualTo, isNotNull, isNull, isTrue, lt, lte, matches, matches, multiply, ne, pow, property, remainder, sorted, startsWith, subtract

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

accept

Method Detail

getValue

@API(status=INTERNAL)
public String getValue()

Returns:

The value of this symbolic name.

concat

@NotNull
@Contract(pure=true)
public @NotNull SymbolicName concat(String otherValue)

Creates a new symbolic name by concatenating otherValue to this names value. Returns this if otherValue is empty.

Parameters:

otherValue - The value to concat.

Returns:

A new symbolic name

project

@NotNull
@Contract(pure=true)
public @NotNull MapProjection project(List<Object> entries)

A list will never be a valid entry for a map projection, so this convenient method prevents trying to create one from a list of objects. It will delegate to project(Object...) with the content of the list.

Parameters:

entries - A list of entries for the projection

Returns:

A map projection.

Since:

2021.0.0

project

@NotNull
@Contract(pure=true)
public @NotNull MapProjection project(Object... entries)

Creates a map projection based on this node. The node 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.

Since:

2021.0.0

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

asExpression

@NotNull
public @NotNull Expression asExpression()

Description copied from interface: IdentifiableElement

Transform this element into an expression

Specified by:

asExpression in interface IdentifiableElement

Returns:

this element as an expression. Will return the same instance if it is already an expression.