Difference between @MapKey, @MapKeyColumn and @MapKeyJoinColumn in JPA and Hibernate

by

When you use a Map you always need to associate at least two entities. Let’s say we have an Owner entity that relates to the Car entity (Car has a FK to Owner).

So, the Owner will have a Map of Car(s):

Map<X, Car>

@MapKey

The @MapKey will give you the Car's property used to group a Car to its Owner. For instance, if we have a vin (Vehicle Identification Number) property in Car, we could use it as the carMap key:

@Entity
public class Owner {
    @Id
    private long id;

    @OneToMany(mappedBy="owner")
    @MapKey(name = "vin")
    private Map<String, Car> carMap;
}

@Entity
public class Car {
    @Id
    private long id;

    @ManyToOne
    private Owner owner;

    private String vin;

}

@MapKeyEnumerated

The @MapKeyEnumerated will use an Enum from Car, like WheelDrive:

@Entity
public class Owner {
    @Id
    private long id;

    @OneToMany(mappedBy="owner")
    @MapKeyEnumerated(EnumType.STRING)
    private Map<WheelDrive, Car> carMap;
}

@Entity
public class Car {
    @Id
    private long id;

    @ManyToOne
    private Owner owner;

    @Column(name = "wheelDrive")
    @Enumerated(EnumType.STRING)
    private WheelDrive wheelDrive;

}

public enum WheelDrive {
    2WD, 
    4WD;             
}

This will group cars by their WheelDrive type.

@MapKeyTemporal

The @MapKeyTemporal will use a Date/Calendar field for grouping, like createdOn.

@Entity
public class Owner {
    @Id
    private long id;

    @OneToMany(mappedBy="owner")
    @MapKeyTemporal(TemporalType.TIMESTAMP)
    private Map<Date, Car> carMap;
}

@Entity
public class Car {
    @Id
    private long id;

    @ManyToOne
    private Owner owner;

    @Temporal(TemporalType.TIMESTAMP)
    @Column(name="created_on")
    private Calendar createdOn;         
}

@MapKeyJoinColumn

The @MapKeyJoinColumn requires a third entity, like Manufacturer so that you have an association from Owner to Car and car has also an association to a Manufacturer, so that you can group all Owner's Cars by Manufacturer:

@Entity
public class Owner {
    @Id
    private long id;

    @OneToMany(mappedBy="owner")
    @MapKeyJoinColumn(name="manufacturer_id")
    private Map<Manufacturer, Car> carMap;
}

@Entity
public class Car {
    @Id
    private long id;

    @ManyToOne
    private Owner owner;

    @ManyToOne
    @JoinColumn(name = "manufacturer_id")
    private Manufacturer manufacturer;          
}

@Entity
public class Manufacturer {
    @Id
    private long id;

    private String name;
}

More Related Contents:

  1. How to map calculated properties with JPA and Hibernate
  2. Hibernate throws strange error: Class is not mapped
  3. Difference between FetchType LAZY and EAGER in Java Persistence API?
  4. How to map a composite key with JPA and Hibernate?
  5. How to map an entity field whose name is a reserved word in JPA
  6. Do I need elements in persistence.xml?
  7. What’s the difference between JPA and Hibernate? [closed]
  8. What is the “owning side” in an ORM mapping?
  9. What is the solution for the N+1 issue in JPA and Hibernate?
  10. Can someone explain mappedBy in JPA and Hibernate?
  11. JPA CascadeType.ALL does not delete orphans
  12. What is the difference between persist() and merge() in JPA and Hibernate?
  13. When and why JPA entities should implement the Serializable interface?
  14. JPQL Create new Object In Select Statement – avoid or embrace?
  15. What is the difference between Unidirectional and Bidirectional JPA and Hibernate associations?
  16. How to remove entity with ManyToMany relationship in JPA (and corresponding join table rows)?
  17. JPA/Hibernate Native Queries do not recognize Parameters
  18. How to solve the LazyInitializationException when using JPA and Hibernate
  19. Getting Database connection in pure JPA setup
  20. In which case do you use the JPA @JoinTable annotation?
  21. How do I properly cascade save a one-to-one, bidirectional relationship on primary key in Hibernate 3.6
  22. JPA: Implementing Model Hierarchy – @MappedSuperclass vs. @Inheritance
  23. Is it possible to dynamically define column names in Hibernate / JPA?
  24. Doing an “IN” query with Hibernate
  25. Specifying an Index (Non-Unique Key) Using JPA
  26. The onFlushDirty Hibernate Interceptor method is never called
  27. Batch inserts with JPA/EJB3
  28. Hibernate vs JPA vs JDO – pros and cons of each? [closed]
  29. Clarifying terminology – What does “hydrating” a JPA or Hibernate entity mean when fetching the entity from the DB
  30. org.hibernate.loader.MultipleBagFetchException: cannot simultaneously fetch multiple bags

Leave a Comment