org.neo4j.ogm.context

Class MappingContext

java.lang.Object

org.neo4j.ogm.context.MappingContext

public class MappingContext
extends Object

The MappingContext maintains a map of all the objects created during the hydration of an object map (domain hierarchy). The MappingContext lifetime is concurrent with a session lifetime.

Author:

Vince Bickers, Luanne Misquitta

Constructor Summary

Constructors

Constructor and Description
MappingContext(MetaData metaData)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
void	clear(Class<?> type) purges all information about objects of the supplied type from the mapping context.
void	clear(Object entity) purges all information about this object from the mapping context
void	deregister(Object entity, Long id) Deregisters an object from the mapping context - removes the object instance from the typeRegister(s) - removes the object id from the nodeEntityRegister - removes any relationship entities from relationshipEntityRegister if they have this object either as start or end node
Map<Long,Object>	getAll(Class<?> type)
Object	getNodeEntity(Long id)
Object	getRelationshipEntity(Long relationshipId)
boolean	isDirty(Object entity)
boolean	isRegisteredRelationship(MappedRelationship relationship)
Set<MappedRelationship>	mappedRelationships()
Object	registerNodeEntity(Object entity, Long id)
void	registerRelationship(MappedRelationship relationship)
Object	registerRelationshipEntity(Object relationshipEntity, Long id)
void	remember(Object entity)
void	replace(Object entity, Long id)

Methods inherited from class java.lang.Object

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

Constructor Detail

MappingContext

public MappingContext(MetaData metaData)

Method Detail

getNodeEntity

public Object getNodeEntity(Long id)

registerNodeEntity

public Object registerNodeEntity(Object entity,
                        Long id)

deregister

public void deregister(Object entity,
              Long id)

Deregisters an object from the mapping context - removes the object instance from the typeRegister(s) - removes the object id from the nodeEntityRegister - removes any relationship entities from relationshipEntityRegister if they have this object either as start or end node

Parameters:

entity - the object to deregister

id - the id of the object in Neo4j

replace

public void replace(Object entity,
           Long id)

getAll

public Map<Long,Object> getAll(Class<?> type)

remember

public void remember(Object entity)

isDirty

public boolean isDirty(Object entity)

isRegisteredRelationship

public boolean isRegisteredRelationship(MappedRelationship relationship)

mappedRelationships

public Set<MappedRelationship> mappedRelationships()

registerRelationship

public void registerRelationship(MappedRelationship relationship)

clear

public void clear()

getRelationshipEntity

public Object getRelationshipEntity(Long relationshipId)

registerRelationshipEntity

public Object registerRelationshipEntity(Object relationshipEntity,
                                Long id)

clear

public void clear(Class<?> type)

purges all information about objects of the supplied type from the mapping context. If the type is an interface, purges all implementing classes in the interface hierarchy

Parameters:

type - the type whose object references and relationship mappings we want to purge

clear

public void clear(Object entity)

purges all information about this object from the mapping context

Parameters:

entity - the type whose object references and relationship mappings we want to purge