org.neo4j.ogm.context

Class EntityGraphMapper

java.lang.Object

org.neo4j.ogm.context.EntityGraphMapper

All Implemented Interfaces:

EntityMapper

public class EntityGraphMapper
extends Object
implements EntityMapper

Implementation of EntityMapper that is driven by an instance of MetaData.

Author:

Vince Bickers, Luanne Misquitta, Mark Angrish, Michael J. Simons

Constructor Summary

Constructors

Constructor and Description
EntityGraphMapper(MetaData metaData, MappingContext mappingContext) Constructs a new EntityGraphMapper that uses the given MetaData.

Method Summary

Modifier and Type	Method and Description
void	addWriteProtection(BiFunction<WriteProtectionTarget,Class<?>,Predicate<Object>> writeProtectionSupplier)
CompileContext	compileContext() Returns compile context after multiple EntityMapper.map(Object) operations were called
CompileContext	map(Object entity) Processes the given object and any of its composite persistent objects and produces Cypher queries to persist their state in Neo4j.
CompileContext	map(Object entity, int horizon) Processes the given object and any of its composite persistent objects to the specified depth and produces Cypher queries to persist their state in Neo4j.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityGraphMapper

public EntityGraphMapper(MetaData metaData,
                         MappingContext mappingContext)

Constructs a new EntityGraphMapper that uses the given MetaData.

Parameters:

metaData - The MetaData containing the mapping information

mappingContext - The MappingContext for the current session

Method Detail

addWriteProtection

public void addWriteProtection(BiFunction<WriteProtectionTarget,Class<?>,Predicate<Object>> writeProtectionSupplier)

map

public CompileContext map(Object entity)

Description copied from interface: EntityMapper

Processes the given object and any of its composite persistent objects and produces Cypher queries to persist their state in Neo4j. NOTE: multiple map calls from same EntityMapper instance return same CompileContext with accumulated results. You can also use EntityMapper.compileContext() to get final CompileContext.

Specified by:

map in interface EntityMapper

Parameters:

entity - The "root" node of the object graph to persist

Returns:

A CompileContext object containing the statements required to persist the given object to Neo4j, along with a representation of the changes to be made by the Cypher statements never null

map

public CompileContext map(Object entity,
                          int horizon)

Description copied from interface: EntityMapper

Processes the given object and any of its composite persistent objects to the specified depth and produces Cypher queries to persist their state in Neo4j. NOTE: multiple map calls from same EntityMapper instance return same CompileContext with accumulated results. You can also use EntityMapper.compileContext() to get final CompileContext.

Specified by:

map in interface EntityMapper

Parameters:

entity - The "root" node of the object graph to persist

horizon - The number of objects away from the "root" to traverse when looking for objects to map

Returns:

A CompileContext object containing the statements required to persist the given object to Neo4j, along with a representation of the changes to be made by the Cypher statements never null

compileContext

public CompileContext compileContext()

Description copied from interface: EntityMapper

Returns compile context after multiple EntityMapper.map(Object) operations were called

Specified by:

compileContext in interface EntityMapper

Returns:

CompileContext