MappingContext (neo4j-ogm-core 2.1.0 API)

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, Mark Angrish

Constructor Summary

Constructors
Constructor and Description

MappingContext(MetaData metaData)

Constructors
Constructor and Description
`MappingContext(MetaData metaData)`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`addNodeEntity(Object entity, Long id)`
`void`	`addRelationship(MappedRelationship relationship)`
`Object`	`addRelationshipEntity(Object relationshipEntity, Long id)`
`void`	`clear()`
`boolean`	`containsRelationship(MappedRelationship relationship)`
`boolean`	`detachNodeEntity(Object id)`
`boolean`	`detachRelationshipEntity(Long id)`
`Collection<Object>`	`getEntities(Class<?> type)`
`Object`	`getNodeEntity(Object id)`
`Object`	`getRelationshipEntity(Long relationshipId)`
`Set<MappedRelationship>`	`getRelationships()`
`boolean`	`isDirty(Object entity)`
`LabelHistory`	`labelHistory(Long identity)`
`Set<Object>`	`neighbours(Object entity)`
`void`	`removeEntity(Object entity)` removes all information about this object from the mapping context
`void`	`removeNodeEntity(Object entity, Long id)` De-registers 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
`boolean`	`removeRelationship(MappedRelationship mappedRelationship)`
`void`	`removeType(Class<?> type)` purges all information about objects of the supplied type from the mapping context.
`void`	`replaceNodeEntity(Object entity, Long id)`
`void`	`replaceRelationshipEntity(Object entity, Long id)`
`void`	`reset(Object entity)` purges all information about this object from the mapping context and also sets its id to null.

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(Object id)
```
  - addNodeEntity
```
public Object addNodeEntity(Object entity,
                   Long id)
```
  - removeRelationship
```
public boolean removeRelationship(MappedRelationship mappedRelationship)
```
  - removeNodeEntity
```
public void removeNodeEntity(Object entity,
                    Long id)
```
    De-registers 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
  - replaceNodeEntity
```
public void replaceNodeEntity(Object entity,
                     Long id)
```
  - replaceRelationshipEntity
```
public void replaceRelationshipEntity(Object entity,
                             Long id)
```
  - getEntities
```
public Collection<Object> getEntities(Class<?> type)
```
  - labelHistory
```
public LabelHistory labelHistory(Long identity)
```
  - isDirty
```
public boolean isDirty(Object entity)
```
  - containsRelationship
```
public boolean containsRelationship(MappedRelationship relationship)
```
  - getRelationships
```
public Set<MappedRelationship> getRelationships()
```
  - addRelationship
```
public void addRelationship(MappedRelationship relationship)
```
  - clear
```
public void clear()
```
  - getRelationshipEntity
```
public Object getRelationshipEntity(Long relationshipId)
```
  - addRelationshipEntity
```
public Object addRelationshipEntity(Object relationshipEntity,
                           Long id)
```
  - removeType
```
public void removeType(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
  - detachNodeEntity
```
public boolean detachNodeEntity(Object id)
```
  - detachRelationshipEntity
```
public boolean detachRelationshipEntity(Long id)
```
  - removeEntity
```
public void removeEntity(Object entity)
```
    removes all information about this object from the mapping context
    
    Parameters:
    entity - the instance whose references and relationship mappings we want to purge
  - reset
```
public void reset(Object entity)
```
    purges all information about this object from the mapping context and also sets its id to null. Should be called for new objects that have had their id assigned as part of a long-running transaction, if that transaction is subsequently rolled back.
    
    Parameters:
    entity - the instance whose references and relationship mappings we want to reset
  - neighbours
```
public Set<Object> neighbours(Object entity)
```

Class MappingContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MappingContext

Method Detail

getNodeEntity

addNodeEntity

removeRelationship

removeNodeEntity

replaceNodeEntity

replaceRelationshipEntity

getEntities

labelHistory

isDirty

containsRelationship

getRelationships

addRelationship

clear

getRelationshipEntity

addRelationshipEntity

removeType

detachNodeEntity

detachRelationshipEntity

removeEntity

reset

neighbours