ForeignGenerator (Hibernate Core Aggregator 3.6.10.Final API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.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

Field Summary
- Fields inherited from interface org.hibernate.id.IdentifierGenerator
  ENTITY_NAME

Constructor Summary

Constructors
Constructor and Description

ForeignGenerator()

Method Summary

Methods
Modifier and Type	Method and Description
`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'.

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
  - getEntityName
```
public String getEntityName()
```
    Getter for property 'entityName'.
    
    Returns:
    Value for property 'entityName'.
  - getPropertyName
```
public String getPropertyName()
```
    Getter for property 'propertyName'.
    
    Returns:
    Value for property 'propertyName'.
  - getRole
```
public String getRole()
```
    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 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.
    
    Specified by:
    
    configure in interface Configurable
    
    params - param values, keyed by parameter name
  - generate
```
public Serializable generate(SessionImplementor sessionImplementor,
                    Object object)
```
    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

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015. All rights reserved.