Module eclipselink
Package org.eclipse.persistence.annotations

Annotation Interface VariableOneToOne

@Target({METHOD,FIELD}) @Retention(RUNTIME) public @interface VariableOneToOne
Variable one to one mappings are used to represent a pointer references between a java object and an implementer of an interface. This mapping is usually represented by a single pointer (stored in an instance variable) between the source and target objects. In the relational database tables, these mappings are normally implemented using a foreign key and a type code.

A VariableOneToOne can be specified within an Entity, MappedSuperclass and Embeddable class.

Author:
Guy Pelletier

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    jakarta.persistence.CascadeType[]
    cascade
    The operations that must be cascaded to the target of the association.
    DiscriminatorClass[]
    discriminatorClasses
    The list of discriminator types that can be used with this VariableOneToOne.
    jakarta.persistence.DiscriminatorColumn
    discriminatorColumn
    The discriminator column will hold the type indicators.
    jakarta.persistence.FetchType
    fetch
    Defines whether the value of the field or property should be lazily loaded or must be eagerly fetched.
    boolean
    optional
    Whether the association is optional.
    boolean
    orphanRemoval
    Whether to apply the remove operation to entities that have been removed from the relationship and to cascade the remove operation to those entities.
    Class<?>
    targetInterface
    The interface class that is the target of the association.

  • Element Details

    • targetInterface

      Class<?> targetInterface
      The interface class that is the target of the association. If not specified it will be inferred from the type of the object being referenced.
      Default:
      void.class

    • cascade

      jakarta.persistence.CascadeType[] cascade
      The operations that must be cascaded to the target of the association.
      Default:
      {}

    • fetch

      jakarta.persistence.FetchType fetch
      Defines whether the value of the field or property should be lazily loaded or must be eagerly fetched. The FetchType.EAGER strategy is a requirement on the persistence provider runtime that the value must be eagerly fetched. The FetchType.LAZY strategy is a hint to the persistence provider runtime. If not specified, defaults to FetchType.EAGER.
      Default:
      EAGER

    • optional

      boolean optional
      Whether the association is optional. If set to false then a non-null relationship must always exist.
      Default:
      true

    • orphanRemoval

      boolean orphanRemoval
      Whether to apply the remove operation to entities that have been removed from the relationship and to cascade the remove operation to those entities.
      Default:
      false

    • discriminatorColumn

      jakarta.persistence.DiscriminatorColumn discriminatorColumn
      The discriminator column will hold the type indicators. If the discriminatorColumn is not specified, the name of the discriminator column defaults to "DTYPE" and the discriminator type to DiscriminatorType.STRING.
      Default:
      @jakarta.persistence.DiscriminatorColumn

    • discriminatorClasses

      DiscriminatorClass[] discriminatorClasses
      The list of discriminator types that can be used with this VariableOneToOne. If none are specified then those entities within the persistence unit that implement the target interface will be added to the list of types. The discriminator type will default as follows:
      Default:
      {}