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

From Eclipsepedia

Jump to: navigation, search
(New page: {{EclipseLink_UserGuide |info=y |toc=n |eclipselink=y |eclipselinktype=JPA |api=y |apis= * [http://www.eclipse.org/eclipselink/api/latest/javax/persistence/MappedSuperclass.html @MappedSup...)
 
Line 8: Line 8:
 
* [http://www.eclipse.org/eclipselink/api/latest/javax/persistence/MappedSuperclass.html @MappedSuperclass]
 
* [http://www.eclipse.org/eclipselink/api/latest/javax/persistence/MappedSuperclass.html @MappedSuperclass]
 
* [http://www.eclipse.org/eclipselink/api/latest/javax/persistence/AttributeOverride.html @AttributeOverride]
 
* [http://www.eclipse.org/eclipselink/api/latest/javax/persistence/AttributeOverride.html @AttributeOverride]
 +
* [http://www.eclipse.org/eclipselink/api/latest/javax/persistence/AssociationOverride.html @AssociationOverride]
 
|examples=y
 
|examples=y
 
|example=
 
|example=
* [[EclipseLink/Examples/JPA/Inheritance|How to Define Inheritance]]
 
 
* [[EclipseLink/Examples/JPA/Inheritance#Inheritance_Examples|Advanced Inheritance Examples]]
 
* [[EclipseLink/Examples/JPA/Inheritance#Inheritance_Examples|Advanced Inheritance Examples]]
 
}}
 
}}
  
 
=@MappedSuperclass=
 
=@MappedSuperclass=
You can use the <tt>@Inheritance</tt> annotation or <code><nowiki><inheritance></nowiki></code> XML element to configure how entities with inheritance are persisted. 
+
You can use the <tt>@MappedSuperclass</tt> annotation or <code><nowiki><mapped-superclass></nowiki></code> XML element to define mappings for an abstract or non-persistent superclass, that are inherited by its subclass entities.   
JPA defines three inheritance strategies <code>SINGLE_TABLE</code>, <code>JOINED</code>, and <code>TABLE_PER_CLASS</code>.  By default the <code>SINGLE_TABLE</code> strategy is used and all of the subclasses are persisted in a single table that contains all of the column of all of the subclassesIn addition a discriminator column named <code>DTYPE</code> is required in the table to store the class type.
+
  
For other inheritance strategies see [[#Advanced Inheritance Configuration|Advanced Inheritance Configuration]].
 
 
The <tt>@Inheritance</tt> annotation has the following attributes:
 
<ul>
 
<li> <tt>strategy</tt> – By default, the EclipseLink persistence provider assumes that all the classes in a hierarchy are mapped to a single table differentiated by the discriminator value (see [[#@DiscriminatorValue|@DiscriminatorValue]]) in the table's discriminator column (see [[#@DiscriminatorColumn|@DiscriminatorColumn]]): <tt>InheritanceType.SINGLE_TABLE</tt>.<br>If this is not appropriate for your application or if you must match an existing data model, set <tt>strategy</tt> to the desired <tt>InheritanceType</tt> enumerated type:
 
<ul><li> <tt>SINGLE_TABLE</tt> – all the classes in a hierarchy are mapped to a single table. The table has a discriminator column ([[#@DiscriminatorColumn Attributes|@DiscriminatorColumn]]) whose value ([[#@DiscriminatorValue|@DiscriminatorValue]]) identifies the specific subclass to which the instance that is represented by the row belongs.<br>
 
{{EclipseLink_Note|note=This option provides the best support for both polymorphic relationships between entities and queries that range over the class hierarchy. The disadvantages of this option include the need to make nullable columns that should be <tt>NOT NULL</tt>.}}<br>
 
<li> <tt>TABLE_PER_CLASS</tt> – each class is mapped to a separate table. All properties of the class, including inherited properties, are mapped to columns of the table for the class.
 
{{EclipseLink_Note|note=This option has several limitations when querying or having relationships to the root or branch classes.  Joins to root or branch classes are not supported.}}
 
<li> <tt>JOINED</tt> – the root of the class hierarchy is represented by a single table and each subclass is represented by a separate table. Each subclass table contains only those fields that are specific to the subclass (not inherited from its superclass) and primary key columns that serve as foreign keys to the primary keys of the superclass table.  The join from the primary table to the subclass table can be configured using the <code>@PrimaryKeyJoinColumn</code>, see [[EclipseLink/UserGuide/JPA/Basic JPA Development/Entities/SecondaryTable|SecondaryTable]] for more info.  If you have multiple levels of inheritance, each subclass table should join with the root table, and the discriminator column is only defined once in the root table.
 
</ul></ul>
 
  
 
{{EclipseLink_Spec|section=Section 2.1.9 "Inheritance"}}
 
{{EclipseLink_Spec|section=Section 2.1.9 "Inheritance"}}
{{EclipseLink_Spec|section=Section 9.1.29 "Inheritance Annotation"}}
+
{{EclipseLink_Spec|section=Section 9.1.x "MappedSuperclassAnnotation"}}
  
===@DiscriminatorColumn===
+
===@AttributeOverride===
 
You can use the <tt>@DiscriminatorColumn</tt> annotation or <code><nowiki><discriminator-column></nowiki></code> XML element to configure the name or type of the inheritance discriminator column.  The discriminator column is required for <code>SINGLE_TABLE</code> and <code>JOINED</code> inheritance and stores the associated entity type for the row.  The default name for the discriminator column is <code>DTYPE</code>.  JPA only allows String or Integer values for discriminators.  Through the EclipseLink API, it is possible to use other discriminator types, and it is possible to not have a discriminator, or use custom discriminator, see [[#Advanced Inheritance Configuration|Advanced Inheritance Configuration]].
 
You can use the <tt>@DiscriminatorColumn</tt> annotation or <code><nowiki><discriminator-column></nowiki></code> XML element to configure the name or type of the inheritance discriminator column.  The discriminator column is required for <code>SINGLE_TABLE</code> and <code>JOINED</code> inheritance and stores the associated entity type for the row.  The default name for the discriminator column is <code>DTYPE</code>.  JPA only allows String or Integer values for discriminators.  Through the EclipseLink API, it is possible to use other discriminator types, and it is possible to not have a discriminator, or use custom discriminator, see [[#Advanced Inheritance Configuration|Advanced Inheritance Configuration]].
  
Line 65: Line 53:
 
{{EclipseLink_Spec|section=Section 11.1.10 "DiscriminatorColumn Annotation"}}
 
{{EclipseLink_Spec|section=Section 11.1.10 "DiscriminatorColumn Annotation"}}
  
===@DiscriminatorValue===
+
===@AssociationOverride===
 
You can use the <tt>@DiscriminatorValue</tt> annotation or <code><nowiki><discriminator-value></nowiki></code> XML element to configure the value of the inheritance discriminator.  The discriminator value can be specified in each non-abstract class in the inheritance hierarchy.  By default the discriminator value is the entity's name, which defaults to its unprefixed class name.  The discriminator value is always specified as a String, but is converted to the discriminator column type.
 
You can use the <tt>@DiscriminatorValue</tt> annotation or <code><nowiki><discriminator-value></nowiki></code> XML element to configure the value of the inheritance discriminator.  The discriminator value can be specified in each non-abstract class in the inheritance hierarchy.  By default the discriminator value is the entity's name, which defaults to its unprefixed class name.  The discriminator value is always specified as a String, but is converted to the discriminator column type.
  

Revision as of 13:47, 30 June 2011

EclipseLink JPA


@MappedSuperclass

You can use the @MappedSuperclass annotation or <mapped-superclass> XML element to define mappings for an abstract or non-persistent superclass, that are inherited by its subclass entities.


Elug javaspec icon.gif

For more information, see Section 2.1.9 "Inheritance" in the JPA Specification.

Elug javaspec icon.gif

For more information, see Section 9.1.x "MappedSuperclassAnnotation" in the JPA Specification.

@AttributeOverride

You can use the @DiscriminatorColumn annotation or <discriminator-column> XML element to configure the name or type of the inheritance discriminator column. The discriminator column is required for SINGLE_TABLE and JOINED inheritance and stores the associated entity type for the row. The default name for the discriminator column is DTYPE. JPA only allows String or Integer values for discriminators. Through the EclipseLink API, it is possible to use other discriminator types, and it is possible to not have a discriminator, or use custom discriminator, see Advanced Inheritance Configuration.

@DiscriminatorColumn Attributes
Attribute Description Default Required?
name The name of column to be used to store the class discriminator value. DTYPE No
discriminatorType The type of the discriminator value, defined in DiscriminatorType, one of STRING, INTEGER, and CHAR. STRING No
columnDefinition Optional column description for use with DDL generation. generated base on discriminatorType No
length The size of the column for DDL generation. Only relevant for STRING types. 31 No
Elug javaspec icon.gif

For more information, see Section 11.1.10 "DiscriminatorColumn Annotation" in the JPA Specification.

@AssociationOverride

You can use the @DiscriminatorValue annotation or <discriminator-value> XML element to configure the value of the inheritance discriminator. The discriminator value can be specified in each non-abstract class in the inheritance hierarchy. By default the discriminator value is the entity's name, which defaults to its unprefixed class name. The discriminator value is always specified as a String, but is converted to the discriminator column type.


The following examples shows usages of the three different inheritance strategies for mapping an Account hierarchy.

Example: Using SINGLE_TABLE with @Inheritance annotation
CREATE TABLE ACCOUNT (ID NUMBER, ACCOUNT_TYPE VARCHAR(31), BALANCE NUMBER, INTERESTRATE NUMBER, RETURNCHECKS BOOLEAN)
@Entity
@Table(name="ACCOUNT")
@Inheritance(strategy=InheritanceType.SINGLE_TABLE)
@DiscriminatorColumn(name="ACCOUNT_TYPE")
public abstract class Account implements Serializable {
    @Id
    private Long id;
    @Basic
    private BigDecimal balance;
    ...
}
@Entity
@DiscriminatorValue("SAVINGS")
public class SavingAccount extends Account {
    @Basic
    private BigDecimal interestRate;
}
@Entity
@DiscriminatorValue("CHECKING")
public class CheckingAccount extends Account {
    @Basic
    private boolean returnChecks;
}
Example: Using SINGLE_TABLE with <inheritance> XML
<entity class="Account">
    <table name="ACCOUNT"/>
    <inheritance strategy="SINGLE_TABLE"/>
    <discriminator-column name="ACCOUNT_TYPE"/>
    <attributes>
        <id name="id"/>
        <basic name="balance"/>
    </attributes>
</entity>
<entity class="SavingAccount">
    <discriminator-value>SAVINGS</discriminator-value>
    <attributes>
        <basic name="interestRate"/>
    </attributes>
</entity>
<entity class="CheckingAccount">
    <discriminator-value>CHECKING</discriminator-value>
    <attributes>
        <basic name="returnChecks"/>
    </attributes>
</entity>


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