13

Say we've got an abstract @Entity Animal, and several entity classes that extend Animal, including Dog, Cat, Monkey and Bat.

How can I filter the results based on the extending entity's class?

Example: There are checkboxes where the user can select which entities to retrieve.

[ ] Dog
[X] Cat
[X] Monkey
[ ] Bat

Now I want to retrieve the entities with a (Named)Query defined in the Animal class. What kind of query parameters can I put into the query so that only the Cat and Monkey objects will be returned?

Kimi
  • 6,239
  • 5
  • 32
  • 49

2 Answers2

33

I'm not absolutely sure it's supported by JPA, but the way to do it in Hibernate, regardless of the inheritance strategy, and thus even if you don't have a discriminator (or didn't map it as a property) is to use the implicit class property :

String jpql = "select a from Animal a where a.class in (:classes)";
Query q = em.createQuery(jpql).setParameter("classes", 
                                            Arrays.asList(Cat.class, Monkey.class));

EDIT :

I just found it's possible in JPA2 using the TYPE operator :

String jpql = "SELECT a FROM Animal a WHERE TYPE(a) IN :classes";
Query q = em.createQuery(jpql).setParameter("classes", 
                                            Arrays.asList(Cat.class, Monkey.class));
Kimi
  • 6,239
  • 5
  • 32
  • 49
JB Nizet
  • 678,734
  • 91
  • 1,224
  • 1,255
4

You can use the discrimnator column and value to only search for certain subtypes of a given type. By default the discriminator column's name is DTYPE in JPA,the type is String and the value is the name of the class. You can however override this by adding the class level annotation @DiscriminatorColumn(name="KIND", discriminatorType=DiscriminatorType.INTEGER) (for the discriminator column's name and type) and @DiscriminatorValue("1") (for the specific discrimiminator value for a certain class). You can then use this in the WHERE clause of yoru JPQL query to only fetch certain subtypes, like: WHERE DTYPE="Dog" OR DTYPE="Cat"

Shivan Dragon
  • 15,004
  • 9
  • 62
  • 103
  • Thank you for your answer! I'll try `... AND a.dtype IN :dtypes ...` where dtypes is a Collection and see how it goes. – Kimi Oct 18 '11 at 13:20
  • If you have troble with that (i.e. with the defaults of dtype=ClassName) try adding the annotations on your subclass to configure a specific discriminator column name and value for each subclass, and then use those values in your queries. – Shivan Dragon Oct 18 '11 at 13:23