Class IdentityColumnSupportBase

java.lang.Object

org.hibernate.dialect.identity.spi.IdentityColumnSupportBase

All Implemented Interfaces:

IdentityColumnSupport

@SPI({USE,IMPLEMENT})
public class IdentityColumnSupportBase
extends Object
implements IdentityColumnSupport

Provider base for implementing identity-column support.

The inherited behavior represents a database without identity columns. Override only the operations supported by the database, and supply the resulting stable instance from Dialect.getIdentityColumnSupport().

Since:

8.0

Field Summary

Fields

Modifier and Type	Field	Description
static final IdentityColumnSupport	NONE	Reusable support value for a database without identity columns.

Constructor Summary

Constructors

Constructor	Description
IdentityColumnSupportBase()	Construct identity support initialized with the conservative defaults.

Method Summary

Modifier and Type	Method	Description
String	appendIdentitySelectToInsert(String identityColumnName, String insertString)	Transform an insert so its execution also returns the generated identity.
String	getIdentityColumnString(int jdbcTypeCode)	Render the DDL fragment which declares an identity column.
String	getIdentityInsertString()	The value keyword written for an identity column, or null when the identity column is omitted from the insert.
String	getIdentitySelectString(String table, String column, int jdbcTypeCode)	Render the separate statement used to select the last generated identity.
IdentityValueRetrieval	getIdentityValueRetrieval()	Select the identity-specific retrieval behavior Hibernate should execute.
boolean	hasDataTypeInIdentityColumn()	Whether the identity declaration follows an existing SQL data type.
boolean	supportsIdentityColumns()	Whether identity-column key generation is supported.
boolean	supportsInsertSelectIdentity()	Whether identity-selection SQL may be combined with or appended to the insert SQL.

Methods inherited from class Object

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

Methods inherited from interface IdentityColumnSupport

hasIdentityInsertKeyword

Field Details

NONE

public static final IdentityColumnSupport NONE

Reusable support value for a database without identity columns.

Constructor Details

IdentityColumnSupportBase

@SPI(IMPLEMENT)
public IdentityColumnSupportBase()

Construct identity support initialized with the conservative defaults.

Since:

8.0

Method Details

supportsIdentityColumns

public boolean supportsIdentityColumns()

Description copied from interface: IdentityColumnSupport

Whether identity-column key generation is supported.

Specified by:

supportsIdentityColumns in interface IdentityColumnSupport

supportsInsertSelectIdentity

public boolean supportsInsertSelectIdentity()

Description copied from interface: IdentityColumnSupport

Whether identity-selection SQL may be combined with or appended to the insert SQL.

Specified by:

supportsInsertSelectIdentity in interface IdentityColumnSupport

hasDataTypeInIdentityColumn

public boolean hasDataTypeInIdentityColumn()

Description copied from interface: IdentityColumnSupport

Whether the identity declaration follows an existing SQL data type.

Specified by:

hasDataTypeInIdentityColumn in interface IdentityColumnSupport

appendIdentitySelectToInsert

public String appendIdentitySelectToInsert(String identityColumnName,
 String insertString)

Description copied from interface: IdentityColumnSupport

Transform an insert so its execution also returns the generated identity. Return the input unchanged when no transformation is required.

Specified by:

appendIdentitySelectToInsert in interface IdentityColumnSupport

getIdentitySelectString

public String getIdentitySelectString(String table,
 String column,
 int jdbcTypeCode)
                               throws MappingException

Description copied from interface: IdentityColumnSupport

Render the separate statement used to select the last generated identity.

Specified by:

getIdentitySelectString in interface IdentityColumnSupport

Throws:

MappingException - when separate identity selection is unsupported

getIdentityColumnString

public String getIdentityColumnString(int jdbcTypeCode)
                               throws MappingException

Description copied from interface: IdentityColumnSupport

Render the DDL fragment which declares an identity column.

Specified by:

getIdentityColumnString in interface IdentityColumnSupport

Throws:

MappingException - when identity columns are unsupported or the JDBC type is not a valid identity type

getIdentityInsertString

public String getIdentityInsertString()

Description copied from interface: IdentityColumnSupport

The value keyword written for an identity column, or null when the identity column is omitted from the insert.

Specified by:

getIdentityInsertString in interface IdentityColumnSupport

getIdentityValueRetrieval

public IdentityValueRetrieval getIdentityValueRetrieval()

Description copied from interface: IdentityColumnSupport

Select the identity-specific retrieval behavior Hibernate should execute.

Specified by:

getIdentityValueRetrieval in interface IdentityColumnSupport