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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	KeyValue.NullValueSemantic

Method Summary

Modifier and Type	Method	Description
ForeignKey	createForeignKeyOfEntity(String entityName)
ForeignKey	createForeignKeyOfEntity(String entityName, List<Column> referencedColumns)
Generator	createGenerator(Dialect dialect, RootClass rootClass)	Deprecated, for removal: This API element is subject to removal in a future version. No longer called, except from tests.
Generator	createGenerator(Dialect dialect, RootClass rootClass, Property property, GeneratorSettings defaults)
String	getNullValue()
KeyValue.NullValueSemantic	getNullValueSemantic()
boolean	isCascadeDeleteEnabled()
boolean	isUpdateable()

Methods inherited from interface 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, isPartitionKey, isSame, isSimpleValue, isValid, setTypeUsingReflection

Method Details

createForeignKeyOfEntity

ForeignKey createForeignKeyOfEntity(String entityName,
 List<Column> referencedColumns)

createForeignKeyOfEntity

ForeignKey createForeignKeyOfEntity(String entityName)

isCascadeDeleteEnabled

boolean isCascadeDeleteEnabled()

getNullValueSemantic

KeyValue.NullValueSemantic getNullValueSemantic()

getNullValue

String getNullValue()

isUpdateable

boolean isUpdateable()

createGenerator

@Deprecated(since="7.0",
            forRemoval=true)
Generator createGenerator(Dialect dialect,
 RootClass rootClass)

Deprecated, for removal: This API element is subject to removal in a future version.

No longer called, except from tests. Use createGenerator(Dialect, RootClass, Property, GeneratorSettings)

createGenerator

@Incubating
Generator createGenerator(Dialect dialect,
 RootClass rootClass,
 Property property,
 GeneratorSettings defaults)