org.hibernate.ogm.dialect.identity.spi

Interface IdentityColumnAwareGridDialect

All Superinterfaces:

GridDialect, Serializable, Service

All Known Implementing Classes:

MongoDBDialect

public interface IdentityColumnAwareGridDialect
extends GridDialect

A GridDialect facet to be implemented by those stores which support the generation of ids during the insertion of records (similar to identity columns in RDMBS such as MySQL's auto-increment column type).

Author:

Gunnar Morling

Method Summary

Modifier and Type	Method and Description
Tuple	createTuple(EntityKeyMetadata entityKeyMetadata, OperationContext operationContext) Creates an empty tuple of the specified entity type.
void	insertTuple(EntityKeyMetadata entityKeyMetadata, Tuple tuple, TupleContext tupleContext) Inserts the given tuple into the datastore, generating an id while doing so.

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

createAssociation, createTuple, forEachTuple, getAssociation, getDuplicateInsertPreventionStrategy, getLockingStrategy, getTuple, insertOrUpdateAssociation, insertOrUpdateTuple, isStoredInEntityStructure, nextValue, overrideType, removeAssociation, removeTuple, supportsSequences, usesNavigationalInformationForInverseSideOfAssociations

Method Detail

createTuple

Tuple createTuple(EntityKeyMetadata entityKeyMetadata,
                  OperationContext operationContext)

Creates an empty tuple of the specified entity type. The created tuple should be "transient", i.e. no round-trip to the datastore should be performed.

Parameters:

entityKeyMetadata - Represents the entity type for which the tuple should be created

operationContext - Provides additional meta-data useful for tuple creation

Returns:

the newly created tuple

insertTuple

void insertTuple(EntityKeyMetadata entityKeyMetadata,
                 Tuple tuple,
                 TupleContext tupleContext)

Inserts the given tuple into the datastore, generating an id while doing so. The generated id is to be added to the given tuple (the id column name(s) can be obtained from the given entity key meta-data).

Parameters:

entityKeyMetadata - The type of the entity to save

tuple - The entity column values to save

tupleContext - Provides additional meta-data useful for tuple insertion