ForeignGenerator (Hibernate API Documentation) - Hibernate 2.1.8 正式版 API 英文文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.sf.hibernate.id
Class ForeignGenerator

java.lang.Object
  net.sf.hibernate.id.ForeignGenerator

All Implemented Interfaces:: Configurable, IdentifierGenerator

public class ForeignGenerator
extends 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

Constructor Summary

ForeignGenerator()


Method Summary

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 session, 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 Serializable generate(SessionImplementor session,
                             Object object)
                      throws SQLException,
                             HibernateException

Description copied from interface: IdentifierGenerator

Generate a new identifier.

Specified by:: generate in interface IdentifierGenerator

Parameters:: session -; object - the entity or toplevel collection for which the id is being generated
Returns:: Serializable a new identifier
Throws:: SQLException; HibernateException
See Also:: IdentifierGenerator.generate(net.sf.hibernate.engine.SessionImplementor, java.lang.Object)

configure

public void configure(Type type,
                      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

Parameters:: params - param values, keyed by parameter name
Throws:: MappingException
See Also:: Configurable.configure(net.sf.hibernate.type.Type, java.util.Properties, net.sf.hibernate.dialect.Dialect)