From 09fe22710ef6cf731803c1258d607192ff6fec56 Mon Sep 17 00:00:00 2001 From: Steve Ebersole Date: Wed, 24 Feb 2010 21:40:58 +0000 Subject: [PATCH] misc minor doc cleanups git-svn-id: https://svn.jboss.org/repos/hibernate/core/trunk@18875 1b8cb986-b30d-0410-93ca-fae66ebed9b2 --- .../src/main/docbook/en/modules/metamodel.xml | 21 +++++++++---------- .../docbook/en/modules/query_criteria.xml | 19 ++++++++++------- 2 files changed, 22 insertions(+), 18 deletions(-) diff --git a/entitymanager/src/main/docbook/en/modules/metamodel.xml b/entitymanager/src/main/docbook/en/modules/metamodel.xml index c5e5f02da1..c596c08eee 100644 --- a/entitymanager/src/main/docbook/en/modules/metamodel.xml +++ b/entitymanager/src/main/docbook/en/modules/metamodel.xml @@ -23,8 +23,8 @@ ~ Boston, MA 02110-1301 USA --> '> -&jpa2Biblio;'> +'> +&jpa2Ref;'> '> annotation processor'> ]> @@ -43,20 +43,19 @@ The metamodel is a set of objects that describe your domain model. javax.persistence.metamodel.Metamodel acts as a repository of these metamodel - objects and provides access to them. We ask either the + objects and provides access to them, and can be obtained from either the javax.persistence.EntityManagerFactory or the - javax.persistence.EntityManager for a reference to the - javax.persistence.metamodel.Metamodel via their + javax.persistence.EntityManager via their getMetamodel method. This metamodel is important in 2 ways. First, it allows providers and frameworks a generic way to deal with an application's domain model. Persistence providers will already have some form of - metamodel that they use to describe the domain model being mapped. This API simply allows general access - to that existing information. A validation framework, for example, could use this information to - understand associations; a marshaling framework might use this information to decide how much of an - entity graph to marshal. This usage is beyond the scope of this documentation. + metamodel that they use to describe the domain model being mapped. This API however defines a single, + independent access to that existing information. A validation framework, for example, could use this + information to understand associations; a marshaling framework might use this information to decide how + much of an entity graph to marshal. This usage is beyond the scope of this documentation. @@ -86,7 +85,7 @@
- , section 6.2.1.1, pp 198-199 + &jpa2Ref;, section 6.2.1.1, pp 198-199 @@ -233,7 +232,7 @@ public class Person_ { When the Hibernate EntityManagerFactory is being built, it will look for a canonical metamodel class for each of the managed typed is knows about and if it finds any it will inject the appropriate metamodel information into them, as outlined in - , section 6.2.2, pg 200 + &jpa2Ref;, section 6.2.2, pg 200 diff --git a/entitymanager/src/main/docbook/en/modules/query_criteria.xml b/entitymanager/src/main/docbook/en/modules/query_criteria.xml index 350b2c98e3..6f578d407a 100644 --- a/entitymanager/src/main/docbook/en/modules/query_criteria.xml +++ b/entitymanager/src/main/docbook/en/modules/query_criteria.xml @@ -22,7 +22,12 @@ ~ 51 Franklin Street, Fifth Floor ~ Boston, MA 02110-1301 USA --> - +'> +&jpa2Ref;'> +'> +]> + Criteria Queries @@ -65,10 +70,10 @@ - Chapter 6 Criteria API of the - already contains a decent amount of reference material - pertaining to the various parts of a criteria query. So rather than duplicate all that content here, - lets instead look at some of the more widely (anticipated) usages of the API. + Chapter 6 Criteria API of the &jpa2Cite; already contains a + decent amount of reference material pertaining to the various parts of a criteria query. So rather + than duplicate all that content here, lets instead look at some of the more widely anticipated usages + of the API. @@ -124,7 +129,7 @@ for ( Person person : people ) { ... }]]> Person_.eyeColor is an example of the static form of metamodel reference. We will use that form exclusively in this chapter. - See (todo link to metamodel section once written). + See &staticMetamodelRef; for details. @@ -486,7 +491,7 @@ for ( Tuple tuple : valueArray ) { FROM clause
- + &jpa2Ref;, section 6.5.2 Query Roots, pg 262 A CriteriaQuery object defines a query over one or more entity, embeddable, or basic abstract