Package org.hibernate.mapping

Interface KeyValue

All Superinterfaces:

Serializable, Value

All Known Implementing Classes:

Any, Any.KeyValue, Any.MetaValue, BasicValue, Component, DependantBasicValue, DependantValue, ManyToOne, OneToOne, SimpleValue, ToOne

public interface KeyValue
extends Value

A mapping model Value which may be treated as an identifying key of a relational database table. A KeyValue might represent the primary key of an entity or the foreign key of a collection, join table, secondary table, or joined subclass table.

Method Summary

Modifier and Type	Method	Description
ForeignKey	createForeignKeyOfEntity(String entityName)
Generator	createGenerator(IdentifierGeneratorFactory identifierGeneratorFactory, Dialect dialect, RootClass rootClass)
default IdentifierGenerator	createIdentifierGenerator(IdentifierGeneratorFactory identifierGeneratorFactory, Dialect dialect, String defaultCatalog, String defaultSchema, RootClass rootClass)	Deprecated. Use createGenerator(IdentifierGeneratorFactory, Dialect, RootClass) instead.
default IdentifierGenerator	createIdentifierGenerator(IdentifierGeneratorFactory identifierGeneratorFactory, Dialect dialect, RootClass rootClass)	Deprecated. Use createGenerator(IdentifierGeneratorFactory, Dialect, RootClass) instead.
String	getNullValue()
boolean	isCascadeDeleteEnabled()
boolean	isIdentityColumn(IdentifierGeneratorFactory identifierGeneratorFactory, Dialect dialect)	Deprecated. We need to add Column.isIdentity()
boolean	isUpdateable()

Methods inherited from interface org.hibernate.mapping.Value

accept, checkColumnDuplication, copy, createForeignKey, createUniqueKey, getBuildingContext, getColumnInsertability, getColumns, getColumnSpan, getColumnUpdateability, getConstraintColumns, getExtraCreateTableInfo, getFetchMode, getSelectables, getSelectableType, getServiceRegistry, getTable, getType, getVirtualSelectables, hasAnyInsertableColumns, hasAnyUpdatableColumns, hasFormula, isAlternateUniqueKey, isColumnInsertable, isColumnUpdateable, isNullable, isSame, isSimpleValue, isValid, setTypeUsingReflection

Method Detail

createForeignKeyOfEntity

ForeignKey createForeignKeyOfEntity(String entityName)

isCascadeDeleteEnabled

boolean isCascadeDeleteEnabled()

getNullValue

String getNullValue()

isUpdateable

boolean isUpdateable()

createGenerator

Generator createGenerator(IdentifierGeneratorFactory identifierGeneratorFactory,
                          Dialect dialect,
                          RootClass rootClass)

createIdentifierGenerator

@Deprecated(since="6.2")
default IdentifierGenerator createIdentifierGenerator(IdentifierGeneratorFactory identifierGeneratorFactory,
                                                      Dialect dialect,
                                                      String defaultCatalog,
                                                      String defaultSchema,
                                                      RootClass rootClass)

Deprecated.

Use createGenerator(IdentifierGeneratorFactory, Dialect, RootClass) instead.

Returns:

null if the Generator returned by createGenerator(org.hibernate.id.factory.IdentifierGeneratorFactory, org.hibernate.dialect.Dialect, org.hibernate.mapping.RootClass) is not an instance of IdentifierGenerator.

createIdentifierGenerator

@Deprecated(since="6.2")
default IdentifierGenerator createIdentifierGenerator(IdentifierGeneratorFactory identifierGeneratorFactory,
                                                      Dialect dialect,
                                                      RootClass rootClass)

Deprecated.

Use createGenerator(IdentifierGeneratorFactory, Dialect, RootClass) instead.

Returns:

null if the Generator returned by createGenerator(org.hibernate.id.factory.IdentifierGeneratorFactory, org.hibernate.dialect.Dialect, org.hibernate.mapping.RootClass) is not an instance of IdentifierGenerator.

isIdentityColumn

@Deprecated(since="6.2")
boolean isIdentityColumn(IdentifierGeneratorFactory identifierGeneratorFactory,
                         Dialect dialect)

Deprecated.

We need to add Column.isIdentity()