org.neo4j.ogm.cypher.compiler

Interface CypherCompiler

All Known Implementing Classes:

SingleStatementCypherCompiler

public interface CypherCompiler

Defines a simple API for building up Cypher queries programmatically.

Author:

Vince Bickers, Luanne Misquitta

Method Summary

Methods

Modifier and Type	Method and Description
CypherContext	compile() Compiles the current request and returns the compile context, which includes all the statements to be executed and related information
CypherContext	context() Returns this compiler's context
NodeBuilder	existingNode(Long existingNodeId) Returns a NodeBuilder that represents a node that already exists in the database and matches the given ID.
RelationshipBuilder	existingRelationship(Long existingRelationshipId) Returns a RelationshipBuilder to use for constructing Cypher to update an existing relationship in the database that possesses the given ID.
List<ParameterisedStatement>	getStatements() Retrieves the Cypher queries that have been built up through this CypherCompiler.
RelationshipBuilder	newBiDirectionalRelationship() Returns a RelationshipBuilder to use for constructing Cypher for writing a new directed relationship in both directions to the database.
NodeBuilder	newNode() Returns NodeBuilder that represents a new node to be created in the database.
RelationshipBuilder	newRelationship() Returns a RelationshipBuilder to use for constructing Cypher for writing a new relationship to the database.
String	nextIdentifier()
void	relate(String startNode, String relationshipType, Map<String,Object> relationshipProperties, String endNode) Deprecated. Setting relationships should now be done through the RelationshipBuilder
void	release(RelationshipBuilder relationshipBuilder) Returns an unused relationship's reference to the ref pool This is to ensure that references are only created when needed
void	unrelate(String startNode, String relationshipType, String endNode, Long relId) Defines a relationship deletion between the specified start node to end node with the given relationship type and direction.

Method Detail

relate

@Deprecated
void relate(String startNode,
                     String relationshipType,
                     Map<String,Object> relationshipProperties,
                     String endNode)

Deprecated. Setting relationships should now be done through the RelationshipBuilder

Defines a new relationship between the specified start node to end node with the given relationship type and direction

Parameters:

startNode - The NodeBuilder representation of the relationship start node

relationshipType - The type of relationship to create between the nodes

relationshipProperties - The (optional) Map containing the properties of the relationship

endNode - The NodeBuilder representation of the relationship end node

unrelate

void unrelate(String startNode,
            String relationshipType,
            String endNode,
            Long relId)

Defines a relationship deletion between the specified start node to end node with the given relationship type and direction.

Parameters:

startNode - The NodeBuilder representation of the relationship start node

relationshipType - The type of relationship between the nodes to delete

endNode - The NodeBuilder representation of the relationship end node

relId - The id of the relationship to unrelate

newNode

NodeBuilder newNode()

Returns NodeBuilder that represents a new node to be created in the database.

Returns:

A NodeBuilder representing a new node

existingNode

NodeBuilder existingNode(Long existingNodeId)

Returns a NodeBuilder that represents a node that already exists in the database and matches the given ID.

Parameters:

existingNodeId - The ID of the node in the database

Returns:

A NodeBuilder representing the node in the database that corresponds to the given ID

newRelationship

RelationshipBuilder newRelationship()

Returns a RelationshipBuilder to use for constructing Cypher for writing a new relationship to the database.

Returns:

A new RelationshipBuilder

newBiDirectionalRelationship

RelationshipBuilder newBiDirectionalRelationship()

Returns a RelationshipBuilder to use for constructing Cypher for writing a new directed relationship in both directions to the database.

Returns:

A new RelationshipBuilder

existingRelationship

RelationshipBuilder existingRelationship(Long existingRelationshipId)

Returns a RelationshipBuilder to use for constructing Cypher to update an existing relationship in the database that possesses the given ID.

Parameters:

existingRelationshipId - The ID of the relationship in the database, which shouldn't be null

Returns:

A new RelationshipBuilder bound to the identified relationship

getStatements

List<ParameterisedStatement> getStatements()

Retrieves the Cypher queries that have been built up through this CypherCompiler.

Please node that there is no requirement that implementations of CypherCompiler provide an idempotent or even deterministic implementation of this method. Therefore, it's recommended to only call this method once after all query building has been completed.

Returns:

A List of Cypher queries to be executed or an empty list if there aren't any, never null

release

void release(RelationshipBuilder relationshipBuilder)

Returns an unused relationship's reference to the ref pool This is to ensure that references are only created when needed

Parameters:

relationshipBuilder - the RelationshipBuilder

nextIdentifier

String nextIdentifier()

context

CypherContext context()

Returns this compiler's context

Returns:

the current compiler context

compile

CypherContext compile()

Compiles the current request and returns the compile context, which includes all the statements to be executed and related information

Returns:

the current compiler context