Example: Parent/Child
One of the very first things that new users try to do with Hibernate is to model a parent / child type
relationship. There are two different approaches to this. For various reasons the most convenient
approach, especially for new users, is to model both Parent and Child
as entity classes with a <one-to-many> association from Parent
to Child. (The alternative approach is to declare the Child as a
<composite-element>.) Now, it turns out that default semantics of a one to many
association (in Hibernate) are much less close to the usual semantics of a parent / child relationship than
those of a composite element mapping. We will explain how to use a bidirectional one to many
association with cascades to model a parent / child relationship efficiently and elegantly. It's
not at all difficult!
A note about collections
Hibernate collections are considered to be a logical part of their owning entity; never of the
contained entities. This is a crucial distinction! It has the following consequences:
When we remove / add an object from / to a collection, the version number of the collection owner
is incremented.
If an object that was removed from a collection is an instance of a value type (eg, a composite
element), that object will cease to be persistent and its state will be completely removed from
the database. Likewise, adding a value type instance to the collection will cause its state to be
immediately persistent.
On the other hand, if an entity is removed from a collection (a one-to-many or many-to-many
association), it will not be deleted, by default. This behaviour is completely consistent - a
change to the internal state of another entity should not cause the associated entity to vanish!
Likewise, adding an entity to a collection does not cause that entity to become persistent, by
default.
Instead, the default behaviour is that adding an entity to a collection merely creates a link between
the two entities, while removing it removes the link. This is very appropriate for all sorts of cases.
Where it is not appropriate at all is the case of a parent / child relationship, where the life of the
child is bound to the lifecycle of the parent.
Bidirectional one-to-many
Suppose we start with a simple <one-to-many> association from
Parent to Child.
]]>
If we were to execute the following code
Hibernate would issue two SQL statements:
an INSERT to create the record for c
an UPDATE to create the link from p to
c
This is not only inefficient, but also violates any NOT NULL constraint on the
parent_id column.
The underlying cause is that the link (the foreign key parent_id) from
p to c is not considered part of the state of the Child
object and is therefore not created in the INSERT. So the solution is to make the link part
of the Child mapping.
]]>
(We also need to add the parent property to the Child class.)
Now that the Child entity is managing the state of the link, we tell the collection not
to update the link. We use the inverse attribute.
]]>
The following code would be used to add a new Child
And now, only one SQL INSERT would be issued!
To tighten things up a bit, we could create an addChild() method of
Parent.
Now, the code to add a Child looks like
Cascading lifecycle
The explicit call to save() is still annoying. We will address this by
using cascades.
]]>
This simplifies the code above to
Similarly, we don't need to iterate over the children when saving or deleting a Parent.
The following removes p and all its children from the database.
However, this code
will not remove c from the database; it will ony remove the link to p
(and cause a NOT NULL constraint violation, in this case). You need to explicitly
delete() the Child.
Now, in our case, a Child can't really exist without its parent. So if we remove
a Child from the collection, we really do want it to be deleted. For this, we must
use cascade="all-delete-orphan".
]]>
Note: even though the collection mapping specifies inverse="true", cascades are still
processed by iterating the collection elements. So if you require that an object be saved, deleted or
updated by cascade, you must add it to the collection. It is not enough to simply call
setParent().
Using cascading update()
Suppose we loaded up a Parent in one Session, made some changes in a UI
action and wish to persist these changes in a new Session (by calling update()). The
Parent will contain a collection of childen and, since cascading update is enabled, Hibernate
needs to know which children are newly instantiated and which represent existing rows in the database. Lets assume
that both Parent and Child have (synthetic) identifier properties of type
java.lang.Long. Hibernate will use the identifier property value to determine which of the
children are new. (You may also use the version or timestamp property, see
.)
The unsaved-value attribute is used to specify the identifier value of a newly instantiated
instance. unsaved-value defaults to "null", which is perfect for a Long
identifier type. If we would have used a primitive identitifier property, we would need to specify
]]>
for the Child mapping. (There is also an unsaved-value attribute
for version and timestamp property mappings.)
The following code will update parent and child and insert
newChild.
Well, thats all very well for the case of a generated identifier, but what about assigned identifiers
and composite identifiers? This is more difficult, since unsaved-value can't
distinguish between a newly instantiated object (with an identifier assigned by the user) and an object
loaded in a previous session. In these cases, you will probably need to give Hibernate a hint; either
define unsaved-value="null" or unsaved-value="negative"
on a <version> or <timestamp> property
mapping for the class.
set unsaved-value="none" and explicitly save()
newly instantiated children before calling update(parent)
set unsaved-value="any" and explicitly update()
previously persistent children before calling update(parent)
none is the default unsaved-value for assigned and composite
identifiers.
There is one further possibility. There is a new Interceptor method named
isUnsaved() which lets the application implement its own strategy for distinguishing
newly instantiated objects. For example, you could define a base class for your persistent classes.
(The saved property is non-persistent.)
Now implement isUnsaved(), along with onLoad()
and onSave() as follows.
Conclusion
There is quite a bit to digest here and it might look confusing first time around. However, in practice, it
all works out quite nicely. Most Hibernate applications use the parent / child pattern in many places.
We mentioned an alternative in the first paragraph. None of the above issues exist in the case of
<composite-element> mappings, which have exactly the semantics of a parent / child
relationship. Unfortunately, there are two big limitations to composite element classes: composite elements may
not own collections, and they should not be the child of any entity other than the unique parent. (However,
they may have a surrogate primary key, using an <idbag> mapping.)