org.hibernate.ogm.datastore.neo4j

Class EmbeddedNeo4jDialect

java.lang.Object

org.hibernate.ogm.dialect.spi.BaseGridDialect

org.hibernate.ogm.datastore.neo4j.BaseNeo4jDialect<org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jEntityQueries,org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jAssociationQueries>

org.hibernate.ogm.datastore.neo4j.EmbeddedNeo4jDialect

All Implemented Interfaces:

Serializable, MultigetGridDialect, QueryableGridDialect<String>, GridDialect, SessionFactoryLifecycleAwareDialect, Service, ServiceRegistryAwareService

Direct Known Subclasses:

Neo4jDialect

public class EmbeddedNeo4jDialect
extends BaseNeo4jDialect<org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jEntityQueries,org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jAssociationQueries>

Abstracts Hibernate OGM from Neo4j.

A Tuple is saved as a Node where the columns are converted into properties of the node.
An Association is converted into a Relationship identified by the AssociationKey and the RowKey. The type of the relationship is the value returned by AssociationKeyMetadata.getCollectionRole().

If the value of a property is set to null the property will be removed (Neo4j does not allow to store null values).

Author:

Davide D'Alto <davide@hibernate.org>

See Also:

Serialized Form

Field Summary

Fields inherited from class org.hibernate.ogm.datastore.neo4j.BaseNeo4jDialect

CONSTRAINT_VIOLATION_CODE, TUPLE_ALREADY_EXISTS_EXCEPTION_PATTERN

Constructor Summary

Constructors

Constructor and Description
EmbeddedNeo4jDialect(org.hibernate.ogm.datastore.neo4j.embedded.impl.EmbeddedNeo4jDatastoreProvider provider)

Method Summary

Modifier and Type	Method and Description
protected org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jAssociationQueries	createNeo4jAssociationQueries(EntityKeyMetadata ownerEntityKeyMetadata, AssociationKeyMetadata associationKeyMetadata)
protected org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jEntityQueries	createNeo4jEntityQueries(EntityKeyMetadata entityKeyMetadata, TupleTypeContext tupleTypeContext)
Tuple	createTuple(EntityKey key, OperationContext tupleContext) Creates a new tuple for the given entity key.
protected EntityKeyMetadata	entityKeyMetadata(EntityKeyMetadata keyMetadata, TupleTypeContext tupleTypeContext)
ClosableIterator<Tuple>	executeBackendQuery(BackendQuery<String> backendQuery, QueryParameters queryParameters, TupleContext tupleContext) Returns the result of a native query executed on the backend.
int	executeBackendUpdateQuery(BackendQuery<String> backendQuery, QueryParameters queryParameters, TupleContext tupleContext) Returns the result of a native update query executed on the backend.
void	forEachTuple(ModelConsumer consumer, TupleTypeContext tupleTypeContext, EntityKeyMetadata entityKeyMetadata) A consumer is called for each tuple matching the selected EntityKeyMetadata.
Association	getAssociation(AssociationKey associationKey, AssociationContext associationContext) Return the list of tuples corresponding to a given association and the given context
Tuple	getTuple(EntityKey key, OperationContext context) Return the tuple with the given column for a given key
List<Tuple>	getTuples(EntityKey[] keys, TupleContext tupleContext) Return the list of tuples with the given columns for a given list of keys.
void	insertOrUpdateAssociation(AssociationKey key, Association association, AssociationContext associationContext) Inserts or updates the given association in the datastore.
void	insertOrUpdateTuple(EntityKey key, org.hibernate.ogm.entityentry.impl.TuplePointer tuplePointer, TupleContext tupleContext) Inserts or updates the tuple corresponding to the given entity key.
Number	nextValue(NextValueRequest request) Returns the next value from the specified id generator with the specified increment.
String	parseNativeQuery(String nativeQuery) Parses the given native query into a representation executable by this dialect.
void	removeAssociation(AssociationKey key, AssociationContext associationContext) Remove the list of tuples corresponding to a given association
void	removeTuple(EntityKey key, TupleContext tupleContext) Remove the tuple for a given key

Methods inherited from class org.hibernate.ogm.datastore.neo4j.BaseNeo4jDialect

buildNativeQuery, convert, createAssociation, entityKeyMetadata, getAssociationQueries, getDuplicateInsertPreventionStrategy, getEntityKey, getEntityQueries, getEntityQueries, getParameterMetadataBuilder, getParameters, getServiceRegistry, initializeAssociationQueries, injectServices, isPartOfRegularEmbedded, isStoredInEntityStructure, overrideType, sessionFactoryCreated, supportsSequences, usesNavigationalInformationForInverseSideOfAssociations

Methods inherited from class org.hibernate.ogm.dialect.spi.BaseGridDialect

getLockingStrategy, isInTheInsertionQueue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.ogm.dialect.spi.GridDialect

getLockingStrategy

Constructor Detail

EmbeddedNeo4jDialect

public EmbeddedNeo4jDialect(org.hibernate.ogm.datastore.neo4j.embedded.impl.EmbeddedNeo4jDatastoreProvider provider)

Method Detail

createNeo4jAssociationQueries

protected org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jAssociationQueries createNeo4jAssociationQueries(EntityKeyMetadata ownerEntityKeyMetadata,
                                                                                                                                AssociationKeyMetadata associationKeyMetadata)

Specified by:

createNeo4jAssociationQueries in class BaseNeo4jDialect<org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jEntityQueries,org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jAssociationQueries>

createNeo4jEntityQueries

protected org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jEntityQueries createNeo4jEntityQueries(EntityKeyMetadata entityKeyMetadata,
                                                                                                                      TupleTypeContext tupleTypeContext)

Specified by:

createNeo4jEntityQueries in class BaseNeo4jDialect<org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jEntityQueries,org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jAssociationQueries>

getTuple

public Tuple getTuple(EntityKey key,
                      OperationContext context)

Description copied from interface: GridDialect

Return the tuple with the given column for a given key

Parameters:

key - The tuple identifier

context - Contains additional information that might be used to create the tuple

Returns:

the tuple identified by the key

getTuples

public List<Tuple> getTuples(EntityKey[] keys,
                             TupleContext tupleContext)

Description copied from interface: MultigetGridDialect

Return the list of tuples with the given columns for a given list of keys. The tuples must be returned in the same order as the keys. If a key has no matching record, set null to the list entry.

All the keys provided will have the same EntityKeyMetadata. In other words they target the same "table".

Parameters:

keys - The array of tuple identifier

tupleContext - Contains additional information that might be used to create the tuples

Returns:

the list of tuples identified by the keys

createTuple

public Tuple createTuple(EntityKey key,
                         OperationContext tupleContext)

Description copied from interface: GridDialect

Creates a new tuple for the given entity key.

Only invoked if no tuple is present yet for the given key. Implementations should not perform a round-trip to the datastore but rather return a transient instance. The OGM engine will invoke GridDialect.insertOrUpdateTuple(EntityKey, TuplePointer, TupleContext) subsequently.

Columns in the tuple may represent properties of the corresponding entity as well as *-to-one associations to other entities. Implementations may choose to persist the latter e.g. in form of fields or as actual links/relationships to the element representing the associated entity. In case of multi-column keys, the corresponding association role for a given column can be obtained from the passed tuple context.

Specified by:

createTuple in interface GridDialect

Overrides:

createTuple in class BaseNeo4jDialect<org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jEntityQueries,org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jAssociationQueries>

Parameters:

key - The tuple identifier

tupleContext - Contains additional information that might be used to create the tuple

Returns:

the created tuple

insertOrUpdateTuple

public void insertOrUpdateTuple(EntityKey key,
                                org.hibernate.ogm.entityentry.impl.TuplePointer tuplePointer,
                                TupleContext tupleContext)

Description copied from interface: GridDialect

Inserts or updates the tuple corresponding to the given entity key.

Parameters:

key - The tuple identifier

tuplePointer - A pointer to the list of operations to execute

tupleContext - Contains additional information that might be used to create or update the tuple

removeTuple

public void removeTuple(EntityKey key,
                        TupleContext tupleContext)

Description copied from interface: GridDialect

Remove the tuple for a given key

Parameters:

key - The tuple identifier

tupleContext - Contains additional information that might be used to remove the tuple

entityKeyMetadata

protected EntityKeyMetadata entityKeyMetadata(EntityKeyMetadata keyMetadata,
                                              TupleTypeContext tupleTypeContext)

Overrides:

entityKeyMetadata in class BaseNeo4jDialect<org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jEntityQueries,org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jAssociationQueries>

getAssociation

public Association getAssociation(AssociationKey associationKey,
                                  AssociationContext associationContext)

Description copied from interface: GridDialect

Return the list of tuples corresponding to a given association and the given context

Parameters:

associationKey - Identifies the association

associationContext - Contains additional information that might be used to get the association

Returns:

a list of tuples

insertOrUpdateAssociation

public void insertOrUpdateAssociation(AssociationKey key,
                                      Association association,
                                      AssociationContext associationContext)

Description copied from interface: GridDialect

Inserts or updates the given association in the datastore.

Parameters:

key - Identifies the association

association - The list of operations to execute

associationContext - Contains additional information that might be used to create the association

removeAssociation

public void removeAssociation(AssociationKey key,
                              AssociationContext associationContext)

Description copied from interface: GridDialect

Remove the list of tuples corresponding to a given association

Parameters:

key - Identifies the association

associationContext - Contains additional information that might be used to remove an association

forEachTuple

public void forEachTuple(ModelConsumer consumer,
                         TupleTypeContext tupleTypeContext,
                         EntityKeyMetadata entityKeyMetadata)

Description copied from interface: GridDialect

A consumer is called for each tuple matching the selected EntityKeyMetadata. The tuples must be of the same indexed type.

Parameters:

consumer - the instance that is going to be called for every Tuple

tupleTypeContext - contains additional information that might be used to build the tuple

entityKeyMetadata - the key metadata of the table for which we want to apply the consumer

nextValue

public Number nextValue(NextValueRequest request)

Description copied from interface: GridDialect

Returns the next value from the specified id generator with the specified increment.

Parameters:

request - Identifies a specific id generator

Returns:

the next value from the specified id generator

executeBackendQuery

public ClosableIterator<Tuple> executeBackendQuery(BackendQuery<String> backendQuery,
                                                   QueryParameters queryParameters,
                                                   TupleContext tupleContext)

Description copied from interface: QueryableGridDialect

Returns the result of a native query executed on the backend.

Parameters:

backendQuery - the query to execute in a representation understood by the underlying datastore. May have been created by converting a JP-QL query or from a (named) native query.

queryParameters - parameters passed for this query

tupleContext - the tuple context

Returns:

an ClosableIterator with the result of the query

executeBackendUpdateQuery

public int executeBackendUpdateQuery(BackendQuery<String> backendQuery,
                                     QueryParameters queryParameters,
                                     TupleContext tupleContext)

Description copied from interface: QueryableGridDialect

Returns the result of a native update query executed on the backend.

Precise semantics of an update are subject to design choices made for the actual database system in the backend. In particular, it may implement non-classical notions of consistency such as eventual consistency (rather than (conflict) serializablity as in most relational SQL database systems).

Specified by:

executeBackendUpdateQuery in interface QueryableGridDialect<String>

Overrides:

executeBackendUpdateQuery in class BaseNeo4jDialect<org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jEntityQueries,org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jAssociationQueries>

Parameters:

backendQuery - the query to execute in a representation understood by the underlying datastore. May have been created by converting a JP-QL query or from a (named) native query.

queryParameters - parameters passed for this query

tupleContext - the tuple context

Returns:

the number of elements that have been updated.

parseNativeQuery

public String parseNativeQuery(String nativeQuery)

Description copied from interface: QueryableGridDialect

Parses the given native query into a representation executable by this dialect.

Specified by:

parseNativeQuery in interface QueryableGridDialect<String>

Overrides:

parseNativeQuery in class BaseNeo4jDialect<org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jEntityQueries,org.hibernate.ogm.datastore.neo4j.embedded.dialect.impl.EmbeddedNeo4jAssociationQueries>

Parameters:

nativeQuery - the native query to parse

Returns:

the parsed query