org.springframework.data.neo4j.core.mapping

Enum CypherGenerator

java.lang.Object

java.lang.Enum<CypherGenerator>

org.springframework.data.neo4j.core.mapping.CypherGenerator

All Implemented Interfaces:

Serializable, Comparable<CypherGenerator>

@API(status=INTERNAL,
     since="6.0")
public enum CypherGenerator
extends Enum<CypherGenerator>

A generator based on the schema defined by node and relationship descriptions. Most methods return renderable Cypher statements.

Since:

6.0

Author:

Michael J. Simons, Gerrit Meier, Philipp Tölle

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
org.neo4j.cypherdsl.core.Expression[]	createGenericReturnStatement()
String	createOrderByFragment(Sort sort) Creates an order by fragment, assuming the node to match is named `n`
org.neo4j.cypherdsl.core.Expression[]	createReturnStatementForMatch(NodeDescription<?> nodeDescription)
org.neo4j.cypherdsl.core.Expression[]	createReturnStatementForMatch(NodeDescription<?> nodeDescription, Predicate<String> includeField)
org.neo4j.cypherdsl.core.Node	createRootNode(NodeDescription<?> nodeDescription)
org.neo4j.cypherdsl.core.Statement	createStatementReturningDynamicLabels(NodeDescription<?> nodeDescription) Creates a statement that returns all labels of a node that are not part of a list parameter named Constants.NAME_OF_STATIC_LABELS_PARAM.
org.neo4j.cypherdsl.core.Statement	prepareDeleteOf(Neo4jPersistentEntity<?> neo4jPersistentEntity, RelationshipDescription relationshipDescription)
org.neo4j.cypherdsl.core.Statement	prepareDeleteOf(NodeDescription<?> nodeDescription)
org.neo4j.cypherdsl.core.Statement	prepareDeleteOf(NodeDescription<?> nodeDescription, org.neo4j.cypherdsl.core.Condition condition)
org.neo4j.cypherdsl.core.StatementBuilder.OrderableOngoingReadingAndWith	prepareMatchOf(NodeDescription<?> nodeDescription)
org.neo4j.cypherdsl.core.StatementBuilder.OrderableOngoingReadingAndWith	prepareMatchOf(NodeDescription<?> nodeDescription, org.neo4j.cypherdsl.core.Condition condition) This will create a match statement that fits the given node description and may contains additional conditions.
org.neo4j.cypherdsl.core.StatementBuilder.OngoingReading	prepareMatchOf(NodeDescription<?> nodeDescription, List<org.neo4j.cypherdsl.core.PatternElement> initialMatchOn, org.neo4j.cypherdsl.core.Condition condition)
org.neo4j.cypherdsl.core.StatementBuilder.OngoingReading	prepareMatchOf(NodeDescription<?> nodeDescription, RelationshipDescription relationshipDescription, List<org.neo4j.cypherdsl.core.PatternElement> initialMatchOn, org.neo4j.cypherdsl.core.Condition condition)
org.neo4j.cypherdsl.core.Statement	prepareSaveOf(NodeDescription<?> nodeDescription, UnaryOperator<org.neo4j.cypherdsl.core.StatementBuilder.OngoingMatchAndUpdate> updateDecorator)
org.neo4j.cypherdsl.core.Statement	prepareSaveOfMultipleInstancesOf(NodeDescription<?> nodeDescription)
org.neo4j.cypherdsl.core.Statement	prepareSaveOfRelationship(Neo4jPersistentEntity<?> neo4jPersistentEntity, RelationshipDescription relationship, String dynamicRelationshipType)
org.neo4j.cypherdsl.core.Statement	prepareSaveOfRelationshipWithProperties(Neo4jPersistentEntity<?> neo4jPersistentEntity, RelationshipDescription relationship, boolean isNew, String dynamicRelationshipType)
static CypherGenerator	valueOf(String name) Returns the enum constant of this type with the specified name.
static CypherGenerator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final CypherGenerator INSTANCE

Method Detail

values

public static CypherGenerator[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CypherGenerator c : CypherGenerator.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CypherGenerator valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

prepareMatchOf

public org.neo4j.cypherdsl.core.StatementBuilder.OrderableOngoingReadingAndWith prepareMatchOf(NodeDescription<?> nodeDescription)

Parameters:

nodeDescription - The node description for which a match clause should be generated

Returns:

An ongoing match

See Also:

prepareMatchOf(NodeDescription, Condition)

prepareMatchOf

public org.neo4j.cypherdsl.core.StatementBuilder.OrderableOngoingReadingAndWith prepareMatchOf(NodeDescription<?> nodeDescription,
                                                                                               @Nullable
                                                                                               org.neo4j.cypherdsl.core.Condition condition)

This will create a match statement that fits the given node description and may contains additional conditions. The WITH clause of this statement contains all nodes and relationships necessary to map a record to the given nodeDescription.

It is recommended to use Cypher.asterisk() to return everything from the query in the end.

The root node is guaranteed to have the symbolic name n.

Parameters:

nodeDescription - The node description for which a match clause should be generated

condition - Optional conditions to add

Returns:

An ongoing match

prepareMatchOf

public org.neo4j.cypherdsl.core.StatementBuilder.OngoingReading prepareMatchOf(NodeDescription<?> nodeDescription,
                                                                               @Nullable
                                                                               List<org.neo4j.cypherdsl.core.PatternElement> initialMatchOn,
                                                                               @Nullable
                                                                               org.neo4j.cypherdsl.core.Condition condition)

prepareMatchOf

public org.neo4j.cypherdsl.core.StatementBuilder.OngoingReading prepareMatchOf(NodeDescription<?> nodeDescription,
                                                                               RelationshipDescription relationshipDescription,
                                                                               @Nullable
                                                                               List<org.neo4j.cypherdsl.core.PatternElement> initialMatchOn,
                                                                               @Nullable
                                                                               org.neo4j.cypherdsl.core.Condition condition)

createRootNode

@NonNull
public org.neo4j.cypherdsl.core.Node createRootNode(NodeDescription<?> nodeDescription)

createStatementReturningDynamicLabels

public org.neo4j.cypherdsl.core.Statement createStatementReturningDynamicLabels(NodeDescription<?> nodeDescription)

Creates a statement that returns all labels of a node that are not part of a list parameter named Constants.NAME_OF_STATIC_LABELS_PARAM. Those are the "dynamic labels" of a node as set through SDN.

Parameters:

nodeDescription - The node description for which the statement should be generated

Returns:

A statement having one parameter.

Since:

6.0

prepareDeleteOf

public org.neo4j.cypherdsl.core.Statement prepareDeleteOf(NodeDescription<?> nodeDescription)

prepareDeleteOf

public org.neo4j.cypherdsl.core.Statement prepareDeleteOf(NodeDescription<?> nodeDescription,
                                                          @Nullable
                                                          org.neo4j.cypherdsl.core.Condition condition)

prepareSaveOf

public org.neo4j.cypherdsl.core.Statement prepareSaveOf(NodeDescription<?> nodeDescription,
                                                        UnaryOperator<org.neo4j.cypherdsl.core.StatementBuilder.OngoingMatchAndUpdate> updateDecorator)

prepareSaveOfMultipleInstancesOf

public org.neo4j.cypherdsl.core.Statement prepareSaveOfMultipleInstancesOf(NodeDescription<?> nodeDescription)

prepareSaveOfRelationship

@NonNull
public org.neo4j.cypherdsl.core.Statement prepareSaveOfRelationship(Neo4jPersistentEntity<?> neo4jPersistentEntity,
                                                                             RelationshipDescription relationship,
                                                                             @Nullable
                                                                             String dynamicRelationshipType)

prepareSaveOfRelationshipWithProperties

@NonNull
public org.neo4j.cypherdsl.core.Statement prepareSaveOfRelationshipWithProperties(Neo4jPersistentEntity<?> neo4jPersistentEntity,
                                                                                           RelationshipDescription relationship,
                                                                                           boolean isNew,
                                                                                           @Nullable
                                                                                           String dynamicRelationshipType)

prepareDeleteOf

@NonNull
public org.neo4j.cypherdsl.core.Statement prepareDeleteOf(Neo4jPersistentEntity<?> neo4jPersistentEntity,
                                                                   RelationshipDescription relationshipDescription)

createReturnStatementForMatch

public org.neo4j.cypherdsl.core.Expression[] createReturnStatementForMatch(NodeDescription<?> nodeDescription)

createOrderByFragment

@Nullable
public String createOrderByFragment(@Nullable
                                              Sort sort)

Creates an order by fragment, assuming the node to match is named `n`

Parameters:

sort - The sort that should be turned into a valid Cypher ORDER-clause

Returns:

An optional order clause. Will be null on sorts that are null or a unsorted.

createReturnStatementForMatch

public org.neo4j.cypherdsl.core.Expression[] createReturnStatementForMatch(NodeDescription<?> nodeDescription,
                                                                           Predicate<String> includeField)

Parameters:

nodeDescription - Description of the root node

includeField - A predicate derived from the set of included properties. This is only relevant in various forms of projections which allow to exclude one or more fields.

Returns:

An expresion to be returned by a Cypher statement

createGenericReturnStatement

public org.neo4j.cypherdsl.core.Expression[] createGenericReturnStatement()