org.hibernate.id
Class ForeignGenerator

java.lang.Object
  org.hibernate.id.ForeignGenerator

All Implemented Interfaces:

Configurable, IdentifierGenerator

public class ForeignGenerator
extends java.lang.Object
implements IdentifierGenerator, Configurable

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

Fields inherited from interface org.hibernate.id.IdentifierGenerator

ENTITY_NAME

Constructor Summary

ForeignGenerator()

Method Summary

void	configure(Type type, java.util.Properties params, Dialect d) Configure this instance, given the value of parameters specified by the user as <param> elements.
java.io.Serializable	generate(SessionImplementor sessionImplementor, java.lang.Object object) Generate a new identifier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ForeignGenerator

public ForeignGenerator()

Method Detail

generate

public java.io.Serializable generate(SessionImplementor sessionImplementor,
                                     java.lang.Object object)
                              throws HibernateException

Description copied from interface: IdentifierGenerator

Generate a new identifier.

Specified by:

generate in interface IdentifierGenerator

object - the entity or toplevel collection for which the id is being generated

Returns:

a new identifier

Throws:

HibernateException

See Also:

IdentifierGenerator.generate(org.hibernate.engine.SessionImplementor, java.lang.Object)

configure

public void configure(Type type,
                      java.util.Properties params,
                      Dialect d)
               throws MappingException

Description copied from interface: Configurable

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

Specified by:

configure in interface Configurable

params - param values, keyed by parameter name

Throws:

MappingException

See Also:

Configurable.configure(org.hibernate.type.Type, java.util.Properties, org.hibernate.dialect.Dialect)