org.springframework.data.neo4j.core.schema

Enum CypherGenerator

java.lang.Object

java.lang.Enum<CypherGenerator>

org.springframework.data.neo4j.core.schema.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.Statement	createRelationshipCreationQuery(Neo4jPersistentEntity<?> neo4jPersistentEntity, RelationshipDescription relationship, String dynamicRelationshipType, Long relatedInternalId)
org.neo4j.cypherdsl.core.Statement	createRelationshipRemoveQuery(Neo4jPersistentEntity<?> neo4jPersistentEntity, RelationshipDescription relationshipDescription, Neo4jPersistentEntity relatedNode)
org.neo4j.cypherdsl.core.Statement	createRelationshipWithPropertiesCreationQuery(Neo4jPersistentEntity<?> neo4jPersistentEntity, RelationshipDescription relationship, Long relatedInternalId)
org.neo4j.cypherdsl.core.Expression	createReturnStatementForMatch(NodeDescription<?> nodeDescription)
org.neo4j.cypherdsl.core.Expression	createReturnStatementForMatch(NodeDescription<?> nodeDescription, List<String> inputProperties)
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(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.Statement	prepareSaveOf(NodeDescription<?> nodeDescription, UnaryOperator<org.neo4j.cypherdsl.core.StatementBuilder.OngoingMatchAndUpdate> updateDecorator)
org.neo4j.cypherdsl.core.Statement	prepareSaveOfMultipleInstancesOf(NodeDescription<?> nodeDescription)
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

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)

createRelationshipCreationQuery

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

createRelationshipWithPropertiesCreationQuery

@NonNull
public org.neo4j.cypherdsl.core.Statement createRelationshipWithPropertiesCreationQuery(Neo4jPersistentEntity<?> neo4jPersistentEntity,
                                                                                                 RelationshipDescription relationship,
                                                                                                 Long relatedInternalId)

createRelationshipRemoveQuery

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

createReturnStatementForMatch

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

createReturnStatementForMatch

public org.neo4j.cypherdsl.core.Expression createReturnStatementForMatch(NodeDescription<?> nodeDescription,
                                                                         @Nullable
                                                                         List<String> inputProperties)

Parameters:

nodeDescription - Description of the root node

inputProperties - A list of Java properties of the domain to be included. Those properties are compared with the field names of graph properties respectively relationships.

Returns:

An expresion to be returned by a Cypher statement