org.neo4j.ogm.cypher.compiler

Class SingleStatementCypherCompiler

java.lang.Object

org.neo4j.ogm.cypher.compiler.SingleStatementCypherCompiler

All Implemented Interfaces:

CypherCompiler

public class SingleStatementCypherCompiler
extends Object
implements CypherCompiler

Implementation of CypherCompiler that builds a single query for the object graph.

Author:

Vince Bickers

Constructor Summary

Constructors

Constructor and Description
SingleStatementCypherCompiler()

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.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SingleStatementCypherCompiler

public SingleStatementCypherCompiler()

Method Detail

relate

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

Deprecated.

Description copied from interface: CypherCompiler

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

Specified by:

relate in interface CypherCompiler

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

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

Description copied from interface: CypherCompiler

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

Specified by:

unrelate in interface CypherCompiler

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

public NodeBuilder newNode()

Description copied from interface: CypherCompiler

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

Specified by:

newNode in interface CypherCompiler

Returns:

A NodeBuilder representing a new node

existingNode

public NodeBuilder existingNode(Long existingNodeId)

Description copied from interface: CypherCompiler

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

Specified by:

existingNode in interface CypherCompiler

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

public RelationshipBuilder newRelationship()

Description copied from interface: CypherCompiler

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

Specified by:

newRelationship in interface CypherCompiler

Returns:

A new RelationshipBuilder

newBiDirectionalRelationship

public RelationshipBuilder newBiDirectionalRelationship()

Description copied from interface: CypherCompiler

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

Specified by:

newBiDirectionalRelationship in interface CypherCompiler

Returns:

A new RelationshipBuilder

existingRelationship

public RelationshipBuilder existingRelationship(Long existingRelationshipId)

Description copied from interface: CypherCompiler

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

Specified by:

existingRelationship in interface CypherCompiler

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

public List<ParameterisedStatement> getStatements()

Description copied from interface: CypherCompiler

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.

Specified by:

getStatements in interface CypherCompiler

Returns:

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

context

public CypherContext context()

Description copied from interface: CypherCompiler

Returns this compiler's context

Specified by:

context in interface CypherCompiler

Returns:

the current compiler context

compile

public CypherContext compile()

Description copied from interface: CypherCompiler

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

Specified by:

compile in interface CypherCompiler

Returns:

the current compiler context

release

public void release(RelationshipBuilder relationshipBuilder)

Description copied from interface: CypherCompiler

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

Specified by:

release in interface CypherCompiler

Parameters:

relationshipBuilder - the RelationshipBuilder

nextIdentifier

public String nextIdentifier()

Specified by:

nextIdentifier in interface CypherCompiler