org.hibernate.tuple

Class GeneratedValueGeneration

java.lang.Object

org.hibernate.tuple.GeneratedValueGeneration

All Implemented Interfaces:

Serializable, AnnotationValueGeneration<Generated>, ValueGeneration

public class GeneratedValueGeneration
extends Object
implements AnnotationValueGeneration<Generated>

A AnnotationValueGeneration which marks a property as generated in the database.

Author:

Steve Ebersole, Gunnar Morling

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GeneratedValueGeneration()
GeneratedValueGeneration(GenerationTiming timing)

Method Summary

Modifier and Type	Method and Description
String	getDatabaseGeneratedReferencedColumnValue() For values which are generated in the database (ValueGeneration.getValueGenerator() == null), if the column will be referenced in the SQL (ValueGeneration.referenceColumnInSql() == true), what value should be used in the SQL as the column value.
GenerationTiming	getGenerationTiming() When is this value generated : NEVER, INSERT, ALWAYS (INSERT+UPDATE)
ValueGenerator<?>	getValueGenerator() Obtain the in-VM value generator.
void	initialize(Generated annotation, Class<?> propertyType) Initializes this generation strategy for the given annotation instance.
boolean	referenceColumnInSql() For values which are generated in the database (ValueGeneration.getValueGenerator() == null), should the column be referenced in the INSERT / UPDATE SQL? This will be false most often to have a DDL-defined DEFAULT value be applied on INSERT

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneratedValueGeneration

public GeneratedValueGeneration()

GeneratedValueGeneration

public GeneratedValueGeneration(GenerationTiming timing)

Method Detail

initialize

public void initialize(Generated annotation,
                       Class<?> propertyType)

Description copied from interface: AnnotationValueGeneration

Initializes this generation strategy for the given annotation instance.

Specified by:

initialize in interface AnnotationValueGeneration<Generated>

Parameters:

annotation - an instance of the strategy's annotation type. Typically implementations will retrieve the annotation's attribute values and store them in fields.

propertyType - the type of the property annotated with the generator annotation. Implementations may use the type to determine the right ValueGenerator to be applied.

getGenerationTiming

public GenerationTiming getGenerationTiming()

Description copied from interface: ValueGeneration

When is this value generated : NEVER, INSERT, ALWAYS (INSERT+UPDATE)

Specified by:

getGenerationTiming in interface ValueGeneration

Returns:

When the value is generated.

getValueGenerator

public ValueGenerator<?> getValueGenerator()

Description copied from interface: ValueGeneration

Obtain the in-VM value generator.

May return null. In fact for values that are generated "in the database" via execution of the INSERT/UPDATE statement, the expectation is that null be returned here

Specified by:

getValueGenerator in interface ValueGeneration

Returns:

The strategy for performing in-VM value generation

referenceColumnInSql

public boolean referenceColumnInSql()

Description copied from interface: ValueGeneration

For values which are generated in the database (ValueGeneration.getValueGenerator() == null), should the column be referenced in the INSERT / UPDATE SQL?

This will be false most often to have a DDL-defined DEFAULT value be applied on INSERT

Specified by:

referenceColumnInSql in interface ValueGeneration

Returns:

true indicates the column should be included in the SQL.

getDatabaseGeneratedReferencedColumnValue

public String getDatabaseGeneratedReferencedColumnValue()

Description copied from interface: ValueGeneration

For values which are generated in the database (ValueGeneration.getValueGenerator() == null), if the column will be referenced in the SQL (ValueGeneration.referenceColumnInSql() == true), what value should be used in the SQL as the column value.

Generally this will be a function call or a marker (DEFAULTS).

NOTE : for in-VM generation, this will not be called and the column value will implicitly be a JDBC parameter ('?')

Specified by:

getDatabaseGeneratedReferencedColumnValue in interface ValueGeneration

Returns:

The column value to be used in the SQL.