org.neo4j.ogm.cypher.compiler

Class CypherContext

java.lang.Object

org.neo4j.ogm.cypher.compiler.CypherContext

public class CypherContext
extends Object

Maintains contextual information throughout the process of compiling Cypher statements to persist a graph of objects.

Author:

Mark Angrish, Vince Bickers, Luanne Misquitta

Constructor Summary

Constructors

Constructor and Description
CypherContext()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deregisterIncomingRelationships(Long tgt, String relationshipType, Class endNodeType, boolean relationshipEntity) Invoked when the mapper wishes to mark a set of incoming relationships to a specific type like (a)<-[:T]-(*) as deleted, prior to possibly re-establishing them individually as it traverses the entity graph.
boolean	deregisterOutgoingRelationships(Long src, String relationshipType, Class endNodeType) Invoked when the mapper wishes to mark a set of outgoing relationships to a specific type like (a)-[:T]->(*) as deleted, prior to possibly re-establishing them individually as it traverses the entity graph.
Object	getNewObject(String cypherName)
List<ParameterisedStatement>	getStatements()
boolean	isRegisteredRelationship(MappedRelationship mappedRelationship)
Collection<Object>	log()
void	log(Object object)
NodeBuilder	nodeBuilder(Object obj)
Collection<MappedRelationship>	registeredRelationships()
void	registerNewObject(String cypherName, Object toPersist)
void	registerRelationship(MappedRelationship mappedRelationship)
boolean	removeRegisteredRelationship(MappedRelationship mappedRelationship)
void	setStatements(List<ParameterisedStatement> statements)
void	visit(Object toPersist, NodeBuilder nodeBuilder)
boolean	visited(Object obj)
boolean	visitedRelationshipEntity(Object relationshipEntity)
void	visitRelationshipEntity(Object relationshipEntity)

Methods inherited from class java.lang.Object

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

Constructor Detail

CypherContext

public CypherContext()

Method Detail

visited

public boolean visited(Object obj)

visit

public void visit(Object toPersist,
         NodeBuilder nodeBuilder)

registerRelationship

public void registerRelationship(MappedRelationship mappedRelationship)

removeRegisteredRelationship

public boolean removeRegisteredRelationship(MappedRelationship mappedRelationship)

nodeBuilder

public NodeBuilder nodeBuilder(Object obj)

isRegisteredRelationship

public boolean isRegisteredRelationship(MappedRelationship mappedRelationship)

setStatements

public void setStatements(List<ParameterisedStatement> statements)

getStatements

public List<ParameterisedStatement> getStatements()

registerNewObject

public void registerNewObject(String cypherName,
                     Object toPersist)

getNewObject

public Object getNewObject(String cypherName)

registeredRelationships

public Collection<MappedRelationship> registeredRelationships()

log

public void log(Object object)

log

public Collection<Object> log()

deregisterOutgoingRelationships

public boolean deregisterOutgoingRelationships(Long src,
                                      String relationshipType,
                                      Class endNodeType)

Invoked when the mapper wishes to mark a set of outgoing relationships to a specific type like (a)-[:T]->(*) as deleted, prior to possibly re-establishing them individually as it traverses the entity graph. There are two reasons why a set of relationships might not be be able to be marked deleted: 1) the request to mark them as deleted has already been made 2) the relationship is not persisted in the graph (i.e. its a new relationship) Only case 1) is considered to be a failed request, because this context is only concerned about pre-existing relationships in the graph. In order to distinguish between the two cases, we also maintain a list of successfully deleted relationships, so that if we try to delete an already-deleted set of relationships we can signal the error and undelete it.

Parameters:

src - the identity of the node at the start of the relationship

relationshipType - the type of the relationship

endNodeType - the class type of the entity at the end of the relationship

Returns:

true if the relationship was deleted or doesn't exist in the graph, false otherwise

deregisterIncomingRelationships

public boolean deregisterIncomingRelationships(Long tgt,
                                      String relationshipType,
                                      Class endNodeType,
                                      boolean relationshipEntity)

Invoked when the mapper wishes to mark a set of incoming relationships to a specific type like (a)<-[:T]-(*) as deleted, prior to possibly re-establishing them individually as it traverses the entity graph. There are two reasons why a set of relationships might not be be able to be marked deleted: 1) the request to mark them as deleted has already been made 2) the relationship is not persisted in the graph (i.e. its a new relationship) Only case 1) is considered to be a failed request, because this context is only concerned about pre-existing relationships in the graph. In order to distinguish between the two cases, we also maintain a list of successfully deleted relationships, so that ff we try to delete an already-deleted set of relationships we can signal the error and undelete it.

Parameters:

tgt - the identity of the node at the pointy end of the relationship

relationshipType - the type of the relationship

endNodeType - the class type of the entity at the other end of the relationship

Returns:

true if the relationship was deleted or doesn't exist in the graph, false otherwise

visitRelationshipEntity

public void visitRelationshipEntity(Object relationshipEntity)

visitedRelationshipEntity

public boolean visitedRelationshipEntity(Object relationshipEntity)