org.hibernate.ogm.dialect

Interface GridDialect

All Superinterfaces:

Serializable, Service

All Known Implementing Classes:

EhcacheDialect, GridDialectLogger, HashMapDialect, InfinispanDialect

public interface GridDialect
extends Service

Dialect abstracting Hibernate OGM from the grid implementation

Author:

Emmanuel Bernard

Method Summary

Methods

Modifier and Type	Method and Description
Association	createAssociation(AssociationKey key) Create an empty container for the list of tuples corresponding to a given association Only used if the association data is not present
Tuple	createTuple(EntityKey key) Return a new tuple for a given key Only used if the tuple is not present
Tuple	createTupleAssociation(AssociationKey associationKey, RowKey rowKey)
Iterator<Tuple>	executeBackendQuery(CustomQuery customQuery, EntityKeyMetadata[] metadatas) Returns the result of a native query executed on the backend.
void	forEachTuple(Consumer consumer, EntityKeyMetadata... entityKeyMetadatas) A consumer is called for each tuple matching the selected EntityKeyMetadata.
Association	getAssociation(AssociationKey key, AssociationContext associationContext) Return the list of tuples corresponding to a given association and the given context
LockingStrategy	getLockingStrategy(Lockable lockable, LockMode lockMode)
Tuple	getTuple(EntityKey key, TupleContext tupleContext) Return the tuple with the given column for a given key
void	nextValue(RowKey key, IntegralDataTypeHolder value, int increment, int initialValue) Update value with the guaranteed next value with the defined increment Especially experimental
GridType	overrideType(Type type) Let the dialect override types if required to customize them to the datastore.
void	removeAssociation(AssociationKey key) Remove the list of tuples corresponding to a given association
void	removeTuple(EntityKey key) Remove the tuple for a given key
void	updateAssociation(Association association, AssociationKey key) Update a given list of tuples corresponding to a given association
void	updateTuple(Tuple tuple, EntityKey key) Update the tuple for a given key or null if not present

Method Detail

getLockingStrategy

LockingStrategy getLockingStrategy(Lockable lockable,
                                 LockMode lockMode)

getTuple

Tuple getTuple(EntityKey key,
             TupleContext tupleContext)

Return the tuple with the given column for a given key

createTuple

Tuple createTuple(EntityKey key)

Return a new tuple for a given key Only used if the tuple is not present

updateTuple

void updateTuple(Tuple tuple,
               EntityKey key)

Update the tuple for a given key or null if not present

removeTuple

void removeTuple(EntityKey key)

Remove the tuple for a given key

getAssociation

Association getAssociation(AssociationKey key,
                         AssociationContext associationContext)

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

createAssociation

Association createAssociation(AssociationKey key)

Create an empty container for the list of tuples corresponding to a given association Only used if the association data is not present

updateAssociation

void updateAssociation(Association association,
                     AssociationKey key)

Update a given list of tuples corresponding to a given association

removeAssociation

void removeAssociation(AssociationKey key)

Remove the list of tuples corresponding to a given association

createTupleAssociation

Tuple createTupleAssociation(AssociationKey associationKey,
                           RowKey rowKey)

nextValue

void nextValue(RowKey key,
             IntegralDataTypeHolder value,
             int increment,
             int initialValue)

Update value with the guaranteed next value with the defined increment Especially experimental

overrideType

GridType overrideType(Type type)

Let the dialect override types if required to customize them to the datastore. Returns the GridType instance to use to bind the given type or null if not overridden. Most types should not be overridden and thus return null Experimental: this API might change in the future

forEachTuple

void forEachTuple(Consumer consumer,
                EntityKeyMetadata... entityKeyMetadatas)

A consumer is called for each tuple matching the selected EntityKeyMetadata.

Parameters:

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

entityKeyMetadatas - the key metadata of the tables for which we want to apply the costumer

executeBackendQuery

Iterator<Tuple> executeBackendQuery(CustomQuery customQuery,
                                  EntityKeyMetadata[] metadatas)

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

Parameters:

customQuery - the CustomQuery to execute on the backend

metadatas - the metadata information of the results of the query

Returns:

an Iterator throught the result of the query