Chapter 4, Entity of the JPA Overview discusses persistent class basics in JPA. Chapter 4, PersistenceCapable of the JDO Overview does the same for JDO. This chapter details the persistent class features Kodo offers beyond the core JPA and JDO specifications.
Unlike many ORM products, Kodo does not need to know about all of your persistent classes at startup. Kodo discovers new persistent classes automatically as they are loaded into the JVM; in fact you can introduce new persistent classes into running applications under Kodo. However, there are certain situations in which providing Kodo with a persistent class list is helpful:
Kodo must be able to match entity names in JPQL queries to persistent classes. Kodo automatically knows the entity names of any persistent classes already loaded into the JVM. To match entity names to classes that have not been loaded, however, you must supply a persistent class list.
application identity, Kodo must be able to match an
identity object passed to the
to the corresponding persistent class. If the
persistent class hasn't been loaded into the JVM yet, Kodo will
not be able to find it. One workaround for this is to
load your persistent class within your identity class' static
initializer, as demonstrated in
Example 4.5, “Application Identity Class” of the
When Kodo manipulates classes in a persistent inheritance hierarchy, Kodo must be aware of all the classes in the hierarchy. If some of the classes have not been loaded into the JVM yet, Kodo may not know about them, and queries may return incorrect results.
If you use JDO's
class-name discriminator strategy, Kodo will
discover all persistent classes in the hierarchy on its own by
SELECT DISTINCT against the
database discriminator column; however, this can be inefficient
for a large table. Thus it may still be preferable to provide
a persistent types list, as described below.
If you configure Kodo to create the needed database schema on startup (see Section 7.1.4, “Runtime Forward Mapping”), Kodo must know all of your persistent classes up-front.
When any of these conditions are a factor in your JPA
application, use the
jar-file elements of
JPA's standard XML format to list your
persistent classes. See
Section 6.1, “persistence.xml” for details.
Kodo allows you to explicitly specify all of your persistent
classes in the various attributes of the
kodo.MetaDataFactory configuration property.
See Section 6.2, “Metadata Factory” for details.
Listing persistent classes (or their metadata or jar files) is an all-or-nothing endeavor. If your persistent class list is non-empty, Kodo will assume that any unlisted class is not persistent.