-
@Target(value={METHOD,FIELD}) @Retention(value=RUNTIME) public @interface OneToOne
Specifies a single-valued association to another entity that has one-to-one multiplicity. It is not normally necessary to specify the associated target entity explicitly since it can usually be inferred from the type of the object being referenced. If the relationship is bidirectional, the non-owning side must use themappedBy
element of theOneToOne
annotation to specify the relationship field or property of the owning side.The
OneToOne
annotation may be used within an embeddable class to specify a relationship from the embeddable class to an entity class. If the relationship is bidirectional and the entity containing the embeddable class is on the owning side of the relationship, the non-owning side must use themappedBy
element of theOneToOne
annotation to specify the relationship field or property of the embeddable class. The dot (".") notation syntax must be used in themappedBy
element to indicate the relationship attribute within the embedded attribute. The value of each identifier used with the dot notation is the name of the respective embedded field or property.Example 1: One-to-one association that maps a foreign key column // On Customer class: @OneToOne(optional=false) @JoinColumn( name="CUSTREC_ID", unique=true, nullable=false, updatable=false) public CustomerRecord getCustomerRecord() { return customerRecord; } // On CustomerRecord class: @OneToOne(optional=false, mappedBy="customerRecord") public Customer getCustomer() { return customer; } Example 2: One-to-one association that assumes both the source and target share the same primary key values. // On Employee class: @Entity public class Employee { @Id Integer id; @OneToOne @MapsId EmployeeInfo info; ... } // On EmployeeInfo class: @Entity public class EmployeeInfo { @Id Integer id; ... } Example 3: One-to-one association from an embeddable class to another entity. @Entity public class Employee { @Id int id; @Embedded LocationDetails location; ... } @Embeddable public class LocationDetails { int officeNumber; @OneToOne ParkingSpot parkingSpot; ... } @Entity public class ParkingSpot { @Id int id; String garage; @OneToOne(mappedBy="location.parkingSpot") Employee assignedTo; ... }
- Since:
- Java Persistence 1.0
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element and Description CascadeType[]
cascade
(Optional) The operations that must be cascaded to the target of the association.FetchType
fetch
(Optional) Whether the association should be lazily loaded or must be eagerly fetched.String
mappedBy
(Optional) The field that owns the relationship.boolean
optional
(Optional) Whether the association is optional.boolean
orphanRemoval
(Optional) 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
targetEntity
(Optional) The entity class that is the target of the association.
-
-
-
Element Detail
-
targetEntity
public abstract Class targetEntity
(Optional) The entity class that is the target of the association.Defaults to the type of the field or property that stores the association.
- Default:
- void.class
-
-
-
cascade
public abstract CascadeType[] cascade
(Optional) The operations that must be cascaded to the target of the association.By default no operations are cascaded.
- Default:
- {}
-
-
-
fetch
public abstract FetchType fetch
(Optional) Whether the association should be lazily loaded or must be eagerly fetched. The EAGER strategy is a requirement on the persistence provider runtime that the associated entity must be eagerly fetched. The LAZY strategy is a hint to the persistence provider runtime.- Default:
- javax.persistence.FetchType.EAGER
-
-
-
optional
public abstract boolean optional
(Optional) Whether the association is optional. If set to false then a non-null relationship must always exist.- Default:
- true
-
-
-
mappedBy
public abstract String mappedBy
(Optional) The field that owns the relationship. This element is only specified on the inverse (non-owning) side of the association.- Default:
- ""
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/persistence/OneToOne.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.