Package org.hibernate.generator.internal

Class GeneratedGeneration

java.lang.Object

org.hibernate.generator.internal.GeneratedGeneration

All Implemented Interfaces:

Serializable, Generator, OnExecutionGenerator

public class GeneratedGeneration
extends Object
implements OnExecutionGenerator

A fairly generic OnExecutionGenerator which marks a property as generated in the database with semantics given explicitly by a @Generated annotation.

See Also:

Generated, Serialized Form

Constructor Summary

Constructors

Constructor	Description
GeneratedGeneration(Generated annotation)
GeneratedGeneration(GenerationTime event)

Method Summary

Modifier and Type	Method	Description
EnumSet<EventType>	getEventTypes()	The event types for which this generator should be called to produce a new value.
String[]	getReferencedColumnValues(Dialect dialect)	A SQL expression indicating how to calculate the generated values when the mapped columns are included in the SQL statement.
boolean	referenceColumnsInSql(Dialect dialect)	Determines if the columns whose values are generated are included in the column list of the SQL insert or update statement.
boolean	writePropertyValue()	Determines if the property values are written to JDBC as the argument of a JDBC ? parameter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.generator.Generator

generatesOnInsert, generatesOnUpdate, generatesSometimes

Methods inherited from interface org.hibernate.generator.OnExecutionGenerator

generatedOnExecution, getGeneratedIdentifierDelegate, getUniqueKeyPropertyNames

Constructor Detail

GeneratedGeneration

public GeneratedGeneration(GenerationTime event)

GeneratedGeneration

public GeneratedGeneration(Generated annotation)

Method Detail

getEventTypes

public EnumSet<EventType> getEventTypes()

Description copied from interface: Generator

The event types for which this generator should be called to produce a new value.

Identifier generators must return EventTypeSets.INSERT_ONLY.

Specified by:

getEventTypes in interface Generator

Returns:

a set of EventTypes.

referenceColumnsInSql

public boolean referenceColumnsInSql(Dialect dialect)

Description copied from interface: OnExecutionGenerator

Determines if the columns whose values are generated are included in the column list of the SQL insert or update statement. For example, this method should return:

• true if the value is generated by calling a SQL function like current_timestamp, or
• false if the value is generated by a trigger, by generated always as, or using a column default value.

Specified by:

referenceColumnsInSql in interface OnExecutionGenerator

Returns:

true if the column is included in the column list of the SQL statement.

getReferencedColumnValues

public String[] getReferencedColumnValues(Dialect dialect)

Description copied from interface: OnExecutionGenerator

A SQL expression indicating how to calculate the generated values when the mapped columns are included in the SQL statement. The SQL expressions might be:

• function calls like current_timestamp or nextval('mysequence'), or
• syntactic markers like default.

Specified by:

getReferencedColumnValues in interface OnExecutionGenerator

Parameters:

dialect - The SQL dialect, allowing generation of an expression in dialect-specific SQL.

Returns:

The column value to be used in the generated SQL statement.

writePropertyValue

public boolean writePropertyValue()

Description copied from interface: OnExecutionGenerator

Determines if the property values are written to JDBC as the argument of a JDBC ? parameter.

Specified by:

writePropertyValue in interface OnExecutionGenerator