Top Description Fields Constructors Methods
org.hibernate.id

public Class ForeignGenerator

extends Object
implements IdentifierGenerator, StandardGenerator
Class Inheritance
All Implemented Interfaces
org.hibernate.id.factory.spi.StandardGenerator, org.hibernate.id.IdentifierGenerator, org.hibernate.id.Configurable, org.hibernate.boot.model.relational.ExportableProducer, org.hibernate.generator.BeforeExecutionGenerator, org.hibernate.generator.Generator, java.io.Serializable
Annotations
@Deprecated
since:6
forRemoval:true
Imports
java.util.Properties, org.hibernate.MappingException, .TransientObjectException, org.hibernate.engine.spi.SharedSessionContractImplementor, org.hibernate.id.factory.spi.StandardGenerator, org.hibernate.internal.CoreMessageLogger, org.hibernate.persister.entity.EntityPersister, org.hibernate.service.ServiceRegistry, org.hibernate.type.EntityType, .Type

Deprecated

for removal since 6.

This remains around as an implementation detail of hbm.xml mappings.

The legacy id generator named foreign.

An Identifier generator that uses the value of the id property of an associated object.

One mapping parameter is required: property.

Author
Gavin King

Field Summary

Modifier and TypeField and Description
private String
entityName

private static final CoreMessageLogger
LOG

public static final String
PROPERTY

The parameter which specifies the property holding a reference to the associated object.

private String
propertyName

Constructor Summary

AccessConstructor and Description
public
ForeignGenerator()

Method Summary

Modifier and TypeMethod and Description
public void
configure(Type
The id property type descriptor
type, Properties
param values, keyed by parameter name
parameters, ServiceRegistry
Access to service that may be needed.
serviceRegistry)

Overrides default org.hibernate.id.IdentifierGenerator.configure.

Configure this instance, given the value of parameters specified by the user as <param> elements.
public Object
generate(SharedSessionContractImplementor
The session from which the request originates
sessionImplementor, Object
the entity or collection (idbag) for which the id is being generated
object)

Implements org.hibernate.id.IdentifierGenerator.generate.

Generate a new identifier.
public String

Returns:

Value for property 'entityName'.
getEntityName()

Getter for property 'entityName'.

public String

Returns:

Value for property 'propertyName'.
getPropertyName()

Getter for property 'propertyName'.

public String

Returns:

Value for property 'role'.
getRole()

Getter for property 'role'.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

entityNameback to summary
private String entityName
LOGback to summary
private static final CoreMessageLogger LOG
PROPERTYback to summary
public static final String PROPERTY

The parameter which specifies the property holding a reference to the associated object.

propertyNameback to summary
private String propertyName

Constructor Detail

ForeignGeneratorback to summary
public ForeignGenerator()

Method Detail

configureback to summary
public void configure(Type type, Properties parameters, ServiceRegistry serviceRegistry) throws MappingException

Overrides default org.hibernate.id.IdentifierGenerator.configure.

Doc from org.hibernate.id.IdentifierGenerator.configure.

Configure this instance, given the value of parameters specified by the user as <param> elements.

This method is called just once, following instantiation, and before registerExportables(Database).

Parameters
type:Type

The id property type descriptor

parameters:Properties

param values, keyed by parameter name

serviceRegistry:ServiceRegistry

Access to service that may be needed.

Annotations
@Override
generateback to summary
public Object generate(SharedSessionContractImplementor sessionImplementor, Object object)

Implements org.hibernate.id.IdentifierGenerator.generate.

Doc from org.hibernate.id.IdentifierGenerator.generate.

Generate a new identifier.

Parameters
sessionImplementor:SharedSessionContractImplementor

The session from which the request originates

object:Object

the entity or collection (idbag) for which the id is being generated

Returns:Object

a new identifier

Annotations
@Override
getEntityNameback to summary
public String getEntityName()

Getter for property 'entityName'.

Returns:String

Value for property 'entityName'.

getPropertyNameback to summary
public String getPropertyName()

Getter for property 'propertyName'.

Returns:String

Value for property 'propertyName'.

getRoleback to summary
public String getRole()

Getter for property 'role'. Role is the property name qualified by the entity name.

Returns:String

Value for property 'role'.