An IIdentifierGenerator that uses the value of the id property of an associated object

Namespace:  NHibernate.Id
Assembly:  NHibernate (in NHibernate.dll)

Syntax

Visual Basic (Declaration)
Public Class ForeignGenerator _
	Implements IIdentifierGenerator, IConfigurable
C#
public class ForeignGenerator : IIdentifierGenerator, 
	IConfigurable
Visual C++
public ref class ForeignGenerator : IIdentifierGenerator, 
	IConfigurable
JavaScript
NHibernate.Id.ForeignGenerator = function();

Type.createClass(
	'NHibernate.Id.ForeignGenerator',
	null,
	NHibernate.Id.IIdentifierGenerator,
	NHibernate.Id.IConfigurable);

Remarks

This id generation strategy is specified in the mapping file as

 Copy Code
            <generator class="foreign">
            	<param name="property">AssociatedObject</param>
            </generator>
            

The mapping parameter property is required.

Inheritance Hierarchy

System..::.Object
  NHibernate.Id..::.ForeignGenerator

See Also