org.hibernate.id

Class IdentifierGeneratorHelper

java.lang.Object

org.hibernate.id.IdentifierGeneratorHelper

public final class IdentifierGeneratorHelper
extends Object

Factory and helper methods for IdentifierGenerator framework.

Author:

Gavin King, Steve Ebersole

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdentifierGeneratorHelper.BasicHolder
static class	IdentifierGeneratorHelper.BigDecimalHolder
static class	IdentifierGeneratorHelper.BigIntegerHolder

Field Summary

Fields

Modifier and Type	Field and Description
static Serializable	POST_INSERT_INDICATOR Marker object returned from IdentifierGenerator.generate(org.hibernate.engine.spi.SessionImplementor, java.lang.Object) to indicate that the entity's identifier will be generated as part of the datbase insertion.
static Serializable	SHORT_CIRCUIT_INDICATOR Marker object returned from IdentifierGenerator.generate(org.hibernate.engine.spi.SessionImplementor, java.lang.Object) to indicate that we should short-circuit any continued generated id checking.

Method Summary

Modifier and Type	Method and Description
static Number	createNumber(long value, Class clazz) Deprecated. Use the holders instead.
static BigDecimal	extractBigDecimal(IntegralDataTypeHolder holder)
static BigInteger	extractBigInteger(IntegralDataTypeHolder holder)
static long	extractLong(IntegralDataTypeHolder holder)
static Serializable	get(ResultSet rs, String identifier, Type type) Extract the value from the result set (which is assumed to already have been positioned to the apopriate row) and wrp it in the appropriate Java numeric type.
static Serializable	getGeneratedIdentity(ResultSet rs, String identifier, Type type) Get the generated identifier when using identity columns
static IntegralDataTypeHolder	getIntegralDataTypeHolder(Class integralType)

Methods inherited from class java.lang.Object

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

Field Detail

SHORT_CIRCUIT_INDICATOR

public static final Serializable SHORT_CIRCUIT_INDICATOR

Marker object returned from IdentifierGenerator.generate(org.hibernate.engine.spi.SessionImplementor, java.lang.Object) to indicate that we should short-circuit any continued generated id checking. Currently this is only used in the case of the foreign generator as a way to signal that we should use the associated entity's id value.

POST_INSERT_INDICATOR

public static final Serializable POST_INSERT_INDICATOR

Marker object returned from IdentifierGenerator.generate(org.hibernate.engine.spi.SessionImplementor, java.lang.Object) to indicate that the entity's identifier will be generated as part of the datbase insertion.

Method Detail

getGeneratedIdentity

public static Serializable getGeneratedIdentity(ResultSet rs,
                                                String identifier,
                                                Type type)
                                         throws SQLException,
                                                HibernateException

Get the generated identifier when using identity columns

Parameters:

rs - The result set from which to extract the the generated identity.

identifier - The name of the identifier column

type - The expected type mapping for the identity value.

Returns:

The generated identity value

Throws:

SQLException - Can be thrown while accessing the result set

HibernateException - Indicates a problem reading back a generated identity value.

get

public static Serializable get(ResultSet rs,
                               String identifier,
                               Type type)
                        throws SQLException,
                               IdentifierGenerationException

Extract the value from the result set (which is assumed to already have been positioned to the apopriate row) and wrp it in the appropriate Java numeric type.

Parameters:

rs - The result set from which to extract the value.

identifier - The name of the identifier column

type - The expected type of the value.

Returns:

The extracted value.

Throws:

SQLException - Indicates problems access the result set

IdentifierGenerationException - Indicates an unknown type.

createNumber

@Deprecated
public static Number createNumber(long value,
                                              Class clazz)
                                       throws IdentifierGenerationException

Deprecated. Use the holders instead.

Wrap the given value in the given Java numeric class.

Parameters:

value - The primitive value to wrap.

clazz - The Java numeric type in which to wrap the value.

Returns:

The wrapped type.

Throws:

IdentifierGenerationException - Indicates an unhandled 'clazz'.

getIntegralDataTypeHolder

public static IntegralDataTypeHolder getIntegralDataTypeHolder(Class integralType)

extractLong

public static long extractLong(IntegralDataTypeHolder holder)

extractBigInteger

public static BigInteger extractBigInteger(IntegralDataTypeHolder holder)

extractBigDecimal

public static BigDecimal extractBigDecimal(IntegralDataTypeHolder holder)