diff --git a/documentation/envers/pom.xml b/documentation/envers/pom.xml index 39e28114bc..6e6184c0f3 100644 --- a/documentation/envers/pom.xml +++ b/documentation/envers/pom.xml @@ -23,7 +23,7 @@ org.jboss.maven.plugins maven-jdocbook-plugin - Envers_Reference.xml + Hibernate_Envers_-_Easy_Entity_Auditing.xml en-US ${basedir}/src/main/docbook/en-US diff --git a/documentation/envers/src/main/docbook/en-US/Book_Info.xml b/documentation/envers/src/main/docbook/en-US/Book_Info.xml new file mode 100644 index 0000000000..2f993c04f6 --- /dev/null +++ b/documentation/envers/src/main/docbook/en-US/Book_Info.xml @@ -0,0 +1,22 @@ + +%BOOK_ENTITIES; +]> + + + + Hibernate Envers - Easy Entity Auditing + Hibernate Envers Reference Documentation + &versionNumber; + 1.0 + 1 + JBoss Hibernate Envers + &versionNumber; + 1 + + ©rightYear; + ©rightHolder; + + + + diff --git a/documentation/envers/src/main/docbook/en-US/Hibernate_Envers_-_Easy_Entity_Auditing.ent b/documentation/envers/src/main/docbook/en-US/Hibernate_Envers_-_Easy_Entity_Auditing.ent new file mode 100644 index 0000000000..bafb3b4088 --- /dev/null +++ b/documentation/envers/src/main/docbook/en-US/Hibernate_Envers_-_Easy_Entity_Auditing.ent @@ -0,0 +1,5 @@ + + + + + diff --git a/documentation/envers/src/main/docbook/en-US/Hibernate_Envers_-_Easy_Entity_Auditing.xml b/documentation/envers/src/main/docbook/en-US/Hibernate_Envers_-_Easy_Entity_Auditing.xml new file mode 100644 index 0000000000..7c312de837 --- /dev/null +++ b/documentation/envers/src/main/docbook/en-US/Hibernate_Envers_-_Easy_Entity_Auditing.xml @@ -0,0 +1,63 @@ + + + +%BOOK_ENTITIES; +]> + + + + + + + + + + + + + + + + + + + diff --git a/documentation/envers/src/main/docbook/en-US/content/configuration.xml b/documentation/envers/src/main/docbook/en-US/content/configuration.xml index c192c15a31..84ed14ec91 100644 --- a/documentation/envers/src/main/docbook/en-US/content/configuration.xml +++ b/documentation/envers/src/main/docbook/en-US/content/configuration.xml @@ -23,7 +23,10 @@ ~ Boston, MA 02110-1301 USA --> - + +%BOOK_ENTITIES; +]> diff --git a/documentation/envers/src/main/docbook/en-US/content/example.xml b/documentation/envers/src/main/docbook/en-US/content/example.xml index c21d00b96b..a9908228b4 100644 --- a/documentation/envers/src/main/docbook/en-US/content/example.xml +++ b/documentation/envers/src/main/docbook/en-US/content/example.xml @@ -23,7 +23,10 @@ ~ Boston, MA 02110-1301 USA --> - + +%BOOK_ENTITIES; +]> @@ -83,4 +86,4 @@ assert address1_rev1.getPersons().getSize() == 1; // and so on - \ No newline at end of file + diff --git a/documentation/envers/src/main/docbook/en-US/content/exceptions.xml b/documentation/envers/src/main/docbook/en-US/content/exceptions.xml index e976e7b300..2a66723834 100644 --- a/documentation/envers/src/main/docbook/en-US/content/exceptions.xml +++ b/documentation/envers/src/main/docbook/en-US/content/exceptions.xml @@ -23,12 +23,15 @@ ~ Boston, MA 02110-1301 USA --> - + +%BOOK_ENTITIES; +]> Mapping exceptions - +
What isn't and will not be supported @@ -59,9 +62,9 @@ - +
- +
What isn't and <emphasis>will</emphasis> be supported @@ -73,9 +76,9 @@ - +
- +
<literal>@OneToMany</literal>+<literal>@JoinColumn</literal> @@ -106,6 +109,6 @@ Envers works. Please note that the annotation is experimental and may change in the future. - +
diff --git a/documentation/envers/src/main/docbook/en-US/content/links.xml b/documentation/envers/src/main/docbook/en-US/content/links.xml index d226b5eb90..5f0da9eb21 100644 --- a/documentation/envers/src/main/docbook/en-US/content/links.xml +++ b/documentation/envers/src/main/docbook/en-US/content/links.xml @@ -23,7 +23,10 @@ ~ Boston, MA 02110-1301 USA --> - + +%BOOK_ENTITIES; +]> Links diff --git a/documentation/envers/src/main/docbook/en-US/content/migration.xml b/documentation/envers/src/main/docbook/en-US/content/migration.xml index 99402cb900..1b56e2aef0 100644 --- a/documentation/envers/src/main/docbook/en-US/content/migration.xml +++ b/documentation/envers/src/main/docbook/en-US/content/migration.xml @@ -23,7 +23,10 @@ ~ Boston, MA 02110-1301 USA --> - + +%BOOK_ENTITIES; +]> Migration from Envers standalone @@ -39,7 +42,7 @@ with Oracle and other databases, which don't allow tables and field names to start with "_". - +
Changes to code @@ -54,9 +57,9 @@ projections and order. Please refer to the Javadoc for further details. - +
- +
Changes to configuration @@ -111,9 +114,9 @@ See for details on the configuration and a description of the configuration options. - +
- +
Changes to the revision entity @@ -153,5 +156,5 @@ public class ExampleRevEntity { // Getters, setters, equals, hashCode ... }]]> - +
diff --git a/documentation/envers/src/main/docbook/en-US/content/preface.xml b/documentation/envers/src/main/docbook/en-US/content/preface.xml index 1c82e897ad..820e677c2f 100644 --- a/documentation/envers/src/main/docbook/en-US/content/preface.xml +++ b/documentation/envers/src/main/docbook/en-US/content/preface.xml @@ -23,7 +23,10 @@ ~ Boston, MA 02110-1301 USA --> - + +%BOOK_ENTITIES; +]> Preface @@ -80,4 +83,4 @@ - \ No newline at end of file + diff --git a/documentation/envers/src/main/docbook/en-US/content/queries.xml b/documentation/envers/src/main/docbook/en-US/content/queries.xml index fc2c212e16..722ac019b1 100644 --- a/documentation/envers/src/main/docbook/en-US/content/queries.xml +++ b/documentation/envers/src/main/docbook/en-US/content/queries.xml @@ -23,7 +23,10 @@ ~ Boston, MA 02110-1301 USA --> - + +%BOOK_ENTITIES; +]> @@ -55,7 +58,7 @@ than corresponding queries on "live" data, as they involve correlated subselects. - +
Querying for entities of a class at a given revision @@ -101,9 +104,9 @@ query.add(AuditEntity.relatedId("address").eq(relatedEntityId));]]> - +
- +
Querying for revisions, at which entities of a given class changed @@ -121,17 +124,23 @@ query.add(AuditEntity.relatedId("address").eq(relatedEntityId));]]> + using AuditEntity.revisionNumber() you can specify constraints, projections and order on the revision number, in which the audited entity was modified + + similarly, using AuditEntity.revisionProperty(propertyName) you can specify constraints, projections and order on a property of the revision entity, corresponding to the revision in which the audited entity was modified + + AuditEntity.revisionType() gives you access as above to the type of the revision (ADD, MOD, DEL). + @@ -198,6 +207,6 @@ query.add(AuditEntity.relatedId("address").eq(relatedEntityId));]]>null. - +
- \ No newline at end of file + diff --git a/documentation/envers/src/main/docbook/en-US/content/quickstart.xml b/documentation/envers/src/main/docbook/en-US/content/quickstart.xml index b5ee802b7b..34622827a9 100644 --- a/documentation/envers/src/main/docbook/en-US/content/quickstart.xml +++ b/documentation/envers/src/main/docbook/en-US/content/quickstart.xml @@ -23,7 +23,10 @@ ~ Boston, MA 02110-1301 USA --> - + +%BOOK_ENTITIES; +]> Quickstart diff --git a/documentation/envers/src/main/docbook/en-US/content/revisionlog.xml b/documentation/envers/src/main/docbook/en-US/content/revisionlog.xml index 79b6219e95..d90b27219b 100644 --- a/documentation/envers/src/main/docbook/en-US/content/revisionlog.xml +++ b/documentation/envers/src/main/docbook/en-US/content/revisionlog.xml @@ -23,7 +23,10 @@ ~ Boston, MA 02110-1301 USA --> - + +%BOOK_ENTITIES; +]> diff --git a/documentation/envers/src/main/docbook/en-US/content/schema.xml b/documentation/envers/src/main/docbook/en-US/content/schema.xml index 1e3b3215b4..e28c0fd46e 100644 --- a/documentation/envers/src/main/docbook/en-US/content/schema.xml +++ b/documentation/envers/src/main/docbook/en-US/content/schema.xml @@ -23,7 +23,10 @@ ~ Boston, MA 02110-1301 USA --> - + +%BOOK_ENTITIES; +]> Generating schema with Ant diff --git a/documentation/envers/src/main/docbook/en-US/content/source.xml b/documentation/envers/src/main/docbook/en-US/content/source.xml index 90ad61ace4..391c8e0052 100644 --- a/documentation/envers/src/main/docbook/en-US/content/source.xml +++ b/documentation/envers/src/main/docbook/en-US/content/source.xml @@ -23,7 +23,9 @@ ~ Boston, MA 02110-1301 USA --> - + +]> Building from source and testing diff --git a/documentation/envers/src/main/docbook/en-US/content/tables.xml b/documentation/envers/src/main/docbook/en-US/content/tables.xml index 60a5308475..28375c6e18 100644 --- a/documentation/envers/src/main/docbook/en-US/content/tables.xml +++ b/documentation/envers/src/main/docbook/en-US/content/tables.xml @@ -23,7 +23,10 @@ ~ Boston, MA 02110-1301 USA --> - + +%BOOK_ENTITIES; +]> Generated tables and their content diff --git a/documentation/envers/src/main/docbook/en-US/legal_notice.xml b/documentation/envers/src/main/docbook/en-US/legal_notice.xml index aca0ede77a..d166513800 100644 --- a/documentation/envers/src/main/docbook/en-US/legal_notice.xml +++ b/documentation/envers/src/main/docbook/en-US/legal_notice.xml @@ -22,7 +22,10 @@ ~ 51 Franklin Street, Fifth Floor ~ Boston, MA 02110-1301 USA --> - + +%BOOK_ENTITIES; +]> Legal Notice diff --git a/documentation/envers/src/main/docbook/publican.cfg b/documentation/envers/src/main/docbook/publican.cfg new file mode 100644 index 0000000000..23db451dbd --- /dev/null +++ b/documentation/envers/src/main/docbook/publican.cfg @@ -0,0 +1,6 @@ +# Config::Simple 4.59 +# Wed Dec 9 09:53:51 2009 + +debug: 1 +xml_lang: en-US +brand: jboss-community-hibernate