public class

ForeignGenerator

extends Object
implements Configurable IdentifierGenerator
java.lang.Object
   ↳ org.hibernate.id.ForeignGenerator

Class Overview

foreign

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

One mapping parameter is required: property.

Summary

[Expand]
Inherited Constants
From interface org.hibernate.id.IdentifierGenerator
Public Constructors
ForeignGenerator()
Public Methods
void configure(Type type, Properties params, Dialect d)
Configure this instance, given the value of parameters specified by the user as <param> elements.
Serializable generate(SessionImplementor sessionImplementor, Object object)
Generate a new identifier.
String getEntityName()
Getter for property 'entityName'.
String getPropertyName()
Getter for property 'propertyName'.
String getRole()
Getter for property 'role'.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.hibernate.id.Configurable
From interface org.hibernate.id.IdentifierGenerator

Public Constructors

public ForeignGenerator ()

Public Methods

public void configure (Type type, Properties params, Dialect d)

Configure this instance, given the value of parameters specified by the user as <param> elements. This method is called just once, following instantiation.

Parameters
params param values, keyed by parameter name

public Serializable generate (SessionImplementor sessionImplementor, Object object)

Generate a new identifier.

Parameters
object the entity or toplevel collection for which the id is being generated
Returns
  • a new identifier

public String getEntityName ()

Getter for property 'entityName'.

Returns
  • Value for property 'entityName'.

public String getPropertyName ()

Getter for property 'propertyName'.

Returns
  • Value for property 'propertyName'.

public String getRole ()

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

Returns
  • Value for property 'role'.