74

I am using Play Framework 1.2.4 with PostgreSQL and JPA. I would like to have a Model hierarchy and see that there are some alternatives to doing this.

I have a base class (which is abstract) and two concrete classes extending this base class. I don't want to persist this base class while I want to have concrete classes. In the base class, I have another Model classes as properties, in other words, I have @ManyToOne relationships in my base class.

My question is what is the best way of implementing this? Using @MappedSuperclass or @Inheritance with TABLE_PER_CLASS strategy? I am a bit confused as they seem virtually equivalent.

I also have some concerns about querying and performance issues that I might face in future.

Cœur
  • 37,241
  • 25
  • 195
  • 267
huzeyfe
  • 3,554
  • 6
  • 39
  • 49

2 Answers2

166

MappedSuperClass must be used to inherit properties, associations, and methods.

Entity inheritance must be used when you have an entity, and several sub-entities.

You can tell if you need one or the other by answering this questions: is there some other entity in the model which could have an association with the base class?

If yes, then the base class is in fact an entity, and you should use entity inheritance. If no, then the base class is in fact a class that contains attributes and methods that are common to several unrelated entities, and you should use a mapped superclass.

For example:

  • You can have several kinds of messages: SMS messages, email messages, or phone messages. And a person has a list of messages. You can also have a reminder linked to a message, regardless of the kind of message. In this case, Message is clearly an entity, and entity inheritance must be used.
  • All your domain objects could have a creation date, modification date and ID, and you could thus make them inherit from a base AbstractDomainObject class. But no entity will ever have an association to an AbstractDomainObject. It will always be an association to a more specific entity: Customer, Company, whatever. In this case, it makes sense to use a MappedSuperClass.
JB Nizet
  • 678,734
  • 91
  • 1,224
  • 1,255
  • Many thanks for your answer. I am now clear on that if I need to persist or use base class as an entity I should use entity inheritance. I wonder if there is a problem with performance or restriction on queries especially using inherited object relations? – huzeyfe Mar 12 '12 at 15:32
  • It all depends on which kind of inheritance you choose, and which inheritance strategy. – JB Nizet Mar 12 '12 at 15:34
  • In my case (as I don't want to persist base class) MappedSuperClass seem more suitable. So in terms of performance and restrictions do I need to be aware of some certain issues? – huzeyfe Mar 12 '12 at 15:38
  • 4
    No. It will work exactly as if the mapped superclass attributes were in the entity directly. – JB Nizet Mar 12 '12 at 16:19
39

@MappedSupperclass is different than the @Inheritance annotation.

@MappedSuperclass tells the JPA provider to include the base class persistent properties as if they were declared by the child class extending the superclass annotated with @MappedSuperclass.

However, the inheritance is only visible in the OOP world, since, from a database perspective, there's no indication of the base class. Only the child class entity will have an associated mapped table.

The @Inheritance annotation is meant to materialize the OOP inheritance model in the database table structure. More, you can query a base class annotated with @Inheritance but you can't do that for a base class annotated with @MappedSuperclass.

Now, the reason why you'd want to use the @Inheritance JPA annotation is to implement behavior-driven patterns like the Strategy Pattern.

On the other hand, @MappedSuperclass is just a way to reuse both basic properties, associations, and even the entity @Id using a common base class. Nevertheless, you can achieve almost the same goal using an @Embeddable type. The only major difference is that you can't reuse an @Id definition with @Embeddable, but you can do it with @MappedSuperclass.

Vlad Mihalcea
  • 142,745
  • 71
  • 566
  • 911
  • 4
    "The only major difference is that you can't reuse an Id definition with Embeddable, but you can do it with MappedSuperclass" thank you, I have been trying to find this for almost an hour. – Bahattin Ungormus Mar 19 '18 at 14:57
  • The great thing about '@Inheritance' is, that we can use polymorphic queries. Setting '@Inheritance' to TABLE_PER_CLASS, what's a difference between that and '@MappedSuperclass'? – Serafins Dec 04 '20 at 12:47
  • 1
    TABLE_PER_CLASS is very inefficient due to the UNION ALL queries. Better use SINGLE_TABLE or JOINED, as explained in my [High-Performance Java Persistence book](https://vladmihalcea.com/books/high-performance-java-persistence/). – Vlad Mihalcea Dec 04 '20 at 13:25
  • THANK YOU, makes it much clearer – Julio Faerman Feb 09 '22 at 22:09
  • @JulioFaerman I'm glad I could help – Vlad Mihalcea Feb 10 '22 at 06:48
  • can mapped super class be used in a situation where i have multiple tables with different names but exactly same data with different column names ? ( country column is named domicile in one table and jurisdiction in the other . both carries country names but just different column names ) – Sithija Piyuman Thewa Hettige Jun 01 '23 at 06:30
  • Yes, you can use `@AttributeOverride` as explained in [this answer](https://stackoverflow.com/a/5258090/1025118). – Vlad Mihalcea Jun 01 '23 at 12:00