[jboss-cvs] JBossAS SVN: r97526 - in projects/docs/enterprise: EWP_5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US and 1 other directory.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Tue Dec 8 03:04:37 EST 2009
Author: laubai
Date: 2009-12-08 03:04:36 -0500 (Tue, 08 Dec 2009)
New Revision: 97526
Modified:
projects/docs/enterprise/5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/entity.xml
projects/docs/enterprise/5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/xml-overriding.xml
projects/docs/enterprise/EWP_5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/entity.xml
projects/docs/enterprise/EWP_5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/xml-overriding.xml
Log:
Added changes for JBPAPP-1715.
Modified: projects/docs/enterprise/5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/entity.xml
===================================================================
--- projects/docs/enterprise/5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/entity.xml 2009-12-08 07:54:30 UTC (rev 97525)
+++ projects/docs/enterprise/5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/entity.xml 2009-12-08 08:04:36 UTC (rev 97526)
@@ -1220,11 +1220,11 @@
...
</programlisting>
- <para>You can alse map a many to one association through an
+ <para>You can also map a many to one association through an
association table. This association table described by the
<literal>@JoinTable</literal> annotation will contains a foreign key
referencing back the entity table (through
- <literal>@JoinTable.joinColumns</literal>) and a a foreign key
+ <literal>@JoinTable.joinColumns</literal>) and a foreign key
referencing the target entity table (through
<literal>@JoinTable.inverseJoinColumns</literal>).</para>
@@ -1313,7 +1313,7 @@
</row>
<row>
- <entry>Bag semantic with primary key (withtout the
+ <entry>Bag semantic with primary key (without the
limitations of Bag semantic)</entry>
<entry>java.util.List, java.util.Collection</entry>
@@ -1640,7 +1640,7 @@
table which refer to the <classname>Employee</classname> primary
key (the "other side").</para>
- <para>As seen previously, the other side don't have to (must not)
+ <para>As seen previously, the other side must not
describe the physical mapping: a simple
<literal>mappedBy</literal> argument containing the owner side
property name bind the two.</para>
@@ -2014,7 +2014,7 @@
<entry>org.hibernate.cacheable</entry>
<entry>Whether the query should interact with the second level
- cache (defualt to false)</entry>
+ cache (default to false)</entry>
</row>
<row>
@@ -2071,7 +2071,7 @@
that, you need to describe the SQL resultset structure using
<literal>@SqlResultSetMapping</literal> (or
<literal>@SqlResultSetMappings</literal> if you plan to define several
- resulset mappings). Like <literal>@NamedQuery</literal>, a
+ resultset mappings). Like <literal>@NamedQuery</literal>, a
<literal>@SqlResultSetMapping</literal> can be defined at class level or
in a JPA XML file. However its scope is global to the
application.</para>
@@ -2113,7 +2113,7 @@
see an implicit declaration of the property / column.</para>
<programlisting>@Entity
-<emphasis role="bold">@SqlResultSetMapping(name="implicit", entities=@EntityResult(entityClass=org.hibernate.test.annotations.query.SpaceShip.class))
+ <emphasis role="bold">@SqlResultSetMapping(name="implicit", entities=@EntityResult(entityClass=org.hibernate.test.annotations.query.SpaceShip.class))
@NamedNativeQuery(name="implicitSample", query="select * from SpaceShip", resultSetMapping="implicit")</emphasis>
public class SpaceShip {
private String name;
@@ -2448,7 +2448,7 @@
optimisticLock = OptimisticLockType.ALL,
polymorphism = PolymorphismType.EXPLICIT)
@Where(clause="1=1")
- at org.hibernate.annotations.Table(name="Forest", indexes = { @Index(name="idx", columnNames = { "name", "length" } ) } )
+ at org.hibernate.annotations.Table(appliesTo="Forest", indexes = { @Index(name="idx", columnNames = { "name", "length" } ) } )
@Persister(impl=MyEntityPersister.class)
public class Forest { ... }</programlisting><programlisting>@Entity
@Inheritance(
@@ -2814,7 +2814,7 @@
<para>Sometimes, the type guessed by reflection is not the one you
want Hibernate to use. This is especially true on components when an
- interface is used. You can use <literal>@Target</literal> to by pass
+ interface is used. You can use <literal>@Target</literal> to bypass
the reflection guessing mechanism (very much like the
<literal>targetEntity</literal> attribute available on
associations.</para>
@@ -3370,8 +3370,7 @@
}
<emphasis role="bold">@CollectionOfElements
- @JoinTable(
- table=@Table(name="BoyFavoriteNumbers"),
+ @JoinTable( name="BoyFavoriteNumbers",
joinColumns = @JoinColumn(name="BoyId")
)
@Column(name="favoriteNumber", nullable=false)</emphasis>
@@ -3668,7 +3667,7 @@
representation, you might want to apply the filter condition to the
association table itself or to the target entity table. To apply the
constraint on the target entity, use the regular
- <literal>@Filter</literal> annotation. However, if you wan to target the
+ <literal>@Filter</literal> annotation. However, if you want to target the
association table, use the <literal>@FilterJoinTable</literal>
annotation.</para>
@@ -3677,7 +3676,7 @@
//filter on the target entity table
@Filter(name="betweenLength", condition=":minLength <= length and :maxLength >= length")
//filter on the association table
- @FilterJoinTable(name="security", condition=":userlevel >= requredLevel")
+ @FilterJoinTable(name="security", condition=":userlevel >= requiredLevel")
public Set<Forest> getForests() { ... }</programlisting>
</sect2>
Modified: projects/docs/enterprise/5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/xml-overriding.xml
===================================================================
--- projects/docs/enterprise/5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/xml-overriding.xml 2009-12-08 07:54:30 UTC (rev 97525)
+++ projects/docs/enterprise/5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/xml-overriding.xml 2009-12-08 08:04:36 UTC (rev 97526)
@@ -163,7 +163,7 @@
</callout>
<callout arearefs="aa3">
- <para><literal>entity</literal>: desribes an entity.</para>
+ <para><literal>entity</literal>: describes an entity.</para>
<para><literal>metadata-complete</literal> defines whether the
metadata description for this element is complete or not (in other
@@ -171,7 +171,7 @@
considered or not).</para>
<para>An entity has to have a <literal>class</literal> attribute
- refering the java class the metadata applies on.</para>
+ referring to the java class the metadata applies on.</para>
<para>You can overrides entity name through the
<literal>name</literal> attribute, if none is defined and if an
@@ -339,11 +339,11 @@
<section>
<title>Property level metadata</title>
- <para>You can of course defines XML overriding for properties. If
+ <para>You can of course define XML overriding for properties. If
metadata complete is defined, then additional properties (ie at the Java
level) will be ignored. Otherwise, once you start overriding a property,
all annotations on the given property are ignored. All property level
- metadata behave in <literal>entity/attributes</literal>,
+ metadata resides in <literal>entity/attributes</literal>,
<literal>mapped-superclass/attributes</literal> or
<literal>embeddable/attributes</literal>.</para>
Modified: projects/docs/enterprise/EWP_5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/entity.xml
===================================================================
--- projects/docs/enterprise/EWP_5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/entity.xml 2009-12-08 07:54:30 UTC (rev 97525)
+++ projects/docs/enterprise/EWP_5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/entity.xml 2009-12-08 08:04:36 UTC (rev 97526)
@@ -1220,11 +1220,11 @@
...
</programlisting>
- <para>You can alse map a many to one association through an
+ <para>You can also map a many to one association through an
association table. This association table described by the
<literal>@JoinTable</literal> annotation will contains a foreign key
referencing back the entity table (through
- <literal>@JoinTable.joinColumns</literal>) and a a foreign key
+ <literal>@JoinTable.joinColumns</literal>) and a foreign key
referencing the target entity table (through
<literal>@JoinTable.inverseJoinColumns</literal>).</para>
@@ -1313,7 +1313,7 @@
</row>
<row>
- <entry>Bag semantic with primary key (withtout the
+ <entry>Bag semantic with primary key (without the
limitations of Bag semantic)</entry>
<entry>java.util.List, java.util.Collection</entry>
@@ -1640,7 +1640,7 @@
table which refer to the <classname>Employee</classname> primary
key (the "other side").</para>
- <para>As seen previously, the other side don't have to (must not)
+ <para>As seen previously, the other side must not
describe the physical mapping: a simple
<literal>mappedBy</literal> argument containing the owner side
property name bind the two.</para>
@@ -2014,7 +2014,7 @@
<entry>org.hibernate.cacheable</entry>
<entry>Whether the query should interact with the second level
- cache (defualt to false)</entry>
+ cache (default to false)</entry>
</row>
<row>
@@ -2071,7 +2071,7 @@
that, you need to describe the SQL resultset structure using
<literal>@SqlResultSetMapping</literal> (or
<literal>@SqlResultSetMappings</literal> if you plan to define several
- resulset mappings). Like <literal>@NamedQuery</literal>, a
+ resultset mappings). Like <literal>@NamedQuery</literal>, a
<literal>@SqlResultSetMapping</literal> can be defined at class level or
in a JPA XML file. However its scope is global to the
application.</para>
@@ -2113,7 +2113,7 @@
see an implicit declaration of the property / column.</para>
<programlisting>@Entity
-<emphasis role="bold">@SqlResultSetMapping(name="implicit", entities=@EntityResult(entityClass=org.hibernate.test.annotations.query.SpaceShip.class))
+ <emphasis role="bold">@SqlResultSetMapping(name="implicit", entities=@EntityResult(entityClass=org.hibernate.test.annotations.query.SpaceShip.class))
@NamedNativeQuery(name="implicitSample", query="select * from SpaceShip", resultSetMapping="implicit")</emphasis>
public class SpaceShip {
private String name;
@@ -2448,7 +2448,7 @@
optimisticLock = OptimisticLockType.ALL,
polymorphism = PolymorphismType.EXPLICIT)
@Where(clause="1=1")
- at org.hibernate.annotations.Table(name="Forest", indexes = { @Index(name="idx", columnNames = { "name", "length" } ) } )
+ at org.hibernate.annotations.Table(appliesTo="Forest", indexes = { @Index(name="idx", columnNames = { "name", "length" } ) } )
@Persister(impl=MyEntityPersister.class)
public class Forest { ... }</programlisting><programlisting>@Entity
@Inheritance(
@@ -2814,7 +2814,7 @@
<para>Sometimes, the type guessed by reflection is not the one you
want Hibernate to use. This is especially true on components when an
- interface is used. You can use <literal>@Target</literal> to by pass
+ interface is used. You can use <literal>@Target</literal> to bypass
the reflection guessing mechanism (very much like the
<literal>targetEntity</literal> attribute available on
associations.</para>
@@ -3370,8 +3370,7 @@
}
<emphasis role="bold">@CollectionOfElements
- @JoinTable(
- table=@Table(name="BoyFavoriteNumbers"),
+ @JoinTable( name="BoyFavoriteNumbers",
joinColumns = @JoinColumn(name="BoyId")
)
@Column(name="favoriteNumber", nullable=false)</emphasis>
@@ -3668,7 +3667,7 @@
representation, you might want to apply the filter condition to the
association table itself or to the target entity table. To apply the
constraint on the target entity, use the regular
- <literal>@Filter</literal> annotation. However, if you wan to target the
+ <literal>@Filter</literal> annotation. However, if you want to target the
association table, use the <literal>@FilterJoinTable</literal>
annotation.</para>
@@ -3677,7 +3676,7 @@
//filter on the target entity table
@Filter(name="betweenLength", condition=":minLength <= length and :maxLength >= length")
//filter on the association table
- @FilterJoinTable(name="security", condition=":userlevel >= requredLevel")
+ @FilterJoinTable(name="security", condition=":userlevel >= requiredLevel")
public Set<Forest> getForests() { ... }</programlisting>
</sect2>
Modified: projects/docs/enterprise/EWP_5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/xml-overriding.xml
===================================================================
--- projects/docs/enterprise/EWP_5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/xml-overriding.xml 2009-12-08 07:54:30 UTC (rev 97525)
+++ projects/docs/enterprise/EWP_5.0/Hibernate/Hibernate_Annotations_Reference_Guide/en-US/xml-overriding.xml 2009-12-08 08:04:36 UTC (rev 97526)
@@ -163,7 +163,7 @@
</callout>
<callout arearefs="aa3">
- <para><literal>entity</literal>: desribes an entity.</para>
+ <para><literal>entity</literal>: describes an entity.</para>
<para><literal>metadata-complete</literal> defines whether the
metadata description for this element is complete or not (in other
@@ -171,7 +171,7 @@
considered or not).</para>
<para>An entity has to have a <literal>class</literal> attribute
- refering the java class the metadata applies on.</para>
+ referring to the java class the metadata applies on.</para>
<para>You can overrides entity name through the
<literal>name</literal> attribute, if none is defined and if an
@@ -339,7 +339,7 @@
<section>
<title>Property level metadata</title>
- <para>You can of course defines XML overriding for properties. If
+ <para>You can of course define XML overriding for properties. If
metadata complete is defined, then additional properties (ie at the Java
level) will be ignored. Otherwise, once you start overriding a property,
all annotations on the given property are ignored. All property level
@@ -384,7 +384,7 @@
<title>Association level metadata</title>
<para>You can define XML overriding for associations. All association
- level metadata behave in <literal>entity/attributes</literal>,
+ level metadata resides in <literal>entity/attributes</literal>,
<literal>mapped-superclass/attributes</literal> or
<literal>embeddable/attributes</literal>.</para>
More information about the jboss-cvs-commits
mailing list