Package org.hibernate.id

Class ForeignGenerator

java.lang.Object

org.hibernate.id.ForeignGenerator

All Implemented Interfaces:

Serializable, ExportableProducer, BeforeExecutionGenerator, Generator, Configurable, StandardGenerator, IdentifierGenerator

@Deprecated(since="6",
            forRemoval=true)
public class ForeignGenerator
extends Object
implements IdentifierGenerator, StandardGenerator

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

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

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY	Deprecated, for removal: This API element is subject to removal in a future version. The parameter which specifies the property holding a reference to the associated object.

Fields inherited from interface org.hibernate.id.IdentifierGenerator

CONTRIBUTOR_NAME, ENTITY_NAME, GENERATOR_NAME, JPA_ENTITY_NAME

Constructor Summary

Constructors

Constructor	Description
ForeignGenerator()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
void	configure(Type type, Properties parameters, ServiceRegistry serviceRegistry)	Deprecated, for removal: This API element is subject to removal in a future version. Configure this instance, given the value of parameters specified by the user as <param> elements.
Object	generate(SharedSessionContractImplementor sessionImplementor, Object object)	Deprecated, for removal: This API element is subject to removal in a future version. Generate a new identifier.
String	getEntityName()	Deprecated, for removal: This API element is subject to removal in a future version. Getter for property 'entityName'.
String	getPropertyName()	Deprecated, for removal: This API element is subject to removal in a future version. Getter for property 'propertyName'.
String	getRole()	Deprecated, for removal: This API element is subject to removal in a future version. Getter for property 'role'.

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.BeforeExecutionGenerator

generatedOnExecution

Methods inherited from interface org.hibernate.id.Configurable

create, initialize

Methods inherited from interface org.hibernate.generator.Generator

allowAssignedIdentifiers, generatedOnExecution, generatesOnInsert, generatesOnUpdate, generatesSometimes

Methods inherited from interface org.hibernate.id.IdentifierGenerator

generate, getEventTypes, registerExportables, supportsJdbcBatchInserts

Field Details

PROPERTY

public static final String PROPERTY

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

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

See Also:

• Constant Field Values

Constructor Details

ForeignGenerator

public ForeignGenerator()

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

Method Details

getEntityName

public String getEntityName()

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

Getter for property 'entityName'.

Returns:

Value for property 'entityName'.

getPropertyName

public String getPropertyName()

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

Getter for property 'propertyName'.

Returns:

Value for property 'propertyName'.

getRole

public String getRole()

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

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

Returns:

Value for property 'role'.

configure

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

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

Description copied from interface: IdentifierGenerator

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 IdentifierGenerator.registerExportables(Database).

Specified by:

configure in interface Configurable

Specified by:

configure in interface IdentifierGenerator

Parameters:

type - The id property type descriptor

parameters - param values, keyed by parameter name

serviceRegistry - Access to service that may be needed.

Throws:

MappingException - If configuration fails.

generate

public Object generate(SharedSessionContractImplementor sessionImplementor,
 Object object)

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

Description copied from interface: IdentifierGenerator

Generate a new identifier.

Specified by:

generate in interface IdentifierGenerator

Parameters:

sessionImplementor - The session from which the request originates

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

Returns:

a new identifier