org.hibernate.ogm.datastore.neo4j

Class BaseNeo4jDialect<E extends org.hibernate.ogm.datastore.neo4j.dialect.impl.BaseNeo4jEntityQueries,A extends org.hibernate.ogm.datastore.neo4j.dialect.impl.BaseNeo4jAssociationQueries>

java.lang.Object

org.hibernate.ogm.dialect.spi.BaseGridDialect

org.hibernate.ogm.datastore.neo4j.BaseNeo4jDialect<E,A>

All Implemented Interfaces:

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

Direct Known Subclasses:

BoltNeo4jDialect, EmbeddedNeo4jDialect, HttpNeo4jDialect

public abstract class BaseNeo4jDialect<E extends org.hibernate.ogm.datastore.neo4j.dialect.impl.BaseNeo4jEntityQueries,A extends org.hibernate.ogm.datastore.neo4j.dialect.impl.BaseNeo4jAssociationQueries>
extends BaseGridDialect
implements QueryableGridDialect<String>, ServiceRegistryAwareService, SessionFactoryLifecycleAwareDialect, MultigetGridDialect

Author:

Davide D'Alto

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSTRAINT_VIOLATION_CODE
protected static Pattern	TUPLE_ALREADY_EXISTS_EXCEPTION_PATTERN

Constructor Summary

Constructors

Constructor and Description
BaseNeo4jDialect(org.hibernate.ogm.datastore.neo4j.dialect.impl.BaseNeo4jTypeConverter converter)

Method Summary

Modifier and Type	Method and Description
protected String	buildNativeQuery(BackendQuery<String> customQuery, QueryParameters queryParameters)
protected RowKey	convert(AssociationKey associationKey, TupleSnapshot snapshot)
Association	createAssociation(AssociationKey associationKey, AssociationContext associationContext) Creates a new (empty) association for storing the tuples representing the rows corresponding to the given key.
protected abstract A	createNeo4jAssociationQueries(EntityKeyMetadata ownerEntityKeyMetadata, AssociationKeyMetadata associationKeyMetadata)
protected abstract E	createNeo4jEntityQueries(EntityKeyMetadata entityKeyMetadata, TupleTypeContext tupleTypeContext)
Tuple	createTuple(EntityKey key, OperationContext operationContext) Creates a new tuple for the given entity key.
protected EntityKeyMetadata	entityKeyMetadata(EntityKeyMetadata keyMetadata, TupleTypeContext tupleTypeContext)
protected EntityKeyMetadata	entityKeyMetadata(org.hibernate.ogm.persister.impl.OgmEntityPersister ogmEntityPersister)
int	executeBackendUpdateQuery(BackendQuery<String> query, QueryParameters queryParameters, TupleContext tupleContext) Returns the result of a native update query executed on the backend.
protected A	getAssociationQueries(AssociationKeyMetadata associationKeyMetadata)
DuplicateInsertPreventionStrategy	getDuplicateInsertPreventionStrategy(EntityKeyMetadata entityKeyMetadata) Returns this dialect's strategy for detecting the insertion of several entity tuples of the given type with the same primary key.
protected EntityKey	getEntityKey(Tuple tuple, AssociatedEntityKeyMetadata associatedEntityKeyMetadata) Returns the key of the entity targeted by the represented association, retrieved from the given tuple.
protected E	getEntityQueries(EntityKeyMetadata entityKeyMetadata, OperationContext operationContext)
protected E	getEntityQueries(EntityKeyMetadata entityKeyMetadata, TupleTypeContext tupleTypeContext)
ParameterMetadataBuilder	getParameterMetadataBuilder() Returns a builder for retrieving parameter meta-data from native queries in this datastore's format.
protected Map<String,Object>	getParameters(QueryParameters queryParameters)
ServiceRegistryImplementor	getServiceRegistry()
protected Map<AssociationKeyMetadata,A>	initializeAssociationQueries(SessionFactoryImplementor sessionFactoryImplementor)
void	injectServices(ServiceRegistryImplementor serviceRegistry)
static boolean	isPartOfRegularEmbedded(String[] keyColumnNames, String column) A regular embedded is an element that it is embedded but it is not a key or a collection.
boolean	isStoredInEntityStructure(AssociationKeyMetadata associationKeyMetadata, AssociationTypeContext associationTypeContext) Whether the specified association is stored within an entity structure or not.
GridType	overrideType(Type type) If the datastore does not support a Type the dialect might override it with a custom one.
String	parseNativeQuery(String nativeQuery) Parses the given native query into a representation executable by this dialect.
void	sessionFactoryCreated(SessionFactoryImplementor sessionFactoryImplementor) Injection point for the dialect to receive the session factory.
boolean	supportsSequences() Whether this dialect supports sequences for id generation or not.
boolean	usesNavigationalInformationForInverseSideOfAssociations() Whether this dialect uses navigational information to deal with the inverse side of an association.

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.query.spi.QueryableGridDialect

executeBackendQuery

Methods inherited from interface org.hibernate.ogm.dialect.multiget.spi.MultigetGridDialect

getTuples

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

forEachTuple, getAssociation, getLockingStrategy, getTuple, insertOrUpdateAssociation, insertOrUpdateTuple, nextValue, removeAssociation, removeTuple

Field Detail

CONSTRAINT_VIOLATION_CODE

public static final String CONSTRAINT_VIOLATION_CODE

See Also:

Constant Field Values

TUPLE_ALREADY_EXISTS_EXCEPTION_PATTERN

protected static final Pattern TUPLE_ALREADY_EXISTS_EXCEPTION_PATTERN

Constructor Detail

BaseNeo4jDialect

public BaseNeo4jDialect(org.hibernate.ogm.datastore.neo4j.dialect.impl.BaseNeo4jTypeConverter converter)

Method Detail

sessionFactoryCreated

public void sessionFactoryCreated(SessionFactoryImplementor sessionFactoryImplementor)

Description copied from interface: SessionFactoryLifecycleAwareDialect

Injection point for the dialect to receive the session factory.

Specified by:

sessionFactoryCreated in interface SessionFactoryLifecycleAwareDialect

Parameters:

sessionFactoryImplementor - a successfully created SessionFactoryImplementor

getEntityQueries

protected E getEntityQueries(EntityKeyMetadata entityKeyMetadata,
                             OperationContext operationContext)

getEntityQueries

protected E getEntityQueries(EntityKeyMetadata entityKeyMetadata,
                             TupleTypeContext tupleTypeContext)

getAssociationQueries

protected A getAssociationQueries(AssociationKeyMetadata associationKeyMetadata)

injectServices

public void injectServices(ServiceRegistryImplementor serviceRegistry)

Specified by:

injectServices in interface ServiceRegistryAwareService

getServiceRegistry

public ServiceRegistryImplementor getServiceRegistry()

createTuple

public Tuple createTuple(EntityKey key,
                         OperationContext operationContext)

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

Parameters:

key - The tuple identifier

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

Returns:

the created tuple

createAssociation

public Association createAssociation(AssociationKey associationKey,
                                     AssociationContext associationContext)

Description copied from interface: GridDialect

Creates a new (empty) association for storing the tuples representing the rows corresponding to the given key.

Only invoked if the association does not yet exist in the datastore. Implementations should not perform a round-trip to the datastore but rather return a transient instance. The OGM engine will invoke GridDialect.insertOrUpdateAssociation(AssociationKey, Association, AssociationContext) subsequently.

Specified by:

createAssociation in interface GridDialect

Parameters:

associationKey - Identifies the association

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

Returns:

the created association

isStoredInEntityStructure

public boolean isStoredInEntityStructure(AssociationKeyMetadata associationKeyMetadata,
                                         AssociationTypeContext associationTypeContext)

Description copied from interface: GridDialect

Whether the specified association is stored within an entity structure or not. E.g. dialects for document stores may support storing associations within entity documents and would have to return true if this is the case for a given association.

Specified by:

isStoredInEntityStructure in interface GridDialect

Parameters:

associationKeyMetadata - identifies the association of interest

associationTypeContext - provides additional contextual information about the represented association type, such as the options effectively applying for it

Returns:

true if the specified association is stored within an entity structure, false otherwise.

supportsSequences

public boolean supportsSequences()

Description copied from interface: GridDialect

Whether this dialect supports sequences for id generation or not. If not, a table-based strategy will be used as fall-back.

Specified by:

supportsSequences in interface GridDialect

Overrides:

supportsSequences in class BaseGridDialect

Returns:

true if this dialect supports sequences, false otherwise.

convert

protected RowKey convert(AssociationKey associationKey,
                         TupleSnapshot snapshot)

overrideType

public GridType overrideType(Type type)

Description copied from interface: GridDialect

If the datastore does not support a Type the dialect might override it with a custom one.

Specified by:

overrideType in interface GridDialect

Overrides:

overrideType in class BaseGridDialect

Parameters:

type - The Type that might need to be overridden

Returns:

the GridType instance to use to bind the given type or null if the type does not need to be overridden

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>

Parameters:

nativeQuery - the native query to parse

Returns:

the parsed query

buildNativeQuery

protected String buildNativeQuery(BackendQuery<String> customQuery,
                                  QueryParameters queryParameters)

getParameterMetadataBuilder

public ParameterMetadataBuilder getParameterMetadataBuilder()

Description copied from interface: QueryableGridDialect

Returns a builder for retrieving parameter meta-data from native queries in this datastore's format.

Specified by:

getParameterMetadataBuilder in interface QueryableGridDialect<String>

Returns:

a builder for retrieving parameter meta-data

getEntityKey

protected EntityKey getEntityKey(Tuple tuple,
                                 AssociatedEntityKeyMetadata associatedEntityKeyMetadata)

Returns the key of the entity targeted by the represented association, retrieved from the given tuple.

Parameters:

tuple - the tuple from which to retrieve the referenced entity key

Returns:

the key of the entity targeted by the represented association

getDuplicateInsertPreventionStrategy

public DuplicateInsertPreventionStrategy getDuplicateInsertPreventionStrategy(EntityKeyMetadata entityKeyMetadata)

Description copied from interface: GridDialect

Returns this dialect's strategy for detecting the insertion of several entity tuples of the given type with the same primary key.

Specified by:

getDuplicateInsertPreventionStrategy in interface GridDialect

Overrides:

getDuplicateInsertPreventionStrategy in class BaseGridDialect

Parameters:

entityKeyMetadata - meta-data identifying the entity type of interest

Returns:

This dialect's strategy for detecting the insertion of several entity tuples of the given type with the same primary key

isPartOfRegularEmbedded

public static boolean isPartOfRegularEmbedded(String[] keyColumnNames,
                                              String column)

A regular embedded is an element that it is embedded but it is not a key or a collection.

Parameters:

keyColumnNames - the column names representing the identifier of the entity

column - the column we want to check

Returns:

true if the column represent an attribute of a regular embedded element, false otherwise

executeBackendUpdateQuery

public int executeBackendUpdateQuery(BackendQuery<String> query,
                                     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>

Parameters:

query - 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.

getParameters

protected Map<String,Object> getParameters(QueryParameters queryParameters)

usesNavigationalInformationForInverseSideOfAssociations

public boolean usesNavigationalInformationForInverseSideOfAssociations()

Description copied from interface: GridDialect

Whether this dialect uses navigational information to deal with the inverse side of an association.

Specified by:

usesNavigationalInformationForInverseSideOfAssociations in interface GridDialect

Overrides:

usesNavigationalInformationForInverseSideOfAssociations in class BaseGridDialect

Returns:

true is this dialect uses navigational information.

entityKeyMetadata

protected EntityKeyMetadata entityKeyMetadata(org.hibernate.ogm.persister.impl.OgmEntityPersister ogmEntityPersister)

entityKeyMetadata

protected EntityKeyMetadata entityKeyMetadata(EntityKeyMetadata keyMetadata,
                                              TupleTypeContext tupleTypeContext)

createNeo4jEntityQueries

protected abstract E createNeo4jEntityQueries(EntityKeyMetadata entityKeyMetadata,
                                              TupleTypeContext tupleTypeContext)

initializeAssociationQueries

protected Map<AssociationKeyMetadata,A> initializeAssociationQueries(SessionFactoryImplementor sessionFactoryImplementor)

createNeo4jAssociationQueries

protected abstract A createNeo4jAssociationQueries(EntityKeyMetadata ownerEntityKeyMetadata,
                                                   AssociationKeyMetadata associationKeyMetadata)