Package org.hibernate.id

Class ForeignGenerator

java.lang.Object
org.hibernate.id.ForeignGenerator
All Implemented Interfaces:
Serializable, ExportableProducer, BeforeExecutionGenerator, Generator, Configurable, IdentifierGenerator
@Deprecated(since="6", forRemoval=true) public class ForeignGenerator extends Object implements IdentifierGenerator
Deprecated, for removal: This API element is subject to removal in a future version.
This remains around as an implementation detail of hbm.xml mappings.
The legacy id generator named foreign.

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

One mapping parameter is required: "property".

See Also:

  • Field Details

    • PROPERTY

      public static final String PROPERTY
      Deprecated, for removal: This API element is subject to removal in a future version.
      The parameter which specifies the property holding a reference to the associated object.
      See Also:

  • Constructor Details

    • ForeignGenerator

      public ForeignGenerator()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • getEntityName

      public String getEntityName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Getter for property 'entityName'.
      Returns:
      Value for property 'entityName'.

    • getPropertyName

      public String getPropertyName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Getter for property 'propertyName'.
      Returns:
      Value for property 'propertyName'.

    • getRole

      public String getRole()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Getter for property 'role'. Role is the property name qualified by the entity name.
      Returns:
      Value for property 'role'.

    • configure

      public void configure(GeneratorCreationContext creationContext, Properties parameters) throws MappingException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Configurable
      Configure this instance, given the value of parameters specified by the user as XML <param> elements and @Parameter annotations.

      This method is called just once, following instantiation. If this instance also implements ExportableProducer, then this method is always called before ExportableProducer.registerExportables(Database),

      Specified by:
      configure in interface Configurable
      Parameters:
      creationContext - Access to the generator creation context
      parameters - param values, keyed by parameter name
      Throws:
      MappingException - when there's something wrong with the given parameters

    • generate

      public Object generate(SharedSessionContractImplementor sessionImplementor, Object object)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: IdentifierGenerator
      Generate a new identifier.
      Specified by:
      generate in interface IdentifierGenerator
      Parameters:
      sessionImplementor - The session from which the request originates
      object - the entity or collection (idbag) for which the id is being generated
      Returns:
      a new identifier

    • allowAssignedIdentifiers

      public boolean allowAssignedIdentifiers()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: Generator
      Determine if this generator allows identifier values to be manually assigned to the entity instance before persisting it. This is useful when, for example, needing existing assigned values to be used as identifiers and falling back to generated values by default.
      Specified by:
      allowAssignedIdentifiers in interface Generator
      Returns:
      true if this generator allows pre-assigned identifier values, false otherwise (default).