org.hibernate.ogm.datastore.infinispan

Class InfinispanDialect<EK,AK,ISK>

java.lang.Object

org.hibernate.ogm.dialect.spi.BaseGridDialect

org.hibernate.ogm.datastore.infinispan.InfinispanDialect<EK,AK,ISK>

All Implemented Interfaces:

Serializable, GridDialect, Service

public class InfinispanDialect<EK,AK,ISK>
extends BaseGridDialect

EK is the entity cache key type AK is the association cache key type ISK is the identity source cache key type

Author:

Emmanuel Bernard, Fabio Massimo Ercoli

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InfinispanDialect(org.hibernate.ogm.datastore.infinispan.impl.InfinispanEmbeddedDatastoreProvider provider)

Method Summary

Modifier and Type	Method and Description
Association	createAssociation(AssociationKey key, AssociationContext associationContext) Creates a new (empty) association for storing the tuples representing the rows corresponding to the given key.
Tuple	createTuple(EntityKey key, OperationContext operationContext) Creates a new tuple for the given entity key.
void	forEachTuple(ModelConsumer consumer, TupleTypeContext tupleTypeContext, EntityKeyMetadata entityKeyMetadata) 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) Get a strategy instance which knows how to acquire a database-level lock of the specified/mode for this dialect.
Tuple	getTuple(EntityKey key, OperationContext operationContext) Return the tuple with the given column for a given key
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.
boolean	isStoredInEntityStructure(AssociationKeyMetadata associationKeyMetadata, AssociationTypeContext associationTypeContext) Whether the specified association is stored within an entity structure or not.
Number	nextValue(NextValueRequest request) Returns the next value from the specified id generator with the specified increment.
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
boolean	supportsSequences() With the introduction of Infinispan clustered counter SequenceGenerator strategy is now supported

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

getDuplicateInsertPreventionStrategy, isInTheInsertionQueue, overrideType, usesNavigationalInformationForInverseSideOfAssociations

Methods inherited from class java.lang.Object

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

Constructor Detail

InfinispanDialect

public InfinispanDialect(org.hibernate.ogm.datastore.infinispan.impl.InfinispanEmbeddedDatastoreProvider provider)

Method Detail

getLockingStrategy

public LockingStrategy getLockingStrategy(Lockable lockable,
                                          LockMode lockMode)

Get a strategy instance which knows how to acquire a database-level lock of the specified/mode for this dialect.

Specified by:

getLockingStrategy in interface GridDialect

Overrides:

getLockingStrategy in class BaseGridDialect

Parameters:

lockable - The persister for the entity to be locked.

lockMode - The type of lock to be acquired.

Returns:

The appropriate locking strategy.

Since:

3.2

getTuple

public Tuple getTuple(EntityKey key,
                      OperationContext operationContext)

Description copied from interface: GridDialect

Return the tuple with the given column for a given key

Parameters:

key - The tuple identifier

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

Returns:

the tuple identified by the key

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.

Parameters:

key - The tuple identifier

operationContext - 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

getAssociation

public Association getAssociation(AssociationKey key,
                                  AssociationContext associationContext)

Description copied from interface: GridDialect

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

Parameters:

key - Identifies the association

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

Returns:

a list of tuples

createAssociation

public Association createAssociation(AssociationKey key,
                                     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.

Parameters:

key - Identifies the association

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

Returns:

the created association

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

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.

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.

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

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

supportsSequences

public boolean supportsSequences()

With the introduction of Infinispan clustered counter SequenceGenerator strategy is now supported

Specified by:

supportsSequences in interface GridDialect

Overrides:

supportsSequences in class BaseGridDialect

Returns:

true