Difference between revisions of "EclipseLink/UserGuide/JPA/Basic JPA Development/Entities/Embeddable"

From Eclipsepedia

Jump to: navigation, search
(Example: Using @MappedSuperClass annotation)
Line 77: Line 77:
  
 
<span id="Example: @MappedSuperClass"></span>
 
<span id="Example: @MappedSuperClass"></span>
======''Example: Using @MappedSuperClass annotation''======
+
======''Example: Using @Embeddable annotation''======
  
 
<source lang="java">
 
<source lang="java">
@MappedSuperclass
+
@Embeddable
public abstract class PersistentObject implements Serializable {
+
public class EmployeementStatus implements Serializable {
     @Id
+
     @Basic
     private Long id;
+
     private String status;
    @Version
+
    private Long version;
+
    ...
+
}
+
</source>
+
 
+
<source lang="java">
+
@Entity
+
@Table("EMP")
+
public class Employee extends PersistentObject {
+
 
     @Basic
 
     @Basic
     private String name;
+
     private String level;
 +
    @Basic
 +
    private java.sql.Date startDate;
 +
    @Basic
 +
    private java.sql.Date endDate;
 
     ...
 
     ...
 
}
 
}
Line 102: Line 96:
 
<source lang="java">
 
<source lang="java">
 
@Entity
 
@Entity
@Table("PROJECT")
+
public class Employee implements Serializable {
@AttributeOverride(name="id" column=@Column(name="PROJ_ID"))
+
    @Id
public class Project extends PersistentObject {
+
    private Long id;
 
     @Basic
 
     @Basic
 
     private String name;
 
     private String name;
 +
    @Embedded
 +
    private EmployeementStatus status;
 
     ...
 
     ...
 
}
 
}

Revision as of 11:37, 28 July 2011

EclipseLink JPA


@Embeddable

You can use the @Embeddable annotation or <embeddable> XML element to map an embedded class. An embeddable is a special type of class that is not directly persistent, but persisted only with its parent entity. An embeddable has no persistent identity, and no Id mapping. An embeddable can contain any type of attribute mapping including @Basic, @OneToOne, @ManyToOne, @OneToMany, @ManyToMany, @ElementCollection or another @Embedded. Embeddables cannot contain an @Id mapping.

An embeddable can be used to define an entities Id, normally in the case of a composite id. The id attributes in the embeddable will be mapped as @Basic not as @Id, as all attributes are required to be part of the @Id. The parent entity will use the @EmbeddedId to map the embeddeable instead of the @Embedded mapping.

An embeddable can be referenced from an entity or another embeddable using the @Embedded annotation for a single reference, or the @ElementCollection annotation for a Collection or Map reference. An embeddable can also be used in any Map key using the @MapKeyClass annotation.

Embeddables do not currently support the @Inheritance annotation, but inheritance is support in EclipseLink through usage of a DescriptorCustomizer.

An Embbeddable cannot define a @Table annotation, and the columns used in its mappings are be default the names of the column is its parent's table. If the embeddable class is shared with multiple parents, then each parent can override the column names using the @AttributeOverride and @AssociationOverride annotations.

The @Embeddable annotation does not have any attributes.

Elug javaspec icon.gif

For more information, see Section 2.5 "Embeddable Classes" in the JPA Specification.

Elug javaspec icon.gif

For more information, see Section 11.1.13 "Embeddable Annotation" in the JPA Specification.

@AttributeOverride

You can use the @AttributeOverride and @AttributeOverrides annotations, or <attribute-override> XML element to override the column for a basic attribute in an embedded relationship mapping. This allows for the column name to be different if the embeddable class is used by more than entity or if an entity defines multiple embedded relationships.

@AttributeOverride Attributes
Attribute Description Default Required?
name The name of the attribute. Yes
column The column in the source table for the embedded relationship. column defined in embeddable No
Elug javaspec icon.gif

For more information, see Section 11.1.4 "AttributeOverride Annotation" in the JPA Specification.

@AssociationOverride

You can use the @AssociationOverride and @AssociationOverrides annotations, or <association-override> XML element to override the join column or join table for a relationship attribute in an embedded relationship mapping. This allows for the join column name to be different if the embeddable class is used by more than entity or if an entity defines multiple embedded relationships.

@AssociationOverrideAttributes
Attribute Description Default Required?
name The name of the attribute. Yes
joinColumn The join column in the source table for the embedded relationship. join column defined in embeddable No
joinTable The join table for the subclass. join table defined in embeddable No
Elug javaspec icon.gif

For more information, see Section 11.1.2 "AssociationOverride Annotation" in the JPA Specification.

The following example shows usage of an embbeddable.

Example: Using @Embeddable annotation
@Embeddable 
public class EmployeementStatus implements Serializable {
    @Basic
    private String status;
    @Basic
    private String level;
    @Basic
    private java.sql.Date startDate;
    @Basic
    private java.sql.Date endDate;
    ...
}
@Entity
public class Employee implements Serializable {
    @Id
    private Long id;
    @Basic
    private String name;
    @Embedded
    private EmployeementStatus status;
    ...
}
Example: Using <mapped-superclass> XML
<mapped-superclass class="PersistentObject">
    <attributes>
        <id name="id"/>
        <version name="version"/>
    </attributes>
</mapped-superclass>
<entity class="Employee">
    <table name="EMP">
    <attributes>
        <basic name="name"/>
        ...
    </attributes>
</entity>
<entity class="Project">
    <table name="PROJECT">
    <attribute-override name="id">
        <column name="PROJ_ID"/>
    </attribute-override>
    <attributes>
        ...
    </attributes>
</entity>


Eclipselink-logo.gif
Version: 2.2.0 DRAFT
Other versions...