JBoss Tools SVN: r20353 - trunk/jbpm/docs/converter_ref/en-US.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2010-02-18 04:49:18 -0500 (Thu, 18 Feb 2010)
New Revision: 20353
Modified:
trunk/jbpm/docs/converter_ref/en-US/master.xml
trunk/jbpm/docs/converter_ref/en-US/master_output.xml
Log:
<html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif">
<p>https://jira.jboss.org/jira/browse/JBDS-1104 - Updated versions,corrected master_output file</p>
</body></html>
Modified: trunk/jbpm/docs/converter_ref/en-US/master.xml
===================================================================
--- trunk/jbpm/docs/converter_ref/en-US/master.xml 2010-02-18 09:20:41 UTC (rev 20352)
+++ trunk/jbpm/docs/converter_ref/en-US/master.xml 2010-02-18 09:49:18 UTC (rev 20353)
@@ -30,7 +30,7 @@
<holder>JBoss by Red Hat</holder>
</copyright>
<releaseinfo>
- Version: 1.1.0.M2
+ Version: 1.1.0.CR2
</releaseinfo>
<abstract>
<title/>
Modified: trunk/jbpm/docs/converter_ref/en-US/master_output.xml
===================================================================
--- trunk/jbpm/docs/converter_ref/en-US/master_output.xml 2010-02-18 09:20:41 UTC (rev 20352)
+++ trunk/jbpm/docs/converter_ref/en-US/master_output.xml 2010-02-18 09:49:18 UTC (rev 20353)
@@ -8,26 +8,27 @@
<bookinfo>
<title>BPMN Convert User Guide</title>
- <corpauthor diffmk:change="added">
- <inlinemediaobject diffmk:change="added">
- <imageobject diffmk:change="added" role="fo">
- <imagedata diffmk:change="added" fileref="images/jbosstools_logo.png" format="PNG"></imagedata>
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata>
</imageobject>
- <imageobject diffmk:change="added" role="html">
- <imagedata diffmk:change="added"></imagedata>
+ <imageobject role="html">
+ <imagedata></imagedata>
</imageobject>
</inlinemediaobject>
</corpauthor>
<author><firstname>Grid</firstname><surname>Qian</surname><email>fqian(a)redhat.com</email></author>
- <pubdate>October 2008</pubdate>
+
<copyright>
<year>2008</year>
<year>2009</year>
- <holder><diffmk:wrapper diffmk:change="changed">JBoss by Red Hat</diffmk:wrapper></holder>
+ <year diffmk:change="added"><diffmk:wrapper diffmk:change="added">2010</diffmk:wrapper></year>
+ <holder>JBoss by Red Hat</holder>
</copyright>
<releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 1.1.0.M2
+ Version: 1.1.0.CR2
</diffmk:wrapper></releaseinfo>
<abstract>
<title></title>
@@ -41,42 +42,42 @@
<toc></toc>
-<chapter id="overview" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/converter_ref/en/modules/overview.xml">
+<chapter id="overview" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jbpm/docs/converter_ref/en-US/overview.xml">
<title>BPMN Convert Overview</title>
- <para><diffmk:wrapper diffmk:change="changed">This chapter gives you a short overview of JBoss BPMN Convert module.</diffmk:wrapper></para>
- <para><diffmk:wrapper diffmk:change="changed">JBoss BPMN Convert module is a tool used for a BPMN file translation.</diffmk:wrapper></para>
+ <para>This chapter gives you a short overview of JBoss BPMN Convert module.</para>
+ <para>JBoss BPMN Convert module is a tool used for a BPMN file translation.</para>
<para>As a part of JBoss tools, JBoss BPMN Convert module implements BPMN -> JPDL translation. You can get a basic JPDL file from a BPMN file by using this module.</para>
<para>The BPMN file may be written by hands or with the help of some editors. In this guide, we use STP BPMN editor to draw a BPMN file.</para>
- <para>You can download the editor which is included into BPMN Modeler from Eclipse download or update site. On the <ulink url="http://www.eclipse.org/bpmn">Eclipse BPMN project page</ulink><diffmk:wrapper diffmk:change="added"> you can find the necessary links and other related information.</diffmk:wrapper></para>
+ <para>You can download the editor which is included into BPMN Modeler from Eclipse download or update site. On the <ulink url="http://www.eclipse.org/bpmn">Eclipse BPMN project page</ulink> you can find the necessary links and other related information.</para>
-<section diffmk:change="added">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Key Features of JBoss BPMN Convert module</diffmk:wrapper></title>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For a start, we propose you to look through the table of main features of JBoss BPMN Convert module:</diffmk:wrapper></para>
+<section>
+ <title>Key Features of JBoss BPMN Convert module</title>
+ <para>For a start, we propose you to look through the table of main features of JBoss BPMN Convert module:</para>
- <table diffmk:change="added">
+ <table>
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Key Functionality of JBoss BPMN Convert module</diffmk:wrapper></title>
- <tgroup cols="3" diffmk:change="added">
+ <title>Key Functionality of JBoss BPMN Convert module</title>
+ <tgroup cols="3">
- <colspec align="left" colnum="1" colwidth="2*" diffmk:change="added"></colspec>
- <colspec colnum="2" colwidth="4*" diffmk:change="added"></colspec>
- <colspec align="left" colnum="3" colwidth="2*" diffmk:change="added"></colspec>
+ <colspec align="left" colnum="1" colwidth="2*"></colspec>
+ <colspec colnum="2" colwidth="4*"></colspec>
+ <colspec align="left" colnum="3" colwidth="2*"></colspec>
- <thead diffmk:change="added">
- <row diffmk:change="added">
- <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Feature</diffmk:wrapper></entry>
- <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Benefit</diffmk:wrapper></entry>
- <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Chapter</diffmk:wrapper></entry>
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+ <entry>Chapter</entry>
</row>
</thead>
- <tbody diffmk:change="added">
+ <tbody>
- <row diffmk:change="added">
- <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">STP BPMN Editor</diffmk:wrapper></para></entry>
- <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss BPMN Convert module contains STP Business Process Modeling Notation (BPMN) Editor which is a tool to express any processes in a graphical form (simple diagrams with a set of some graphical elements). Created BPMN files can then be converted to jPDL.</diffmk:wrapper></para></entry>
- <entry diffmk:change="added">
- <link diffmk:change="added" linkend="createbpmnfile"><diffmk:wrapper diffmk:change="added">creating a BPMN file by STP BPMN editor</diffmk:wrapper></link>
+ <row>
+ <entry><para>STP BPMN Editor</para></entry>
+ <entry><para>JBoss BPMN Convert module contains STP Business Process Modeling Notation (BPMN) Editor which is a tool to express any processes in a graphical form (simple diagrams with a set of some graphical elements). Created BPMN files can then be converted to jPDL.</para></entry>
+ <entry>
+ <link linkend="createbpmnfile">creating a BPMN file by STP BPMN editor</link>
</entry>
</row>
@@ -93,7 +94,7 @@
</chapter>
-<chapter id="bpmn2jpdl" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/converter_ref/en/modules/bpmn2jpdl.xml">
+<chapter id="bpmn2jpdl" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jbpm/docs/converter_ref/en-US/bpmn2jpdl.xml">
<title>Translate a Bpmn file to a JPDL file</title>
<para>In this chapter we provide you with the necessary steps to translate a Bpmn file to a JPDL file.</para>
@@ -213,8 +214,9 @@
</imageobject>
</mediaobject>
</figure>
- <para>We hope, this guide helped you to get started with the JBoss BPMN Convert module. Besides, for additional information you are welcome on <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para>
- </section>
+ <para>We hope, this guide helped you to get started with the JBoss BPMN Convert module. Besides, for additional information you are welcome on <ulink
+ url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para>
+ </section>
</chapter>
</book>
14 years, 7 months
JBoss Tools SVN: r20351 - trunk/hibernatetools/docs/reference/en.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2010-02-18 04:09:27 -0500 (Thu, 18 Feb 2010)
New Revision: 20351
Modified:
trunk/hibernatetools/docs/reference/en/master.xml
trunk/hibernatetools/docs/reference/en/master_output.xml
Log:
<html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif">
<p>https://jira.jboss.org/jira/browse/JBDS-1104 - Updated versions,corrected master_output file</p>
</body></html>
Modified: trunk/hibernatetools/docs/reference/en/master.xml
===================================================================
--- trunk/hibernatetools/docs/reference/en/master.xml 2010-02-18 08:55:20 UTC (rev 20350)
+++ trunk/hibernatetools/docs/reference/en/master.xml 2010-02-18 09:09:27 UTC (rev 20351)
@@ -50,7 +50,7 @@
</copyright>
<releaseinfo>
- Version: 3.3.0.CR1
+ Version: 3.3.0.CR2
</releaseinfo>
Modified: trunk/hibernatetools/docs/reference/en/master_output.xml
===================================================================
--- trunk/hibernatetools/docs/reference/en/master_output.xml 2010-02-18 08:55:20 UTC (rev 20350)
+++ trunk/hibernatetools/docs/reference/en/master_output.xml 2010-02-18 09:09:27 UTC (rev 20351)
@@ -39,16 +39,17 @@
<author><firstname>Max</firstname><surname>Andersen</surname><email>max.andersen(a)jboss.com</email></author>
<author><firstname>Olga</firstname><surname>Chikvina</surname></author>
<author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
-
- <pubdate>April 2008</pubdate>
+
<copyright>
<year>2007</year>
- <year>2009</year>
+ <year><diffmk:wrapper diffmk:change="added">2008</diffmk:wrapper></year>
+ <year diffmk:change="added">2009</year>
+ <year diffmk:change="added"><diffmk:wrapper diffmk:change="added">2010</diffmk:wrapper></year>
<holder>JBoss by Red Hat</holder>
</copyright>
<releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 3.3.0.CR1
+ Version: 3.3.0.CR2
</diffmk:wrapper></releaseinfo>
@@ -69,7 +70,7 @@
<toc></toc>
-<chapter id="preface" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/hibernatetools/docs/reference/en/modules/preface.xml">
+<chapter id="preface" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/hibernatetools/docs/reference/en/modules/preface.xml">
<title>Preface</title>
@@ -231,77 +232,106 @@
</chapter>
-<chapter id="setup" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/hibernatetools/docs/reference/en/modules/setup.xml">
+<chapter id="setup" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/hibernatetools/docs/reference/en/modules/setup.xml">
<title>Download and install Hibernate Tools</title>
-
- <para><property moreinfo="none">Hibernate Tools</property> can be used "standalone" via Ant
- 1.6.x or fully integrated into an Eclipse + WTP based IDE, such as <property moreinfo="none">JBDS/JBoss
- Tools</property>, or a default Eclipse + WTP installation. The following sections describe the
- install steps in these environments.</para>
-
+ <para><property moreinfo="none">Hibernate Tools</property><diffmk:wrapper diffmk:change="changed"> can be used "standalone" via Ant 1.6.x or
+ fully integrated into an Eclipse + WTP based IDE, such as </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBDS/JBoss Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">,
+ or a default Eclipse + WTP installation. The following sections describe the install steps in
+ these environments.</diffmk:wrapper></para>
<note>
<title>Note:</title>
- <para>The <property moreinfo="none">Hibernate Tools 3.2.4.GA</property> (the current release version) requires
- Eclipse Ganymede 3.4.2.</para>
+ <para>The <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Hibernate Tools 3.3.0</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> (the current release version) requires
+ Eclipse Galileo 3.5.</diffmk:wrapper></para>
</note>
-
<section>
<title>JBoss Tools</title>
-
- <para><property moreinfo="none">JBoss Tools 3.0.0.GA</property> (the latest release) includes
- <property moreinfo="none">Hibernate Tools 3.2.4.GA</property> and thus nothing is required besides <ulink url="http://jboss.org/tools/download/stable/3_0_0_GA.html">downloading</ulink> and <ulink url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">installing JBoss Tools</ulink>. If you need to update
- to a newer version of the <property moreinfo="none">Hibernate Tools</property> just follow the instructions in
- the Eclipse IDE section.</para>
+ <para><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss Tools 3.1.0</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> (the latest release) includes </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Hibernate
+ Tools 3.3.0</diffmk:wrapper></property> and thus nothing is required besides <property diffmk:change="added" moreinfo="none">downloading</property><diffmk:wrapper diffmk:change="added">
+ and </diffmk:wrapper><property diffmk:change="added" moreinfo="none">installing JBoss Tools</property><diffmk:wrapper diffmk:change="added">. If you need to update to a newer version of
+ the </diffmk:wrapper><property moreinfo="none">Hibernate Tools</property><diffmk:wrapper diffmk:change="changed"> just follow the instructions in the Eclipse IDE
+ section.</diffmk:wrapper></para>
</section>
-
<section>
<title>Eclipse IDE</title>
-
- <para>To install the <property moreinfo="none">Hibernate Tools</property> into any <property moreinfo="none">Eclipse 3.4.x</property> based IDE you
- can either download the <property moreinfo="none">Hibernate Tools</property> distribution from the <ulink url="http://jboss.org/tools/download/stable/3_0_0_GA.html">JBoss Tools download page</ulink>
- or from the <ulink url="http://download.jboss.org/jbosstools/updates/stable/">JBoss Tools
- Update Site</ulink>.</para>
-
- <para>If you download the <property moreinfo="none">Hibernate Tools</property> distribution you need to place
- the <emphasis>
- <property moreinfo="none">/plugins</property>
- </emphasis> and <emphasis>
- <property moreinfo="none">/feature</property>
- </emphasis> directory into your eclipse directory or eclipse extensions directory. Sometimes
- Eclipse does not automatically detect new plugins and thus the tools will not be activated. To
- ensure eclipse sees these changes just clean up the cached plugin information by running
- eclipse with the <emphasis>
- <property moreinfo="none">-clean</property>
- </emphasis> option, e.g. <emphasis>
- <property moreinfo="none">eclipse -clean</property>.</emphasis> Using the updatesite does not require any
- additional steps.</para>
-
+ <para>To install the <property moreinfo="none">Hibernate Tools</property> into any <property moreinfo="none"><diffmk:wrapper diffmk:change="added">Eclipse
+ 3.5</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> based IDE you can either use </diffmk:wrapper><ulink url="http://download.jboss.org/jbosstools/updates/stable/"><diffmk:wrapper diffmk:change="changed">JBoss Tools Update Site</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="changed">
+ or install it manually.</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">If you want to install the </diffmk:wrapper><property moreinfo="none">Hibernate Tools</property><diffmk:wrapper diffmk:change="added"> distribution manually you
+ need to:</diffmk:wrapper></para>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Download from www.eclipse.org:</diffmk:wrapper></para>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">birt-report-framework-2_5_0.zip</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">birt-wtp-integration-sdk-2_3_2.zip</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">dtp-sdk_1.7.0.zip</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">eclipse-SDK-3.5-win32.zip</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">emf-runtime-2.5.0.zip</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">GEF-SDK-3.5.0.zip</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">org.eclipse.swtbot.eclipse.test-2.0.0.371-dev-e35.zip</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">org.eclipse.swtbot.eclipse-2.0.0.340-dev.zip</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">site-1.6.2.zip</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">tptp.sdk-TPTP-4.6.0.zip</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">wtp-sdk-R-3.1-20090616035105.zip</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">xsd-runtime-2.5.0.zip</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Then you should unpack these files into Eclipse install folder.</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">From </diffmk:wrapper><ulink diffmk:change="added" url="https://www.hibernate.org/6.html"><diffmk:wrapper diffmk:change="added">hibernate.org-Download Overview</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> download </diffmk:wrapper><ulink diffmk:change="added" url="http://downloads.sourceforge.net/project/jboss/JBossTools/JBossTools3.1.0..."><diffmk:wrapper diffmk:change="added">Hibernate Tools</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">
+ .</diffmk:wrapper></para>
+
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Unpack </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Hibernate Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> in eclipse/dropins folder</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
<note>
<title>Note:</title>
- <para>If you need more basic instructions on installing plugins and general usage of eclipse
- then check out <ulink url="https://eclipse-tutorial.dev.java.net/">https://eclipse-tutorial.dev.java.net/</ulink> and especially <ulink url="https://eclipse-tutorial.dev.java.net/visual-tutorials/updatemanager.html">https://eclipse-tutorial.dev.java.net/visual-tutorials/updatemanager.html</ulink> which
+ <para><diffmk:wrapper diffmk:change="changed">If you need more detailed instructions on plugins installation and general usage of eclipse
+ then check out </diffmk:wrapper><ulink url="https://eclipse-tutorial.dev.java.net/">https://eclipse-tutorial.dev.java.net/</ulink> and especially <ulink url="https://eclipse-tutorial.dev.java.net/visual-tutorials/updatemanager.html">https://eclipse-tutorial.dev.java.net/visual-tutorials/updatemanager.html</ulink> which
covers using the update manager.</para>
</note>
-
<section>
<title>Usage of Eclipse WTP</title>
-
<para>The <property moreinfo="none">Hibernate Tools</property> plugins currently use <property moreinfo="none">WTP
3.x</property> which at this time is the latest stable release from the Eclipse Webtools
project.</para>
-
<para>Because the WTP project not always have had proper versioning of their plugins there
might exist WTP plugins in your existing eclipse directory from other Eclipse based projects
that are from an earlier WTP release but has either the same version number or higher. It is
thus recommended that if you have issues with WTP provided features to try and install the
plugins on a clean install of eclipse to ensure there are no version collisions.</para>
-
</section>
</section>
-
<section>
<title>Ant</title>
-
<para>To use the tools via Ant you need the <emphasis>
<property moreinfo="none">hibernate-tools.jar</property>
</emphasis> and associated libraries. The libraries are included in the distribution from the
@@ -314,7 +344,7 @@
</chapter>
-<chapter id="codegenarchitecture" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml">
+<chapter id="codegenarchitecture" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml">
<title>Code generation architecture</title>
<para>The code generation mechanism in the <property moreinfo="none">Hibernate Tools</property> consists of a few
@@ -426,72 +456,73 @@
</chapter>
-<chapter id="plugins" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/hibernatetools/docs/reference/en/modules/plugins.xml">
+<chapter id="plugins" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/hibernatetools/docs/reference/en/modules/plugins.xml">
<title>Eclipse Plugins</title>
-
<para>This chapter will introduce you to the functionality that <property moreinfo="none">Hibernate
Tools</property> provide within Eclipse. That is a set of wizards and editors for simplifying
the work with <property moreinfo="none">Hibernate</property>.</para>
-
<section>
<title>Introduction</title>
-
<para>Hibernate Eclipse Tools include wizards for creating Hibernate mapping files,
configuration files (.cfg.xml), revenge.xml as well as wizards for adjusting Console
Configuration and Code Generation. Special structured and XML editors, editors for executing
HQL and Criteria queries are also provided in Hibernate Console. Refer to <link linkend="hibernate_key_features">Key Features</link> section to find all benefits that you
can take advantage of while using the tools within Eclipse.</para>
-
<note>
<title>Note:</title>
- <para>Please note that these tools do not try to hide any functionality of
- <property moreinfo="none">Hibernate</property>. The tools make working with <property moreinfo="none">Hibernate</property>
- easier, but you are still encouraged/required to read the <ulink url="http://www.hibernate.org/5.html">Hibernate Documentation</ulink> to fully utilize
+ <para><diffmk:wrapper diffmk:change="changed">Please note that these tools do not try to hide any functionality of </diffmk:wrapper><property moreinfo="none">Hibernate</property>. The tools make working with <property moreinfo="none">Hibernate</property><diffmk:wrapper diffmk:change="changed"> easier,
+ but you are still encouraged/required to read the </diffmk:wrapper><ulink url="http://www.hibernate.org/5.html">Hibernate Documentation</ulink> to fully utilize
<property moreinfo="none">Hibernate Tools</property> and especially <property moreinfo="none">Hibernate</property> it
self.</para>
</note>
</section>
-
<section id="map_file_wizard">
<title>Creating a Hibernate Mapping File</title>
-
<para>Hibernate mapping files are used to specify how your objects are related to database
tables.</para>
-
- <para>To create basic mappings for properties and associations, i. e. generate <emphasis>
+ <para>To create basic mappings for properties and associations, i. e. generate <emphasis>
<property moreinfo="none">.hbm.xml</property>
- </emphasis> files, Hibernate Tools provide a basic wizard which you can bring up by navigating <emphasis>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> files, Hibernate Tools provide a basic wizard which you can bring up by navigating
+ </diffmk:wrapper><emphasis>
<property moreinfo="none">New > Hibernate XML mapping file</property>.</emphasis></para>
- <para>At first you'll be asked to select a package or multiple individual classes to map.</para>
+ <para><diffmk:wrapper diffmk:change="changed">At first you'll be asked to select a package or multiple individual classes to map.
+ It's also possible to create an empty file, don't select any packages or classes and an
+ empty .hbm will be created in the specified location</diffmk:wrapper></para>
+ <para diffmk:change="added" id="depth_control"><diffmk:wrapper diffmk:change="added">With </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">depth control</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> option you can define dependences depth for
+ choosing classes (it means to set level of references which is used to collect linked classes
+ to the selection). </diffmk:wrapper></para>
<figure float="0">
<title>Hibernate XML Mapping File Wizard</title>
-
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/plugins_0.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
- <para>Next wizard page lists the mappings to be generated.</para>
+ <para><diffmk:wrapper diffmk:change="added">The next wizard page lists the mappings to be generated. As you see </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Customers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Orders</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Productlines</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Products</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> classes added under </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">depth control</diffmk:wrappe!
r></property><diffmk:wrapper diffmk:change="added"> driving. </diffmk:wrapper></para>
<figure float="0">
- <title>Mappings to be generated</title>
-
+ <title>Mappings to be generated</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/plugins_0_a.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>Pressing finish creates the files.</para>
-
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">This wizard page outputs a generated .hbm files preview.</diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Preview Generated Mapping Files</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/plugins/plugins_0_b.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="added">Pressing </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> creates the files.</diffmk:wrapper></para>
</section>
-
<section id="hib_config_file">
<title>Creating a Hibernate Configuration File</title>
-
- <para>To be able to reverse engineer, prototype queries, and of course to simply use
- <property moreinfo="none">Hibernate Core</property> a <emphasis>
+ <para><diffmk:wrapper diffmk:change="changed">To be able to reverse engineer, prototype queries, and of course to simply use </diffmk:wrapper><property moreinfo="none">Hibernate Core</property> a <emphasis>
<property moreinfo="none">hibernate.properties</property>
</emphasis> or <emphasis>
<property moreinfo="none">hibernate.cfg.xml</property>
@@ -499,42 +530,36 @@
generating the <emphasis>
<property moreinfo="none">hibernate.cfg.xml</property>
</emphasis> file if you do not already have such one.</para>
-
<para>Start the wizard by clicking <emphasis>
- <property moreinfo="none">New > Other (Ctrl+N)</property></emphasis>, then <emphasis>
+ <property moreinfo="none">New > Other (Ctrl+N)</property>
+ </emphasis>, then <emphasis>
<property moreinfo="none">Hibernate > Hibernate Configuration File (cfg.xml)</property>
</emphasis> and press <emphasis>
<property moreinfo="none">Next</property>
- </emphasis>
- or on a web Seam project in the <property moreinfo="none">Web Projects</property> view
- <emphasis><property moreinfo="none"> WebContent -> New -> File -> Hibernate Configuration 3.0</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> or on a web Seam project in the </diffmk:wrapper><property moreinfo="none">Web Projects</property><diffmk:wrapper diffmk:change="changed"> view </diffmk:wrapper><emphasis>
+ <property moreinfo="none"> WebContent -> New -> File -> Hibernate Configuration 3.0</property>
</emphasis>. After selecting the wanted location for the <emphasis>
<property moreinfo="none">hibernate.cfg.xml</property>
</emphasis> file, you will see the following page:</para>
-
<figure float="0">
<title>Hibernate Configuration File Wizard</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_1.png" format="PNG"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_1.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<note>
<title>Note:</title>
<para>The contents in the combo boxes for the JDBC driver class and JDBC URL change
automatically, depending on the Dialect and actual driver you have chosen.</para>
</note>
-
<para>Enter your configuration information in this dialog. Details about the configuration
options can be found in <ulink url="http://docs.jboss.org/ejb3/app-server/Hibernate3/reference/en/html_single">Hibernate
Reference Documentation</ulink>.</para>
-
<para>Press <emphasis>
<property moreinfo="none">Finish</property>
</emphasis> to create the configuration file, after optionally creating a Console
@@ -546,739 +571,620 @@
<property moreinfo="none">hibernate.cfg.xml</property>
</emphasis> for the basis of a Console configuration.</para>
</section>
-
<section id="console_conf">
<title>Hibernate Console Configuration</title>
-
<para>A Console configuration describes how the <property moreinfo="none">Hibernate plugin</property> should
configure <property moreinfo="none">Hibernate</property> and what configuration files, including which
classpath are needed to load the POJO's, JDBC drivers etc. It is required to make usage of
query prototyping, reverse engineering and code generation. You can have multiple named
console configurations. Normally you would just need one per project, but more is definitely
possible if your project requires this.</para>
- <section id="creat_console_conf">
- <title>Creating a Hibernate Console Configuration</title>
-
-
- <para>You create a console configuration by running the <property moreinfo="none">Console Configuration
- Wizard</property>, shown in the following screenshot. The same wizard will also be used if
- you are coming from the <emphasis>
- <property moreinfo="none">hibernate.cfg.xml</property>
- </emphasis> wizard and had enabled <emphasis>
- <property moreinfo="none">Create Console Configuration</property>
- </emphasis>.</para>
-
- <note>
- <title>Note:</title>
- <para>The wizard will look at the current selection in the IDE and try and auto-detect the
- settings which you then can just approve or modify to suit your needs.</para>
- </note>
- <para></para>
-
- <para>The dialog consists of five tabs: </para>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>
- <property moreinfo="none">Main</property>
- </emphasis> for the basic/required settings</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title> Creating Hibernate Console Configuration</title>
- <mediaobject>
- <imageobject role="fo">
- <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"></imagedata>
- </imageobject>
-
- <imageobject role="html">
- <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The following table describes the available settings on the <emphasis>
- <property moreinfo="none">Main</property>
- </emphasis> tab. The wizard can automatically detect default values for most of these if you
- started the wizard with the relevant java project or resource selected.</para>
-
- <table>
- <title>Hibernate Console Configuration Parameters</title>
-
- <tgroup cols="3">
- <colspec align="left" colnum="1" colwidth="1*"></colspec>
-
- <colspec colnum="2" colwidth="3*"></colspec>
-
- <colspec align="left" colnum="3" colwidth="1*"></colspec>
-
- <thead>
- <row>
- <entry align="center">
- <para>Parameter</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
-
- <entry align="center">
- <para>Auto detected value</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>
- <para>Name</para>
- </entry>
-
- <entry>
- <para>The unique name of the console configuration</para>
- </entry>
-
- <entry>
- <para>Name of the selected project</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Type</para>
- </entry>
-
- <entry>
- <para>Choose between "Core", "Annotations" and
- "JPA". Note that the two latter requires running Eclipse IDE with
- a JDK 5 runtime, otherwise you will get classloading and/or version errors.</para>
- </entry>
-
- <entry>
- <para>No default value</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Project</para>
- </entry>
-
- <entry>
- <para>The name of a java project which classpath should be used in the console
- configuration</para>
- </entry>
-
- <entry>
- <para>Name of the selected project</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Database connection</para>
- </entry>
-
- <entry>
- <para>DTP provided connection that you can use instead of what is in cfg.xml and jpa
- persistence.xml. It's possible to use either already configured hibernate or
- JPA connection or specify a new one here.</para>
- </entry>
-
- <entry>
- <para>[Hibernate Configured connection]</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Property file</para>
- </entry>
-
- <entry>
- <para>Path to a hibernate.properties file</para>
- </entry>
-
- <entry>
- <para>First hibernate.properties file found in the selected project</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Configuration file</para>
- </entry>
-
- <entry>
- <para>Path to a hibernate.cfg.xml file</para>
- </entry>
-
- <entry>
- <para>First hibernate.cfg.xml file found in the selected project</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Persistence unit</para>
- </entry>
-
- <entry>
- <para>Name of the persistence unit to use</para>
- </entry>
-
- <entry>
- <para><diffmk:wrapper diffmk:change="changed">No default value (lets Hibernate Entity Manager find the persistence
- unit or it can be defined manually using Browse button)</diffmk:wrapper></para>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- <tip>
- <title>Tip:</title>
-
- <para>The two latter settings are normally not required if you specify a project and it has <emphasis>
- <property moreinfo="none">
- <literal moreinfo="none"> /hibernate.cfg.xml </literal>
- </property>
- </emphasis> or <emphasis>
- <property moreinfo="none">
- <literal moreinfo="none">/META-INF/persistence.xml</literal>
- </property>
- </emphasis> in its project classpath.</para>
- </tip>
-
-
- <itemizedlist>
- <listitem>
- <para>
- <emphasis>
- <property moreinfo="none">Options</property>
- </emphasis> for the additional/optional settings</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Options Tab of the Console Configuration Wizard</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/plugins/plugins_2_a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The next table describes Hibernate Console Configuration options available on the <emphasis>
- <property moreinfo="none">Options</property>
- </emphasis> tab.</para>
-
- <table>
- <title>Hibernate Console Configuration Options</title>
-
- <tgroup cols="3">
- <colspec align="left" colnum="1" colwidth="1*"></colspec>
-
- <colspec colnum="2" colwidth="3*"></colspec>
-
- <colspec align="left" colnum="3" colwidth="1*"></colspec>
-
- <thead>
- <row>
- <entry align="center">
- <para>Parameter</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
-
- <entry align="center">
- <para>Auto detected value</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>
- <para>Naming strategy</para>
- </entry>
-
- <entry>
- <para>Fully qualified classname of a custom NamingStrategy. Only required if you use a
- special naming strategy.</para>
- </entry>
-
- <entry>
- <para>No default value</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Entity resolver</para>
- </entry>
-
- <entry>
- <para>Fully qualified classname of a custom EntityResolver. Only required if you have
- special xml entity includes in your mapping files.</para>
- </entry>
-
- <entry>
- <para>No default value</para>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>
- <property moreinfo="none">Classpath</property>
- </emphasis> for classpath</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Specifying Classpath in Hibernate Console Configuration</title>
- <mediaobject>
- <imageobject role="fo">
- <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"></imagedata>
- </imageobject>
-
- <imageobject role="html">
- <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"></imagedata>
- </imageobject>
-
- </mediaobject>
- </figure>
-
- <para>The following table specifies the parameters of the Classpath tab of the wizard.</para>
-
- <table>
- <title>Hibernate Console Configuration Classpath</title>
-
- <tgroup cols="3">
- <colspec align="left" colnum="1" colwidth="1*"></colspec>
-
- <colspec colnum="2" colwidth="3*"></colspec>
-
- <colspec colnum="3" colwidth="1*"></colspec>
-
- <thead>
- <row>
- <entry align="center">
- <para>Parameter</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
-
- <entry align="center">
- <para>Auto detected value</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>
- <para>Classpath</para>
- </entry>
-
- <entry>
- <para>The classpath for loading POJO and JDBC drivers; only needed if the default
- classpath of the Project does not contain the required classes. Do not add Hibernate
- core libraries or dependencies, they are already included. If you get ClassNotFound
- errors then check this list for possible missing or redundant
- directories/jars.</para>
- </entry>
-
- <entry>
- <para>Empty</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Include default classpath from project</para>
- </entry>
-
- <entry>
- <para>When enabled the project classpath will be appended to the classpath specified
- above</para>
- </entry>
-
- <entry>
- <para>Enabled</para>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>
- <property moreinfo="none">Mappings</property>
- </emphasis> for additional mappings</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Specifying additional Mappings in Hibernate Console Configuration</title>
- <mediaobject>
- <imageobject role="fo">
- <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"></imagedata>
- </imageobject>
-
- <imageobject role="html">
- <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Parameters of the Mappings tab of the <property moreinfo="none">Hibernate Console Configuration
- wizard</property> are explained below:</para>
- <table>
- <title>Hibernate Console Configuration Mappings</title>
-
- <tgroup cols="3">
- <colspec align="left" colnum="1" colwidth="1*"></colspec>
-
- <colspec colnum="2" colwidth="3*"></colspec>
-
- <colspec colnum="3" colwidth="1*"></colspec>
-
- <thead>
- <row>
- <entry align="center">
- <para>Parameter</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
-
- <entry align="center">
- <para>Auto detected value</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>
- <para>Mapping files </para>
- </entry>
-
- <entry>
- <para>List of additional mapping files that should be loaded. Note: A
- hibernate.cfg.xml or persistence.xml can also contain mappings. Thus if these are
- duplicated here, you will get "Duplicate mapping" errors when using the console
- configuration.</para>
- </entry>
-
- <entry>
- <para>empty</para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <itemizedlist>
- <listitem>
- <para>and the last tab <emphasis>
- <property moreinfo="none">Common</property>
- </emphasis></para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Common Tab of the Console Configuration Wizard</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/plugins/plugins_4_a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>It allows to define general aspects of the launch configuration including storage
- location, console encoding and some others.</para>
-
- <para>Clicking <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> creates the configuration and shows it in the <property moreinfo="none">Hibernate Configurations
- view</property>.</para>
-
- <figure float="0">
- <title>Console Overview</title>
- <mediaobject>
- <imageobject role="fo">
- <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"></imagedata>
- </imageobject>
-
- <imageobject role="html">
- <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"></imagedata>
- </imageobject>
-
- </mediaobject>
- </figure>
- </section>
+ <section id="creat_console_conf">
+ <title>Creating a Hibernate Console Configuration</title>
+ <para><diffmk:wrapper diffmk:change="changed">You can create a console configuration by running the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Console Configuration
+ Wizard</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">, shown in the following screenshot. The same wizard will also be used if
+ you are coming from the </diffmk:wrapper><emphasis>
+ <property moreinfo="none">hibernate.cfg.xml</property>
+ </emphasis> wizard and had enabled <emphasis>
+ <property moreinfo="none">Create Console Configuration</property>
+ </emphasis>.</para>
+ <note diffmk:change="added">
+ <title>Note:</title>
+ <para><diffmk:wrapper diffmk:change="changed">The wizard will look at the current selection in the IDE and try and auto-detect the
+ settings which you then can just approve or modify to suit your needs.</diffmk:wrapper></para>
+ </note>
+ <para></para>
+ <para>The dialog consists of five tabs: </para>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para><emphasis>
+ <property moreinfo="none">Main</property>
+ </emphasis> for the basic/required settings</para>
+ </listitem>
+ </itemizedlist>
+ <figure diffmk:change="added" float="0">
+ <title> Creating Hibernate Console Configuration</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added" role="fo">
+ <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"></imagedata>
+ </imageobject>
+ <imageobject diffmk:change="added" role="html">
+ <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The following table describes the available settings on the <emphasis>
+ <property moreinfo="none">Main</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> tab. The wizard can automatically detect the default values for most of them if you
+ started the wizard with the relevant java project or resource selected.</diffmk:wrapper></para>
+ <table diffmk:change="added">
+ <title>Hibernate Console Configuration Parameters</title>
+ <tgroup cols="3" diffmk:change="added">
+ <colspec align="left" colnum="1" colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="3*"></colspec>
+ <colspec align="left" colnum="3" colwidth="1*"></colspec>
+ <thead diffmk:change="added">
+ <row diffmk:change="added">
+ <entry align="center" diffmk:change="added">
+ <para>Parameter</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Description</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Auto detected value</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Name</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>The unique name of the console configuration</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Name of the selected project</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Type</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">Choose between "Core", "Annotations" and "JPA".
+ Note that the two latter requires running Eclipse IDE with a JDK 5 runtime,
+ otherwise you will get classloading and/or version errors.</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>No default value</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Project</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">The name of a java project which classpath should be used in the console
+ configuration</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Name of the selected project</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Database connection</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">DTP provided connection that you can use instead of what is in cfg.xml and jpa
+ persistence.xml. It's possible to use either already configured hibernate or
+ JPA connection or specify a new one here.</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>[Hibernate Configured connection]</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Property file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Path to a hibernate.properties file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>First hibernate.properties file found in the selected project</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Configuration file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Path to a hibernate.cfg.xml file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>First hibernate.cfg.xml file found in the selected project</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Persistence unit</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Name of the persistence unit to use</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">No default value (let Hibernate Entity Manager find the persistence unit or
+ it can be defined manually using Browse button)</diffmk:wrapper></para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <tip diffmk:change="added">
+ <title>Tip:</title>
+ <para><diffmk:wrapper diffmk:change="changed">The two latter settings are usually not required if you specify a project and it has
+ </diffmk:wrapper><emphasis>
+ <property diffmk:change="added" moreinfo="none">
+ <literal moreinfo="none"> /hibernate.cfg.xml </literal>
+ </property>
+ </emphasis> or <emphasis>
+ <property diffmk:change="added" moreinfo="none">
+ <literal moreinfo="none">/META-INF/persistence.xml</literal>
+ </property>
+ </emphasis> in its project classpath.</para>
+ </tip>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added">
+ <emphasis diffmk:change="added">
+ <property moreinfo="none">Options</property>
+ </emphasis> for the additional/optional settings</para>
+ </listitem>
+ </itemizedlist>
+ <figure diffmk:change="added" float="0">
+ <title>Options Tab of the Console Configuration Wizard</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata fileref="images/plugins/plugins_2_a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="changed">The next table describes Hibernate Console Configuration options available on the
+ </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Options</property>
+ </emphasis> tab.</para>
+ <table diffmk:change="added">
+ <title>Hibernate Console Configuration Options</title>
+ <tgroup cols="3" diffmk:change="added">
+ <colspec align="left" colnum="1" colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="3*"></colspec>
+ <colspec align="left" colnum="3" colwidth="1*"></colspec>
+ <thead diffmk:change="added">
+ <row diffmk:change="added">
+ <entry align="center" diffmk:change="added">
+ <para>Parameter</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Description</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Auto detected value</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">Database dialect</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Define a database dialect. It's possible either to write your value or choose
+ from list. </diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">No default value</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Naming strategy</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Fully qualified classname of a custom NamingStrategy. Only required if you use
+ a special naming strategy.</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>No default value</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Entity resolver</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">Fully qualified classname of a custom EntityResolver. Only required if you
+ have special xml entity includes in your mapping files.</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>No default value</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para><emphasis>
+ <property moreinfo="none">Classpath</property>
+ </emphasis> for classpath</para>
+ </listitem>
+ </itemizedlist>
+ <figure diffmk:change="added" float="0">
+ <title>Specifying Classpath in Hibernate Console Configuration</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added" role="fo">
+ <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"></imagedata>
+ </imageobject>
+ <imageobject diffmk:change="added" role="html">
+ <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The following table specifies the parameters of the Classpath tab of the wizard.</para>
+ <table diffmk:change="added">
+ <title>Hibernate Console Configuration Classpath</title>
+ <tgroup cols="3" diffmk:change="added">
+ <colspec align="left" colnum="1" colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="3*"></colspec>
+ <colspec colnum="3" colwidth="1*"></colspec>
+ <thead diffmk:change="added">
+ <row diffmk:change="added">
+ <entry align="center" diffmk:change="added">
+ <para>Parameter</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Description</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Auto detected value</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Classpath</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">The classpath for loading POJO and JDBC drivers; only needed if the default
+ classpath of the Project does not contain the required classes. Do not add
+ Hibernate core libraries or dependencies, they are already included. If you get
+ ClassNotFound errors then check this list for possible missing or redundant
+ directories/jars.</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Empty</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Include default classpath from project</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">When enabled the project classpath will be appended to the classpath specified
+ above</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Enabled</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para><emphasis>
+ <property moreinfo="none">Mappings</property>
+ </emphasis> for additional mappings</para>
+ </listitem>
+ </itemizedlist>
+ <figure diffmk:change="added" float="0">
+ <title>Specifying additional Mappings in Hibernate Console Configuration</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added" role="fo">
+ <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"></imagedata>
+ </imageobject>
+ <imageobject diffmk:change="added" role="html">
+ <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Parameters of the Mappings tab of the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Hibernate Console Configuration
+ wizard</diffmk:wrapper></property> are explained below:</para>
+ <table diffmk:change="added">
+ <title>Hibernate Console Configuration Mappings</title>
+ <tgroup cols="3" diffmk:change="added">
+ <colspec align="left" colnum="1" colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="3*"></colspec>
+ <colspec colnum="3" colwidth="1*"></colspec>
+ <thead diffmk:change="added">
+ <row diffmk:change="added">
+ <entry align="center" diffmk:change="added">
+ <para>Parameter</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Description</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Auto detected value</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Mapping files </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">List of additional mapping files that should be loaded. Note: A
+ hibernate.cfg.xml or persistence.xml can also contain mappings. Thus if these are
+ duplications here, you will get "Duplicate mapping" errors when using the console
+ configuration.</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>empty</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para>and the last tab <emphasis>
+ <property moreinfo="none">Common</property>
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <figure diffmk:change="added" float="0">
+ <title>Common Tab of the Console Configuration Wizard</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata fileref="images/plugins/plugins_4_a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="changed">It allows to define general aspects of the launch configuration including storage
+ location, console encoding and some others.</diffmk:wrapper></para>
+ <para>Clicking <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> creates the configuration and shows it in the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Hibernate Configurations
+ view</diffmk:wrapper></property>.</para>
+ <figure diffmk:change="added" float="0">
+ <title>Console Overview</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added" role="fo">
+ <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"></imagedata>
+ </imageobject>
+ <imageobject diffmk:change="added" role="html">
+ <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
<section id="modif_console_conf">
- <title>Modifying a Hibernate Console Configuration
- </title>
- <para>When you created a hibernate console configuration you can modify it in 2 ways:
- </para>
-
+ <title><diffmk:wrapper diffmk:change="changed">Modifying a Hibernate Console Configuration </diffmk:wrapper></title>
+ <para><diffmk:wrapper diffmk:change="changed">When you created a hibernate console configuration you can modify it in 2 ways: </diffmk:wrapper></para>
<itemizedlist>
<listitem>
- <para>right click on the configuration in
- <emphasis>
- <property moreinfo="none">Hibernate Configurations View->Edit Configuration
- </property>
- </emphasis>.</para>
-
- <figure float="0">
- <title>Opening Edit Configuration Wizard</title>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/plugins/plugins_4_c.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para> After clicking you will see the Edit Configuration Wizard that is similar to <emphasis>
+ <para><diffmk:wrapper diffmk:change="changed">right-click on the configuration in </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Hibernate Configurations View->Edit Configuration </diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> or just double-click on </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Console Configuration</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> item.</diffmk:wrapper></para>
+ <figure float="0">
+ <title>Opening Edit Configuration Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/plugins_4_c.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="changed"> After clicking you will see the Edit Configuration Wizard that is similar to
+ </diffmk:wrapper><emphasis>
<property moreinfo="none">Create Console Configuration</property>
- </emphasis>,described in <link linkend="creat_console_conf">Creating a Hibernate Console Configuration section</link>.
- </para>
+ </emphasis>,described in <link linkend="creat_console_conf"><diffmk:wrapper diffmk:change="changed">Creating a Hibernate Console
+ Configuration section</diffmk:wrapper></link><diffmk:wrapper diffmk:change="changed">. </diffmk:wrapper></para>
</listitem>
- <listitem><para>use Properties view for modifying some of Console Configuration properties.</para>
+ <listitem>
+ <para>use Properties view for modifying some of Console Configuration properties.</para>
<figure float="0">
<title>Properties View</title>
-
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/plugins_4_b.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>The following table describes the available settings in the Properties view. Most properties are changeable by left click but some are not.
-
- <table>
- <title>Properties</title>
-
- <tgroup cols="3">
- <colspec align="left" colnum="1" colwidth="1*"></colspec>
-
- <colspec colnum="2" colwidth="3*"></colspec>
-
- <colspec align="left" colnum="3" colwidth="1*"></colspec>
-
- <thead>
- <row>
- <entry align="center">
- <para>Property</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
-
- <entry align="center">
- <para>Is Changeable</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>
- <para>Additional mapping files </para>
- </entry>
-
- <entry>
- <para>List of additional mapping files that should be loaded.
- </para>
- </entry>
-
- <entry>
- <para>False</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>Configuration file</para>
- </entry>
-
- <entry>
- <para>Path to a hibernate.cfg.xml file</para>
- </entry>
-
- <entry>
- <para>False</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>Connection</para>
- </entry>
-
- <entry>
- <para>DTP provided connection that you can use instead of what is in cfg.xml and jpa
- persistence.xml. It's possible to use either already configured hibernate or
- JPA connection or specify a new one here.</para>
- </entry>
-
- <entry>
- <para>True</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>Name</para>
- </entry>
-
- <entry>
- <para>The unique name of the console configuration</para>
- </entry>
-
- <entry>
- <para>True</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>Project</para>
- </entry>
-
- <entry>
- <para>The name of a java project which classpath should be used in the console
- configuration</para>
- </entry>
-
- <entry>
- <para>True</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>Properties file</para>
- </entry>
-
- <entry>
- <para>Path to a hibernate.properties file</para>
- </entry>
-
- <entry>
- <para>False</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>Type</para>
- </entry>
-
- <entry>
- <para>Choose between "CORE", "ANNOTATIONS" and
- "JPA" according to the method of relational mapping you want to use. Note that the two latter requires running Eclipse IDE with
- a JDK 5 runtime, otherwise you will get classloading and/or version errors.</para>
- </entry>
-
- <entry>
- <para>True</para>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- </para>
+ <para><diffmk:wrapper diffmk:change="changed">The following table describes the available settings in the Properties view. Most
+ properties are changeable by left click but some are not. </diffmk:wrapper><table>
+ <title>Properties</title>
+ <tgroup cols="3" diffmk:change="added">
+ <colspec align="left" colnum="1" colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="3*"></colspec>
+ <colspec align="left" colnum="3" colwidth="1*"></colspec>
+ <thead diffmk:change="added">
+ <row diffmk:change="added">
+ <entry align="center" diffmk:change="added">
+ <para>Property</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Description</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Is Changeable</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Additional mapping files </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">List of additional mapping files that should be loaded. </diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>False</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Configuration file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Path to a hibernate.cfg.xml file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>False</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Connection</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">DTP provided connection that you can use instead of what is in cfg.xml
+ and jpa persistence.xml. It's possible to use either already configured
+ hibernate or JPA connection or specify a new one here.</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>True</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Name</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>The unique name of the console configuration</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>True</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Project</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">The name of a java project which classpath should be used in the console
+ configuration</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>True</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Properties file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Path to a hibernate.properties file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>False</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Type</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">Choose between "CORE", "ANNOTATIONS" and
+ "JPA" according to the method of relational mapping you want to
+ use. Note, the two latter requires running Eclipse IDE with a JDK 5
+ runtime, otherwise you will get classloading and/or version errors.</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>True</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table></para>
</listitem>
</itemizedlist>
</section>
-
+ <section diffmk:change="added" id="closing_conf_config">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Closing Hibernate Console Configuration</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To close </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Hibernate Console Configuration</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> you need do right-click your configuration
+ and choose </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Close Configuration</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> option </diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Close Hibernate Console Configuration</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/plugins/plugins_4_d.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">While closing configuration the connection with database will be closed, jar libs will
+ be unlock (for Windows) and other resources will set as free. </diffmk:wrapper></para>
</section>
-
-
-
+ </section>
<section id="refeng_codegen" role="updated">
<title>Reverse Engineering and Code Generation</title>
-
- <para>A "click-and-generate" reverse engineering and code generation facility
- is available. This facility allows you to generate a range of artifacts based on database or
- an already existing Hibernate configuration, be that mapping files or annotated classes. Some
- of these are POJO Java source file, Hibernate <emphasis>
+ <para><diffmk:wrapper diffmk:change="changed">A "click-and-generate" reverse engineering and code generation facility is
+ available. This facility allows you to generate a range of artifacts based on database or an
+ already existing Hibernate configuration, be that mapping files or annotated classes. Some of
+ these are POJO Java source file, Hibernate </diffmk:wrapper><emphasis>
<property moreinfo="none">.hbm.xml</property>
</emphasis>, <emphasis>
<property moreinfo="none">hibernate.cfg.xml</property>
</emphasis> generation and schema documentation.</para>
-
<para>To start working with this process, start the <property moreinfo="none">Hibernate Code
- Generation</property> which is available in the toolbar via the
- <property moreinfo="none">Hibernate</property> icon or via the <emphasis>
+ Generation</property><diffmk:wrapper diffmk:change="changed"> which is available in the toolbar via the </diffmk:wrapper><property moreinfo="none">Hibernate</property> icon or via the <emphasis>
<property moreinfo="none">Run > Hibernate Code Generation</property>
</emphasis> menu item.</para>
-
<section id="code_gen">
<title>Code Generation Launcher</title>
-
<para>When you click on <emphasis>
<property moreinfo="none">Open Hibernate Code Generation Dialog...</property>
</emphasis> the standard Eclipse launcher dialog will appear. In this dialog you can create,
edit and delete named Hibernate code generation "launchers".</para>
-
<figure float="0" id="hib_code_gen">
<title>Getting Hibernate Code Generation Wizard</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="images/plugins/plugins_6.png" format="PNG"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_6.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para></para>
-
<figure float="0">
<title>Hibernate Code Generation Wizard</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_7.png" format="PNG" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_7.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>The first time you create a code generation launcher you should give it a meaningful
name, otherwise the default prefix <emphasis>
<property moreinfo="none">New_Generation</property>
</emphasis> will be used.</para>
-
<tip>
<title>Tip:</title>
- <para>The "At least one exporter option must be selected" is just a
- warning stating that for this launch to work you need to select an exporter on the
- Exporter tab. When an exporter has been selected the warning will disappear.</para>
+ <para><diffmk:wrapper diffmk:change="changed">The "At least one exporter option must be selected" is just a warning
+ stating that for this launch to work you need to select an exporter on the Exporter tab.
+ When an exporter has been selected the warning will disappear.</diffmk:wrapper></para>
</tip>
-
<para>The dialog also have the standard tabs <emphasis>
<property moreinfo="none">Refresh</property>
</emphasis> and <emphasis>
@@ -1286,62 +1192,49 @@
</emphasis> that can be used to configure which directories should be automatically
refreshed and various general settings launchers, such as saving them in a project for
sharing the launcher within a team.</para>
-
<para>On the <emphasis>
<property moreinfo="none">Main</property>
</emphasis> tab you see the following fields:</para>
-
<table>
<title>Code generation "Main" tab fields</title>
-
<tgroup cols="2">
<colspec align="left" colnum="1" colwidth="1*"></colspec>
-
<colspec colnum="2" colwidth="3*"></colspec>
-
<colspec colnum="3" colwidth="0.5*"></colspec>
-
<thead>
<row>
<entry align="center">
<para>Field</para>
</entry>
-
<entry align="center">
<para>Description</para>
</entry>
</row>
</thead>
-
<tbody>
<row>
<entry>
<para>Console Configuration</para>
</entry>
-
<entry>
<para>The name of the console configuration which should be used when code
generating</para>
</entry>
</row>
-
<row>
<entry>
<para>Output directory</para>
</entry>
-
<entry>
- <para>Path to a directory where all output will be written by default. Be aware that
- existing files will be overwritten, so be sure to specify the correct
- directory.</para>
+ <para><diffmk:wrapper diffmk:change="changed">Path to a directory where all output will be written by default. It's possible
+ to enter absolute directory path, for example - "d:/temp". Be aware that existing
+ files will be overwritten, so be sure to specify the correct directory.</diffmk:wrapper></para>
</entry>
</row>
-
<row>
<entry>
<para>Reverse engineer from JDBC Connection</para>
</entry>
-
<entry>
<para>If enabled, the tools will reverse engineer the database available via the
connection information in the selected Hibernate Console Configuration and
@@ -1350,23 +1243,19 @@
configuration.</para>
</entry>
</row>
-
<row>
<entry>
<para>Package</para>
</entry>
-
<entry>
<para>The package name here is used as the default package name for any entities
found when reverse engineering</para>
</entry>
</row>
-
<row>
<entry>
<para>reveng.xml</para>
</entry>
-
<entry>
<para>Path to a reveng.xml file. A reveng.xml file allows you to control certain
aspects of the reverse engineering. e.g. how jdbc types are mapped to hibernate
@@ -1375,12 +1264,10 @@
create a new one. See more details about the reveng.xml file in <xref linkend="reverseengineering"></xref>.</para>
</entry>
</row>
-
<row>
<entry>
<para>reveng. strategy</para>
</entry>
-
<entry>
<para>If reveng.xml does not provide enough customization you can provide your own
implementation of an ReverseEngineeringStrategy. The class needs to be in the
@@ -1389,50 +1276,42 @@
example of a custom strategy.</para>
</entry>
</row>
-
<row>
<entry>
<para>Generate basic typed composite ids</para>
</entry>
-
<entry>
- <para>A table that has a multi-column primary key a <composite-id>
- mapping will always be created. If this option is enabled and there are matching
+ <para><diffmk:wrapper diffmk:change="changed">A table that has a multi-column primary key a <composite-id> mapping
+ will always be created. If this option is enabled and there are matching
foreign-keys each key column is still considered a 'basic' scalar (string, long,
etc.) instead of a reference to an entity. If you disable this option a
- <code><key-many-to-one></code> instead. Note: a <code><many-to-one></code>
- property is still created, but is simply marked as non-updatable and
- non-insertable.</para>
+ </diffmk:wrapper><code><key-many-to-one></code><diffmk:wrapper diffmk:change="changed"> instead. Note: a
+ </diffmk:wrapper><code><many-to-one></code><diffmk:wrapper diffmk:change="changed"> property is still created, but is simply marked
+ as non-updatable and non-insertable.</diffmk:wrapper></para>
</entry>
</row>
-
<row>
<entry>
<para>Detect optimistic lock columns</para>
</entry>
-
<entry>
<para>Automatically detect optimistic lock columns. Controllable via reveng.
strategy; the current default is to use columns named VERSION or TIMESTAMP.</para>
</entry>
</row>
-
<row>
<entry>
<para>Detect many-to-many tables</para>
</entry>
-
<entry>
<para>Automatically detect many-to-many tables. Controllable via reveng.
strategy.</para>
</entry>
</row>
-
<row>
<entry>
<para>Detect one-to-one associations</para>
</entry>
-
<entry>
<para> Reverse engineering detects one-to-one associations via primary key and both
hbm.xml and annotation generation generates the proper code for it. </para>
@@ -1441,27 +1320,20 @@
if not wanted. </para>
</entry>
</row>
-
-
-
-
<row>
<entry>
<para>Use custom templates</para>
</entry>
-
<entry>
<para>If enabled, the Template directory will be searched first when looking up the
templates, allowing you to redefine how the individual templates process the
hibernate mapping model.</para>
</entry>
</row>
-
<row>
<entry>
<para>Template directory</para>
</entry>
-
<entry>
<para>A path to a directory with custom templates</para>
</entry>
@@ -1470,334 +1342,267 @@
</tgroup>
</table>
</section>
-
<section id="exportes">
<title>Exporters</title>
-
<para>The <emphasis>
<property moreinfo="none">Exporters</property>
</emphasis> tab is used to specify which type of code that should be generated. Each
selection represents an Exporter that is responsible for generating the code, hence the
name.</para>
-
<figure float="0">
<title>Selecting Exporters</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_8.png" format="PNG" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_8.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>The following table describes in short the various exporters. Remember you can
add/remove any Exporters depending on your needs.</para>
-
<table>
<title>Code generation "Exporter" tab fields</title>
-
<tgroup cols="2">
<colspec align="left" colnum="1" colwidth="1*"></colspec>
-
<colspec colnum="2" colwidth="3*"></colspec>
-
<thead>
<row>
<entry align="center">
<para>Field</para>
</entry>
-
<entry align="center">
<para>Description</para>
</entry>
</row>
</thead>
-
<tbody>
<row>
<entry>
<para>Domain code</para>
</entry>
-
<entry>
<para>Generates POJO's for all the persistent classes and components found in the
given Hibernate configuration.</para>
</entry>
</row>
-
<row>
<entry>
<para>DAO code</para>
</entry>
-
<entry>
<para>Generates a set of DAO's for each entity found.</para>
</entry>
</row>
-
<row>
<entry>
<para>Hibernate XML Mappings</para>
</entry>
-
<entry>
<para>Generate mapping (hbm.xml) files for each entity.</para>
</entry>
</row>
-
<row>
<entry>
<para>Hibernate XML Configuration</para>
</entry>
-
<entry>
<para>Generate a hibernate.cfg.xml file. Used to keep the hibernate.cfg.xml update
with any new found mapping files.</para>
</entry>
</row>
-
<row>
<entry>
<para>Schema Documentation (.html)</para>
</entry>
-
<entry>
<para>Generates a set of html pages that documents the database schema and some of
the mappings.</para>
</entry>
</row>
-
<row>
<entry>
<para>Generic Exporter (hbmtemplate)</para>
</entry>
-
<entry>
<para>Fully customizable exporter which can be used to perform custom
generation.</para>
</entry>
</row>
-
<row>
<entry>
<para>Schema Export (.ddl)</para>
</entry>
-
<entry>
<para>Generates the appropriate SQL DDL and allows you to store the result in a file
or export it directly to the database.</para>
</entry>
</row>
-
</tbody>
</tgroup>
</table>
-
<para>Each Exporter listens to certain properties and these can be setup in the <emphasis>
<property moreinfo="none">Properties</property>
</emphasis> section where you can add/remove predefined or customer properties for each of
the exporters. The following table lists the time of writing predefined properties:</para>
-
<para>
<table>
<title>Exporter Properties</title>
-
<tgroup cols="2">
<colspec align="left" colnum="1" colwidth="1*"></colspec>
-
<colspec colnum="2" colwidth="3*"></colspec>
-
<thead>
<row>
<entry align="center">
<para>Name</para>
</entry>
-
<entry align="center">
<para>Description</para>
</entry>
</row>
</thead>
-
<tbody>
<row>
<entry>
<para>jdk5</para>
</entry>
-
<entry>
<para>Generate Java 5 syntax</para>
</entry>
</row>
-
<row>
<entry>
<para>ejb3</para>
</entry>
-
<entry>
<para>Generate EJB 3 annotations</para>
</entry>
</row>
-
<row>
<entry>
<para>for_each</para>
</entry>
-
<entry>
<para>Specifies for which type of model elements the exporter should create a file
and run through the templates. Possible values are: entity, component,
configuration</para>
</entry>
</row>
-
<row>
<entry>
<para>template_path</para>
</entry>
-
<entry>
<para>Custom template directory for this specific exporter. You can use Eclipse
variables.</para>
</entry>
</row>
-
<row>
<entry>
<para>template_name</para>
</entry>
-
<entry>
<para>Name for template relative to the template path</para>
</entry>
</row>
-
<row>
<entry>
<para>outputdir</para>
</entry>
-
<entry>
<para>Custom output directory for this specific exporter. You can use Eclipse
variables.</para>
</entry>
</row>
-
<row>
<entry>
<para>file_pattern</para>
</entry>
-
<entry>
<para>Pattern to use for the generated files, relatively for the output dir.
Example: {package-name}/{class-name}.java .</para>
</entry>
</row>
-
-
-
<row>
<entry>
<para>dot.executable</para>
</entry>
-
<entry>
<para>Executable to run GraphViz (only relevant, but optional for Schema
documentation)</para>
</entry>
</row>
-
<row>
<entry>
<para>drop</para>
</entry>
-
<entry>
<para>Output will contain drop statements for the tables, indices and
constraints</para>
</entry>
</row>
-
<row>
<entry>
<para>delimiter</para>
</entry>
-
<entry>
<para>If specified the statements will be dumped to this file</para>
</entry>
</row>
-
<row>
<entry>
<para>create</para>
</entry>
-
<entry>
<para>Output will contain create statements for the tables, indices and
constraints</para>
</entry>
</row>
-
<row>
<entry>
<para>scriptToConsole</para>
</entry>
-
<entry>
<para>The script will be output to Console</para>
</entry>
</row>
-
<row>
<entry>
<para>exportToDatabase</para>
</entry>
-
<entry>
<para>Executes the generated statements against the database</para>
</entry>
</row>
-
<row>
<entry>
<para>outputFileName</para>
</entry>
-
<entry>
<para>If specified the statements will be dumped to this file</para>
</entry>
</row>
-
<row>
<entry>
<para>haltOnError</para>
</entry>
-
<entry>
<para>Halts the build process if an error occurs</para>
</entry>
</row>
-
<row>
<entry>
<para>format</para>
</entry>
-
<entry>
<para>Applies basic formatting to the statements</para>
</entry>
</row>
-
<row>
<entry>
<para>schemaUpdate</para>
</entry>
-
<entry>
<para>Updates a schema</para>
</entry>
@@ -1806,32 +1611,25 @@
</tgroup>
</table>
</para>
-
<para>To add a property to the chosen Exporter click the <emphasis>
<property moreinfo="none">Add</property>
</emphasis> button in the <property moreinfo="none">Properties</property> section. In the appeared dialog
you should select the property from the proposed list and the value for it.</para>
-
<figure float="0">
<title>Adding the Property for Schema Export (.ddl)</title>
-
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/plugins_8a.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<tip>
<title>Tip:</title>
-
<para>If the property is a directory, it is possible to browse directories in the Value
field.</para>
</tip>
-
<figure float="0">
<title>Specifying the Property Value</title>
-
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/plugins_8b.png"></imagedata>
@@ -1840,10 +1638,8 @@
</figure>
</section>
</section>
-
<section id="map_config_editor">
<title>Hibernate Mapping and Configuration File Editor</title>
-
<para>The <property moreinfo="none">Hibernate Mapping File editor</property> provides XML editing functionality
for the <emphasis>
<property moreinfo="none">hbm.xml </property>
@@ -1851,52 +1647,41 @@
<property moreinfo="none">cfg.xml</property>
</emphasis> files. The editor is based on the Eclipse WTP tools and extends its functionality
to provide Hibernate specific code completion.</para>
-
<figure float="0">
<title>XML Editing Functionality</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_9.png" format="PNG" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_9.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<section>
<title>Java property/class completion</title>
-
- <para>Package, class, and field completion is enabled for relevant XML attributes. The
- auto-completion detects its context and limits the completion for e.g. <code><property></code> and only shows the properties/fields available in the enclosing
- <code><class></code>
- ,
- <code><subclass></code>
- etc. It is also possible to navigate from the <emphasis>
+ <para><diffmk:wrapper diffmk:change="changed">Package, class, and field completion is enabled for relevant XML attributes. The
+ auto-completion detects its context and limits the completion for e.g.
+ </diffmk:wrapper><code><property></code><diffmk:wrapper diffmk:change="changed"> and only shows the properties/fields available in the
+ enclosing </diffmk:wrapper><code><class></code><diffmk:wrapper diffmk:change="changed"> , </diffmk:wrapper><code><subclass></code><diffmk:wrapper diffmk:change="changed"> etc. It is also
+ possible to navigate from the </diffmk:wrapper><emphasis>
<property moreinfo="none">hbm.xml</property>
</emphasis> files to the relevant class/field in java code.</para>
-
<figure float="0">
<title>Navigation Functionality</title>
-
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_10.png" format="PNG" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_10.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
-
</figure>
-
<para>This is done via the standard hyperlink navigation functionality in Eclipse; per default
it is done by pressing F3 while the cursor is on a class/field or by pressing <emphasis>
<property moreinfo="none">Ctrl</property>
</emphasis> and the mouse button to perform the same navigation.</para>
-
<para>For java completion and navigation to work the file needs to reside inside an Eclipse
Java project, otherwise no completion will occur.</para>
<note>
@@ -1904,25 +1689,20 @@
<para>Java completion does not require a Hibernate console configuration to be used.</para>
</note>
</section>
-
<section>
<title>Table/Column completion</title>
-
<para>Table and column completion is also available for all table and column attributes. </para>
-
<figure float="0">
<title>Table and Column Completion</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_11.png" format="PNG" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_11.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<important>
<title>Important:</title>
<para>Table/Column completion requires a proper configured hibernate console configuration
@@ -1930,69 +1710,56 @@
<property moreinfo="none">hbm.xml</property>
</emphasis> resides.</para>
</important>
-
<para>You can check which console configuration is selected under the Properties of a project
and look under the <emphasis>
<property moreinfo="none">Hibernate Settings</property>
</emphasis> page. When a proper configuration is selected it will be used to fetch the
table/column names in the background.</para>
-
<note>
<title>Note:</title>
<para>Currently it is not recommended to use this feature on large databases since it does
not fetch the information iteratively. It will be improved in future versions.</para>
</note>
</section>
-
<section>
<title>Configuration property completion</title>
-
<para>In <emphasis>
<property moreinfo="none">cfg.xml</property>
- </emphasis> code completion for the value of <code><property> name</code> attributes is available.</para>
-
-
+ </emphasis> code completion for the value of <code><property> name</code><diffmk:wrapper diffmk:change="changed"> attributes
+ is available.</diffmk:wrapper></para>
<figure float="0">
<title>Property Completion</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_12.png" format="PNG" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_12.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
</section>
</section>
-
<section id="map_config_struct_editor">
<title>Structured Hibernate Mapping and Configuration File Editor</title>
<para>The structured editor represents the file in the tree form. It also allows to modify the
structure of the file and its elements with the help of tables provided on the right-hand
area.</para>
-
<para>To open any mapping file in the editor, choose <emphasis>
<property moreinfo="none">Open With > Hibernate 3.0 XML Editor</property>
</emphasis> option from the context menu of the file. The editor should look as
follows:</para>
-
<figure float="0">
<title>Structured hbm.xml Editor</title>
-
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/plugins_12_a.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>For the configuration file you should choose <emphasis>
<property moreinfo="none">Open With > Hibernate Configuration 3.0 XML Editor</property>
</emphasis>option.</para>
-
<figure float="0">
<title>Structured cfg.xml Editor</title>
<mediaobject>
@@ -2001,98 +1768,85 @@
</imageobject>
</mediaobject>
</figure>
-
</section>
-
- <section id="properties_editor">
- <title>JBoss Tools Properties Editor</title>
-
- <para>The editor is meant for editing <literal moreinfo="none">.properties</literal> files. It contains two tabs: the
- <property moreinfo="none">Properties</property> (UI) tab and the
- <property moreinfo="none">Source</property> tab for manual editing.</para>
-
- <para>For <literal moreinfo="none">hibernate.properties</literal> file <property moreinfo="none">JBoss Tools Properties Editor</property>
- provides content assist which is available both for hibernate properties and property values. You can make use of
- the content assist while editing the file in the Source view and in the Properties view of the editor.</para>
-
-
- <para>To add the property in the
- <property moreinfo="none">Properties</property> view, click the <emphasis>
- <property moreinfo="none">Add</property></emphasis> button.</para>
-
- <figure float="0">
- <title>Adding the Property</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/plugins/add_property1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In the <emphasis>
- <property moreinfo="none">Name</property></emphasis> field press <emphasis>
- <property moreinfo="none">Ctrl+Space</property></emphasis> to invoke the content assist.
- It will suggest <emphasis>
- <property moreinfo="none">'hibernate.'</property></emphasis> which is the prefix for all hibernate properties. After
- selecting <emphasis>
- <property moreinfo="none">'hibernate.'</property></emphasis> and invoking the content assist again,
- other prefixes and properties are displayed as the proposals with a description of each one.</para>
-
- <figure float="0">
- <title>Content Assist for Properties Names</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/plugins/add_property2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>When invoking the content assist in the <emphasis>
- <property moreinfo="none">Value</property></emphasis> field, it also provides a list of proposals.</para>
-
- <figure float="0">
- <title>Content Assist for Properties Values</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/plugins/add_property3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In the <property moreinfo="none">Source</property> view of the editor, content assist also could be invoked both for properties names and values:</para>
-
- <figure float="0">
- <title>Content Assist in the Source view</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/plugins/add_property4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <figure float="0">
- <title>Content Assist in the Source view</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/plugins/add_property5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
+ <section id="properties_editor">
+ <title>JBoss Tools Properties Editor</title>
+ <para>The editor is meant for editing <literal moreinfo="none">.properties</literal><diffmk:wrapper diffmk:change="changed"> files. It contains two
+ tabs: the </diffmk:wrapper><property moreinfo="none">Properties</property><diffmk:wrapper diffmk:change="changed"> (UI) tab and the </diffmk:wrapper><property moreinfo="none">Source</property><diffmk:wrapper diffmk:change="changed"> tab for
+ manual editing.</diffmk:wrapper></para>
+ <para>For <literal moreinfo="none">hibernate.properties</literal> file <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss Tools Properties
+ Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> provides content assist which is available both for hibernate properties
+ and property values. You can make use of the content assist while editing the file in the
+ Source view and in the Properties view of the editor.</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">To add the property in the </diffmk:wrapper><property moreinfo="none">Properties</property> view, click the <emphasis>
+ <property moreinfo="none">Add</property>
+ </emphasis> button.</para>
+ <figure float="0">
+ <title>Adding the Property</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/add_property1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>In the <emphasis>
+ <property moreinfo="none">Name</property>
+ </emphasis> field press <emphasis>
+ <property moreinfo="none">Ctrl+Space</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> to invoke the content assist. It will suggest </diffmk:wrapper><emphasis>
+ <property moreinfo="none">'hibernate.'</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> which is the prefix for all hibernate properties. After selecting </diffmk:wrapper><emphasis>
+ <property moreinfo="none">'hibernate.'</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> and invoking the content assist again, other prefixes and properties are displayed
+ as the proposals with a description of each one.</diffmk:wrapper></para>
+ <figure float="0">
+ <title>Content Assist for Properties Names</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/add_property2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>When invoking the content assist in the <emphasis>
+ <property moreinfo="none">Value</property>
+ </emphasis> field, it also provides a list of proposals.</para>
+ <figure float="0">
+ <title>Content Assist for Properties Values</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/add_property3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>In the <property moreinfo="none">Source</property><diffmk:wrapper diffmk:change="changed"> view of the editor, content assist also could be
+ invoked both for properties names and values:</diffmk:wrapper></para>
+ <figure float="0">
+ <title>Content Assist in the Source view</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/add_property4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure float="0">
+ <title>Content Assist in the Source view</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/add_property5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
<section id="rev_xml_editor">
<title>Reveng.xml Editor</title>
-
<para>A <emphasis>
<property moreinfo="none">reveng.xml </property>
</emphasis> file is used to customize and control how reverse engineering is performed by the
tools. The plugins provide an editor to ease the editing of this file and hence used to
configure the reverse engineering process.</para>
-
<para>The editor is intended to allow easy definition of type mappings, table include/excludes
and specific override settings for columns, e.g. define an explicit name for a column when the
default naming rules are not applicable.</para>
-
<note>
<title>Note:</title>
<para> Not all the features of the <emphasis>
@@ -2103,73 +1857,64 @@
</emphasis>, please see <xref linkend="hibernaterevengxmlfile"></xref>
</para>
</note>
-
<para>The editor is activated as soon as an <emphasis>
<property moreinfo="none">.reveng.xml </property>
</emphasis> file is opened. To get an initial <emphasis>
<property moreinfo="none">reveng.xml </property>
- </emphasis> file the <property moreinfo="none">Reverse Engineering File Wizard</property> can be started via <emphasis>
+ </emphasis> file the <property moreinfo="none">Reverse Engineering File Wizard</property><diffmk:wrapper diffmk:change="changed"> can be started via
+ </diffmk:wrapper><emphasis>
<property moreinfo="none">Ctrl+N</property>
</emphasis> and <emphasis>
<property moreinfo="none">Hibernate > Hibernate Reverse Engineering File (reveng.xml)</property>
</emphasis> then.</para>
-
<figure float="0">
<title>ChooseReverse Engineering File Wizard </title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_22.png" format="PNG" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_22.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>Or you can get it via the <property moreinfo="none">Code Generation Launcher</property> by checking the
proper section in the <emphasis>
<property moreinfo="none">Main</property>
</emphasis> tab of the <link linkend="hib_code_gen">Hibernate Code Generation
Wizard</link>.</para>
-
<para>The following screenshot shows the <emphasis>
<property moreinfo="none">Overview</property>
</emphasis> page where the wanted console configuration is selected (auto-detected if
Hibernate 3 support is enabled for the project)</para>
-
<figure float="0">
<title>Overview Page</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_13.png" format="PNG" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_13.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>The <emphasis>
<property moreinfo="none">Table Filter</property>
- </emphasis> page allows you to specify which tables to include and exclude. Pressing <emphasis>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> page allows you to specify which tables to include and exclude. Pressing
+ </diffmk:wrapper><emphasis>
<property moreinfo="none">Refresh</property>
</emphasis> shows the tables from the database that have not yet been excluded.</para>
-
<figure float="0">
<title>Table Filters Page</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_14.png" format="PNG" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_14.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>The <emphasis>
<property moreinfo="none">Type Mappings</property>
</emphasis> page is used for specifying type mappings from JBDC types to any Hibernate type
@@ -2177,78 +1922,62 @@
tables press <emphasis>
<property moreinfo="none">Refresh</property>
</emphasis> button underneath. More about type mappings you can find further in the <link linkend="type_map">Type Mappings</link> section.</para>
-
<figure float="0">
<title>Type Mappings Page</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_15.png" format="PNG" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_15.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>The <emphasis>
<property moreinfo="none">Table and Columns</property>
</emphasis> page allows you to explicit set e.g. which hibernatetype and propertyname that
should be used in the reverse engineered model. For more details on how to configure the
tables while reverse engineering read the <link linkend="tab_and_col">Specific table
configuration</link> section.</para>
-
<figure float="0">
<title>Table and Columns Page</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_16.png" format="PNG" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_16.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
- <para>Now that you have configured all necessary parts, you can learn how to work with
- <property moreinfo="none">Hibernate Console Perspective</property>.</para>
+ <para><diffmk:wrapper diffmk:change="changed">Now that you have configured all necessary parts, you can learn how to work with </diffmk:wrapper><property moreinfo="none">Hibernate Console Perspective</property>.</para>
</section>
-
<section id="hib_console">
<title>Hibernate Console Perspective</title>
-
<para>The <property moreinfo="none">Hibernate Console Perspective</property> combines a set of views which allow
you to see the structure of your mapped entities/classes, edit HQL queries, execute the
queries, and see the results. To use this perspective you need to create a <link linkend="console_conf">Console configuration</link>.</para>
-
<section>
<title>Viewing the entity structure</title>
-
<para>To view your new configuration and entity/class structure, switch to <property moreinfo="none">Hibernate
Configurations View</property>. Expanding the tree allows you to browse the class/entity
structure and see the relationships.</para>
-
<figure float="0">
<title>Hibernate Console Perspective</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_17.png" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_17.png"></imagedata>
</imageobject>
</mediaobject>
-
</figure>
-
<para>The <property moreinfo="none">Console Configuration</property> does not dynamically adjust to changes
done in mappings and java code. To reload the configuration select the configuration and
click the <emphasis>
<property moreinfo="none">Reload</property>
</emphasis> button in the view toolbar or in the context menu.</para>
-
<para>Besides, it's possible to open source and mapping files for objects showed in
<property moreinfo="none">Hibernate Configurations View</property>. Just bring up the context menu for a
necessary object and select <emphasis>
@@ -2257,43 +1986,37 @@
<property moreinfo="none">Open Mapping File</property>
</emphasis> to open a proper <emphasis>
<property moreinfo="none">.hbm.xml</property>.</emphasis></para>
-
<figure float="0">
<title>Opening Source for Objects</title>
-
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/plugins_17_a.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<section id="map_diagram">
<title>Mapping Diagram</title>
-
<para>In order to get a visual feel on how entities are related as well as view their
structures, a <property moreinfo="none">Mapping Diagram</property> is provided. It is available by right
clicking on the entity you want a mapping diagram for and then choosing <emphasis>
<property moreinfo="none">Mapping Diagram</property>.</emphasis></para>
-
<figure float="0">
<title>Mapping Diagram</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_18.png" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_18.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>To make <property moreinfo="none">Mapping Diagram</property> usage easier you can use <property moreinfo="none">Rules</property>,
- <property moreinfo="none">Grid</property>,<property moreinfo="none">Snap to Geometry</property> checkboxes in the <emphasis>
- <property moreinfo="none">View</property></emphasis> menu. </para>
+ <para><diffmk:wrapper diffmk:change="changed">To make </diffmk:wrapper><property moreinfo="none">Mapping Diagram</property> usage easier you can use <property moreinfo="none">Rules</property><diffmk:wrapper diffmk:change="changed">, </diffmk:wrapper><property moreinfo="none">Grid</property>,<property moreinfo="none">Snap to Geometry</property><diffmk:wrapper diffmk:change="changed">
+ checkboxes in the </diffmk:wrapper><emphasis>
+ <property moreinfo="none">View</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> menu. </diffmk:wrapper></para>
<figure float="0">
<title>View menu</title>
-
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/map_diagram1.png"></imagedata>
@@ -2301,14 +2024,15 @@
</mediaobject>
</figure>
<para>If you will select <emphasis>
- <property moreinfo="none">Rules</property></emphasis> checkbox, the view print page scale will be added to the page.
- The numbers on the scale show its size in inches.If you click on the scale a <emphasis>
- <property moreinfo="none">Ruler Guide</property></emphasis> will appear on the diagram.
- You can connect any diagram item to it.To connect the items you should move their tops
- to the Ruler Guide. And while moving the ruler guide, the items will be moved together with it as a whole.</para>
+ <property moreinfo="none">Rules</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> checkbox, the view print page scale will be added to the page. The numbers on
+ the scale show its size in inches.If you click on the scale a </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Ruler Guide</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> will appear on the diagram. You can connect any diagram item to it.To connect
+ the items you should move their tops to the Ruler Guide. And while moving the ruler guide,
+ the items will be moved together with it as a whole.</diffmk:wrapper></para>
<figure float="0">
<title>Moving the Ruler guide</title>
-
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/map_diagram2.png"></imagedata>
@@ -2316,10 +2040,10 @@
</mediaobject>
</figure>
<para>If you'll select <emphasis>
- <property moreinfo="none">Grid</property></emphasis> checkbox, the grid will appear on the diagram.</para>
+ <property moreinfo="none">Grid</property>
+ </emphasis> checkbox, the grid will appear on the diagram.</para>
<figure float="0">
<title>Grid on Mapping diagram</title>
-
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/map_diagram3.png"></imagedata>
@@ -2327,687 +2051,842 @@
</mediaobject>
</figure>
<para>The checkbox <emphasis>
- <property moreinfo="none">Snap to Geometry</property></emphasis> helps to put the items of the diagram into allineation with the grid.</para>
- <para>For better navigating through the diagram use <property moreinfo="none">Outline view</property> which is
- available in the structural and graphical modes.</para>
+ <property moreinfo="none">Snap to Geometry</property>
+ </emphasis> helps to put the items of the diagram into allineation with the grid.</para>
+ <para>For better navigating through the diagram use <property moreinfo="none">Outline view</property><diffmk:wrapper diffmk:change="changed"> which
+ is available in the structural and graphical modes.</diffmk:wrapper></para>
<figure float="0">
<title>Navigating in the Structural Mode</title>
-
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/plugins_18_a.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>To switch over between the modes use the buttons in the top-right corner of the
<property moreinfo="none">Outline view</property>.</para>
-
<figure float="0">
<title>Navigating in the Graphical Mode</title>
-
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/plugins_18_b.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
- <para><diffmk:wrapper diffmk:change="added">The options in the context menu of the mapping diagram are listed in the next table.</diffmk:wrapper></para>
-
- <table diffmk:change="added">
- <title><diffmk:wrapper diffmk:change="changed">Context Menu Options of the Mapping Diagram</diffmk:wrapper></title>
-
- <tgroup cols="3" diffmk:change="added">
- <colspec align="left" colnum="1" colwidth="1*" diffmk:change="added"></colspec>
- <colspec align="left" colnum="2" colwidth="1*" diffmk:change="added"></colspec>
- <colspec align="left" colnum="3" colwidth="3*" diffmk:change="added"></colspec>
-
- <thead diffmk:change="added">
- <row diffmk:change="added">
- <entry align="center" diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="changed">Icon</diffmk:wrapper></para>
- </entry>
-
- <entry align="center" diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="added">Command</diffmk:wrapper></para>
- </entry>
-
- <entry align="center" diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="added">Description</diffmk:wrapper></para>
- </entry>
- </row>
- </thead>
-
- <tbody diffmk:change="added">
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><inlinemediaobject><imageobject>
- <imagedata fileref="images/plugins/toggleConnections.png"></imagedata>
- </imageobject></inlinemediaobject>
- </para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Show|Hide connections</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Allows to select what types of connections should be shown on the diagram:
- </diffmk:wrapper><itemizedlist diffmk:change="added">
- <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Property Mappings</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Class Mappings</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Associations</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Foreign key constraints</diffmk:wrapper></para></listitem>
- </itemizedlist><diffmk:wrapper diffmk:change="added">
- and choose the type of the connection router:
- </diffmk:wrapper><itemizedlist diffmk:change="added">
- <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Manhattan Connection Router</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Fan Connection Router</diffmk:wrapper></para></listitem>
- </itemizedlist>
- </para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><inlinemediaobject diffmk:change="added"><imageobject>
- <imagedata fileref="images/plugins/autoLayout.png"/>
- </imageobject></inlinemediaobject>
- </para>
- </entry>
- <entry diffmk:change="added">
- <para>Auto layout</para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Used to dispose all the items of the diagram in a standard manner</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Collapse All</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Collapses all the diagram elements</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Expand All</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Expands all the diagram elements</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Select All</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Makes all the diagram elements selected</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><inlinemediaobject><imageobject>
- <imagedata fileref="images/plugins/exportAsImage.png"/>
- </imageobject></inlinemediaobject>
- </para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Export as Image</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="changed">Allows to export a diagram as </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">.png
- </diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">,</diffmk:wrapper></emphasis>
- <emphasis>
- <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">.jpeg</diffmk:wrapper></property>
- </emphasis><diffmk:wrapper diffmk:change="changed"> or </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">.bmp </diffmk:wrapper></property></emphasis></para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <para>When you open the context menu while clicking an item on the diagram, it quite differs from the one described before.</para>
+ <para><diffmk:wrapper diffmk:change="changed">The options in the context menu of the mapping diagram are listed in the next
+ table.</diffmk:wrapper></para>
+ <table>
+ <title>Context Menu Options of the Mapping Diagram</title>
+ <tgroup cols="3">
+ <colspec align="left" colnum="1" colwidth="1*"></colspec>
+ <colspec align="left" colnum="2" colwidth="1*"></colspec>
+ <colspec align="left" colnum="3" colwidth="3*"></colspec>
+ <thead>
+ <row>
+ <entry align="center">
+ <para>Icon</para>
+ </entry>
+ <entry align="center">
+ <para>Command</para>
+ </entry>
+ <entry align="center">
+ <para>Description</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/toggleConnections.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>Show|Hide connections</para>
+ </entry>
+ <entry><diffmk:wrapper diffmk:change="added">Allows to select what types of connections should be shown on the diagram: </diffmk:wrapper><itemizedlist>
+ <listitem>
+ <para>Property Mappings</para>
+ </listitem>
+ <listitem>
+ <para>Class Mappings</para>
+ </listitem>
+ <listitem>
+ <para>Associations</para>
+ </listitem>
+ <listitem>
+ <para>Foreign key constraints</para>
+ </listitem>
+ </itemizedlist></entry>
+ </row>
+ <row>
+ <entry>
+ <para></para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">Select All</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">Makes all the diagram elements selected</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/plugins/autoLayout.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">Auto layout</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">Used to dispose all the items of the diagram in a standard manner</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/exportAsImage.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>Export as Image</para>
+ </entry>
+ <entry>
+ <para>Allows to export a diagram as <emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">.png
+ </diffmk:wrapper></property>,</emphasis>
+ <emphasis>
+ <property moreinfo="none">.jpeg</property>
+ </emphasis> or <emphasis>
+ <property moreinfo="none">.bmp </property>
+ </emphasis></para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para><diffmk:wrapper diffmk:change="changed">When you open the context menu while clicking an item on the diagram, it quite differs
+ from the one described before.</diffmk:wrapper></para>
<figure float="0">
- <title><diffmk:wrapper diffmk:change="changed">Context Menu in Mapping Item</diffmk:wrapper></title>
-
+ <title>Context Menu in Mapping Item</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/plugins_18_g.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
- <para><diffmk:wrapper diffmk:change="added">The next table describes all the extra options in the menu of mapping items:</diffmk:wrapper></para>
-
- <table diffmk:change="added">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Extra Options in the Context Menu of Mapping Item</diffmk:wrapper></title>
-
- <tgroup cols="3" diffmk:change="added">
- <colspec align="left" colnum="1" colwidth="1*" diffmk:change="added"></colspec>
- <colspec align="left" colnum="2" colwidth="1*" diffmk:change="added"></colspec>
- <colspec align="left" colnum="3" colwidth="3*" diffmk:change="added"></colspec>
-
- <thead diffmk:change="added">
- <row diffmk:change="added">
- <entry align="center" diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="added">Icon</diffmk:wrapper></para>
- </entry>
-
- <entry align="center" diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Command</diffmk:wrapper></para>
- </entry>
-
- <entry align="center" diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Description</diffmk:wrapper></para>
- </entry>
- </row>
- </thead>
-
- <tbody diffmk:change="added">
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><inlinemediaobject><imageobject>
- <imagedata fileref="images/plugins/visibleState.png"></imagedata>
- </imageobject></inlinemediaobject>
- </para>
- </entry>
- <entry diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="added">Toggle Visible State</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Used to hide/show an item on the mapping diagram</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><inlinemediaobject><imageobject>
- <imagedata fileref="images/plugins/expandState.png"></imagedata>
- </imageobject></inlinemediaobject>
- </para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Expand|Collapse</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Used for expanding/collapsing fields of the item</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><inlinemediaobject diffmk:change="added"><imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/plugins/openSourceFile_but.png"></imagedata>
- </imageobject></inlinemediaobject>
- </para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Open Source File</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Makes it possible to open a source file for a chosen
- object/element. The selected element will be highlighted in the open file.</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><inlinemediaobject diffmk:change="added"><imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/plugins/openMappingFile_but.png"></imagedata>
- </imageobject></inlinemediaobject>
- </para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Open Mapping File</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Makes it possible to open a mapping file for a chosen
- object/element. The selected element will be highlighted in the open file.</diffmk:wrapper></para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <tip diffmk:change="added">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tip:</diffmk:wrapper></title>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">All the described types of the context menu are also available in the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Outline</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> view.</diffmk:wrapper></para>
- </tip>
-
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The below table lists the actions that could be performed using the keyboard keys (or keys combinations).</diffmk:wrapper></para>
-
- <table diffmk:change="added">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Hibernate Mapping Diagram Shortcut Keys</diffmk:wrapper></title>
-
- <tgroup cols="2" diffmk:change="added">
- <colspec align="left" colnum="1" colwidth="3*" diffmk:change="added"></colspec>
- <colspec align="left" colnum="2" colwidth="1*" diffmk:change="added"></colspec>
-
- <thead diffmk:change="added">
- <row diffmk:change="added">
- <entry align="center" diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Command</diffmk:wrapper></para>
- </entry>
-
- <entry align="center" diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Binding</diffmk:wrapper></para>
- </entry>
- </row>
- </thead>
-
- <tbody diffmk:change="added">
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Scroll the diagram content</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Ctrl + Shift + arrows</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Collapse/Expand selected item(s)</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> Enter </diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Show/Hide selected item(s)</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="changed"> + </diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Sort items in alphabetical order or return the initial state</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Space</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Navigate between the items</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Arrows</diffmk:wrapper></para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">It's possible to save the diagram in the eclipse workspace. Click the usual </diffmk:wrapper><emphasis diffmk:change="added">
- <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">File > Save As</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> option, the wizard will ask you to set the location within you project
- where to save the file and give the name for the diagram. The item's names concatenated with the ampersand
- symbols are set as the default name for a diagram. The file is saved with the </diffmk:wrapper><literal diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">.hibernate</diffmk:wrapper></literal><diffmk:wrapper diffmk:change="added"> extension.</diffmk:wrapper></para>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">The Diagram saved in the Workspace</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/plugins/saveDiagram.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <tip diffmk:change="added">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note:</diffmk:wrapper></title>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you restart the Eclipse with the mapping diagram opened, the mapping diagram will be restored with the
- message like on the figure below. To view the diagram content, you should perform the refreshing.</diffmk:wrapper></para>
- </tip>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">The Diagram after Restarting the Eclipse</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/plugins/diagram1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">The Diagram after Refreshing</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added" fileref="images/plugins/diagram2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>The next table describes all the extra options in the menu of mapping items:</para>
+ <table>
+ <title>Extra Options in the Context Menu of Mapping Item</title>
+ <tgroup cols="3">
+ <colspec align="left" colnum="1" colwidth="1*"></colspec>
+ <colspec align="left" colnum="2" colwidth="1*"></colspec>
+ <colspec align="left" colnum="3" colwidth="3*"></colspec>
+ <thead>
+ <row>
+ <entry align="center">
+ <para>Icon</para>
+ </entry>
+ <entry align="center">
+ <para>Command</para>
+ </entry>
+ <entry align="center">
+ <para>Description</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/openSourceFile_but.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">Open Source File</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">Makes it possible to open a source file for a chosen object/element. The
+ selected element will be highlighted in the open file.</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/openMappingFile_but.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">Open Mapping File</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">Makes it possible to open a mapping file for a chosen object/element. The
+ selected element will be highlighted in the open file.</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/visibleState.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">Show|Hide shape(s)</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">Used to hide/show an item on the mapping diagram</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/expandState.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">Expand|Collapse shape(s)</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">Used for expanding/collapsing fields of the item</diffmk:wrapper></para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <tip>
+ <title>Tip:</title>
+ <para>All the described types of the context menu are also available in the <property moreinfo="none">Outline</property> view.</para>
+ </tip>
+ <para><diffmk:wrapper diffmk:change="changed">The below table lists the actions that could be performed using the keyboard keys (or
+ keys combinations).</diffmk:wrapper></para>
+ <table>
+ <title>Hibernate Mapping Diagram Shortcut Keys</title>
+ <tgroup cols="2">
+ <colspec align="left" colnum="1" colwidth="3*"></colspec>
+ <colspec align="left" colnum="2" colwidth="1*"></colspec>
+ <thead>
+ <row>
+ <entry align="center">
+ <para>Command</para>
+ </entry>
+ <entry align="center">
+ <para>Binding</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>Scroll the diagram content</para>
+ </entry>
+ <entry>
+ <para>Ctrl + Shift + arrows</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Collapse/Expand selected item(s)</para>
+ </entry>
+ <entry>
+ <para> Enter </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Show/Hide selected item(s)</para>
+ </entry>
+ <entry>
+ <para> + </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Sort items in alphabetical order or return the initial state</para>
+ </entry>
+ <entry>
+ <para>Space</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Navigate between the items</para>
+ </entry>
+ <entry>
+ <para>Arrows</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para><diffmk:wrapper diffmk:change="changed">It's possible to save the diagram in the eclipse workspace. Click the usual
+ </diffmk:wrapper><emphasis>
+ <property moreinfo="none">File > Save As</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> option, the wizard will ask you to set the location within you project where
+ to save the file and give the name for the diagram. The item's names concatenated
+ with the ampersand symbols are set as the default name for a diagram. The file is saved
+ with the </diffmk:wrapper><literal moreinfo="none">.hibernate</literal> extension.</para>
+ <figure float="0">
+ <title>The Diagram saved in the Workspace</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/saveDiagram.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <tip>
+ <title>Note:</title>
+ <para><diffmk:wrapper diffmk:change="changed">If you restart the Eclipse with the mapping diagram opened, the mapping diagram will
+ be restored with the message like on the figure below. To view the diagram content, you
+ should perform the refreshing.</diffmk:wrapper></para>
+ </tip>
+ <figure float="0">
+ <title>The Diagram after Restarting the Eclipse</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/diagram1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure float="0">
+ <title>The Diagram after Refreshing</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/diagram2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">There are some useful commands in the toolbar.</diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">The Diagram View Toolbar</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/plugins/diagramToolbar.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">They are described in the table below.</diffmk:wrapper></para>
+ <table diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Command in Diagram View Toolbar </diffmk:wrapper></title>
+ <tgroup cols="3" diffmk:change="added">
+ <colspec align="left" colnum="1" colwidth="1*" diffmk:change="added"></colspec>
+ <colspec align="left" colnum="2" colwidth="1*" diffmk:change="added"></colspec>
+ <colspec align="left" colnum="3" colwidth="3*" diffmk:change="added"></colspec>
+ <thead diffmk:change="added">
+ <row diffmk:change="added">
+ <entry align="center" diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Icon</diffmk:wrapper></para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Command</diffmk:wrapper></para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Description</diffmk:wrapper></para>
+ </entry>
+ </row>
+ </thead>
+ <tbody diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para diffmk:change="added">
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/plugins/toolbarRefresh.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Refresh Visual Mapping</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">It update </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Mapping Diagram</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> if </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Console
+ Configuration</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> was changed. </diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para diffmk:change="added">
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/plugins/toolbarZoom.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Zoom Box</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Used to define scale of the diagram. Also it's used for </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Mapping
+ Diagram</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> printing. If you want to put the whole </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">diagram</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> to one print page, you need select </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Page</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> option in the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Zoom Box</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para diffmk:change="added">
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/plugins/toolbarAutolayout.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Auto layout</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Used to arrange all diagram items in a standard manner.</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para diffmk:change="added">
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/plugins/toolbarShowHideConnections.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Show|Hide connections</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Used to show or hide connection on the diagram. Moreover you can choose what
+ type of connections must be present on the diagram (</diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Property
+ Mappings</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Class Mappings</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Associations</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> or </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Foreign key constraints</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">)
+ .</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para diffmk:change="added">
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/plugins/toolbarExpandCollapse.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Expand|Collapse</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Used for expanding/collapsing fields of the item.</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para diffmk:change="added">
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/plugins/toolbarShowHideShapes.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> Show|Hide shape(s)</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Used to hide/show an item on the mapping diagram.</diffmk:wrapper></para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
</section>
</section>
-
<section>
<title>Prototyping Queries</title>
-
<para>Queries can be prototyped by entering them into the <property moreinfo="none">HQL</property> or
- <property moreinfo="none">Criteria Editor</property>. To execute a query you should click the green run button in the editor toolbar or press <emphasis>
+ <property moreinfo="none">Criteria Editor</property><diffmk:wrapper diffmk:change="changed">. To execute a query you should click the green run
+ button in the editor toolbar or press </diffmk:wrapper><emphasis>
<property moreinfo="none">Ctrl+Enter</property>
</emphasis>.</para>
-
- <section id="hql_and_criteria_editors">
- <title>HQL Editor and Hibernate Criteria Editor</title>
- <para>To open the query editors right-click your project
- <property moreinfo="none">Console Configuration</property> and select <property moreinfo="none">HQL
- Editor</property> (or <property moreinfo="none">Hibernate Criteria Editor</property>).</para>
-
- <figure float="0">
- <title>Opening HQL Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/plugins/prototypingQueries.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <tip><title>Tip:</title>
- <para>If the context menu items are disabled then you need at first to create a <property moreinfo="none">Session
- Factory</property>. That is done by simply expanding the <property moreinfo="none">Session
- Factory</property> node.</para>
- </tip>
- <para>When open the editors they should automatically detect the chosen Console Configuration.</para>
-
- <para>To get a prefill query for any entity (or any entity child node) listed in the
- <emphasis>
- <property moreinfo="none">Session Factory</property></emphasis> you should double-click it. This will open the
- <property moreinfo="none">HQL Editor</property> with the associated query.</para>
-
- <para>Choosing <emphasis>
- <property moreinfo="none">HQL Editor</property>
- </emphasis> in the context menu for any entity (or any entity child node) will also open the HQL editor
- with the associated query. If you choose <emphasis>
- <property moreinfo="none">Hibernate Criteria Editor</property>
- </emphasis> in the context menu, it will open <property moreinfo="none">Hibernate Criteria Editor</property> with the associated criteria.</para>
-
- <figure float="0">
- <title>Generating Simple Queries</title>
- <mediaobject>
- <imageobject role="fo">
- <imagedata align="center" fileref="images/plugins/plugins_19.png" format="PNG" scale="80"></imagedata>
- </imageobject>
-
- <imageobject role="html">
- <imagedata align="center" fileref="images/plugins/plugins_19.png" format="PNG"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>It's also possible to copy a portion of code from <emphasis>
- <property moreinfo="none">.java</property></emphasis> file into the <property moreinfo="none">HQL</property> or
- <property moreinfo="none">Criteria editor</property>. To do this make use of the
- Quick Fix option (<emphasis>
- <property moreinfo="none">Ctrl + 1</property>)</emphasis>.</para>
-
- <figure float="0">
- <title>Quick Fix Option Demonstration</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/plugins/plugins_19_b.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You can also update the original java code according to changes in the HQL or Criteria
- editor. For that you should save your HQL/Criteria query and submit the replacing in
- appeared confirmation dialog.</para>
-
- <figure float="0">
- <title>Updating Java Code</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/plugins/plugins_19_c.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section>
- <title>Error Handling</title>
- <para>Errors during creation of the <property moreinfo="none">Session Factory</property> or running the
- queries (e.g. if your configuration or query is incorrect) will be shown in a message dialog
- or inclined in the view that detected the error, you may get more information about the
- error in the <property moreinfo="none">Error Log View</property> on the right pane.</para>
-
- <para>Results of a query will be shown in the <property moreinfo="none">Hibernate Query Result View</property>
- and details of possible errors (syntax errors, database errors, etc.) can be seen in the
- <property moreinfo="none">Error Log View</property>.</para>
-
-
- <note>
- <title>Note:</title>
- <para>HQL queries are executed by default using <literal moreinfo="none">list()</literal> thus without any
- limit of the size of the output the query could return a large result set. You might run
- out of memory. To avoid this you can put a value in the Max results field to reduce the
- number of elements returned.</para>
- </note>
- </section>
+ <section id="hql_and_criteria_editors">
+ <title>HQL Editor and Hibernate Criteria Editor</title>
+ <para><diffmk:wrapper diffmk:change="changed">To open the query editors right-click your project </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Console
+ Configuration</diffmk:wrapper></property> and select <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">HQL Editor</diffmk:wrapper></property> (or <property moreinfo="none">Hibernate Criteria Editor</property>).</para>
+ <figure float="0">
+ <title>Opening HQL Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/prototypingQueries.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <tip>
+ <title>Tip:</title>
+ <para>If the context menu items are disabled then you need at first to create a <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Session Factory</diffmk:wrapper></property>. That is done by simply expanding the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Session
+ Factory</diffmk:wrapper></property> node.</para>
+ </tip>
+ <para><diffmk:wrapper diffmk:change="changed">When open the editors they should automatically detect the chosen Console
+ Configuration.</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">To get a prefill query for any entity (or any entity child node) listed in the
+ </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Session Factory</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> you should double-click it. This will open the </diffmk:wrapper><property moreinfo="none">HQL Editor</property><diffmk:wrapper diffmk:change="changed">
+ with the associated query.</diffmk:wrapper></para>
+ <para>Choosing <emphasis>
+ <property moreinfo="none">HQL Editor</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> in the context menu for any entity (or any entity child node) will also open
+ the HQL editor with the associated query. If you choose </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Hibernate Criteria Editor</property>
+ </emphasis> in the context menu, it will open <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Hibernate Criteria
+ Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> with the associated criteria.</diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title>Generating Simple Queries</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added" role="fo">
+ <imagedata align="center" fileref="images/plugins/plugins_19.png" format="PNG" scale="80"></imagedata>
+ </imageobject>
+ <imageobject diffmk:change="added" role="html">
+ <imagedata align="center" fileref="images/plugins/plugins_19.png" format="PNG"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>It's also possible to copy a portion of code from <emphasis>
+ <property moreinfo="none">.java</property>
+ </emphasis> file into the <property moreinfo="none">HQL</property><diffmk:wrapper diffmk:change="changed"> or </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Criteria
+ editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">. To do this make use of the Quick Fix option (</diffmk:wrapper><emphasis>
+ <property moreinfo="none">Ctrl + 1</property>)</emphasis>.</para>
+ <figure diffmk:change="added" float="0">
+ <title>Quick Fix Option Demonstration</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata fileref="images/plugins/plugins_19_b.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="changed">You can also update the original java code according to changes in the HQL or Criteria
+ editor. For that you should save your HQL/Criteria query and submit the replacing in
+ appeared confirmation dialog.</diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title>Updating Java Code</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata fileref="images/plugins/plugins_19_c.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Also you can pin </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">HQL editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Criteria
+ editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> for one tab in </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Hibernate Query Result</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> view. For
+ that you need click on </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Stick result to one tab</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">
+ button(</diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/plugins/sticky_but.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ). In the issue query executions results will be shown in one tab (no
+ more will be opened). </diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> Moreover you are able to rename tab in </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Hibernate Query Result</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.
+ Click the tab, and type a new name in </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Property View->Tab name field</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tab Renaming</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/plugins/plugins_19_d.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
<section>
+ <title>Error Handling</title>
+ <para>Errors during creation of the <property moreinfo="none">Session Factory</property><diffmk:wrapper diffmk:change="changed"> or running the
+ queries (e.g. if your configuration or query is incorrect) will be shown in a message
+ dialog or inclined in the view that detected the error, you may get more information about
+ the error in the </diffmk:wrapper><property moreinfo="none">Error Log View</property> on the right pane.</para>
+ <para>Results of a query will be shown in the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Hibernate Query Result
+ View</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> and details of possible errors (syntax errors, database errors, etc.)
+ can be seen in the </diffmk:wrapper><property moreinfo="none">Error Log View</property>.</para>
+ <note diffmk:change="added">
+ <title>Note:</title>
+ <para>HQL queries are executed by default using <literal moreinfo="none">list()</literal><diffmk:wrapper diffmk:change="changed"> thus without any
+ limit of the size of the output the query could return a large result set. You might run
+ out of memory. To avoid this you can put a value in the Max results field to reduce the
+ number of elements returned.</diffmk:wrapper></para>
+ </note>
+ </section>
+ <section>
<title>Dynamic Query Translator</title>
-
<para>If the <property moreinfo="none">Hibernate Dynamic Query Translator View</property> is visible while
writing in the <property moreinfo="none">HQL Editor</property> it will show the generated SQL for a HQL
query.</para>
-
<figure float="0">
<title>Hibernate Dynamic Query Translator View</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_20.png" format="PNG" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_20.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>The translation is done each time you stop typing into the editor, if there are errors
in the HQL the parse exception will be shown embedded in the view.</para>
</section>
</section>
-
<section>
<title>Properties View</title>
-
- <para>As you can see on the figure,when clicking on class/entity <property moreinfo="none">Properties view</property> shows the number of
- query results as well as the time of executing.</para>
-
+ <para>As you can see on the figure,when clicking on class/entity <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Properties
+ view</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> shows the number of query results as well as the time of executing.</diffmk:wrapper></para>
<figure float="0">
<title>Properties View</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_21_a.png" format="PNG" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_21_a.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
- <para>It also displays the structure of any persistent object selected in the
- <property moreinfo="none">Hibernate Query Results View</property>. Editing is not yet supported.</para>
-
+ <para><diffmk:wrapper diffmk:change="changed">It also displays the structure of any persistent object selected in the </diffmk:wrapper><property moreinfo="none">Hibernate Query Results View</property>. Editing is not yet supported.</para>
<figure float="0">
<title>Properties View for Selected Object</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center" fileref="images/plugins/plugins_21_b.png" format="PNG" scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center" fileref="images/plugins/plugins_21_b.png" format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>You can also use <property moreinfo="none">Properties view</property> when clicking on the configuration
- itself in Hibernate Configuration View( <link linkend="modif_console_conf">Modifying a Hibernate Console Configuration section</link>). </para>
+ <para>You can also use <property moreinfo="none">Properties view</property><diffmk:wrapper diffmk:change="changed"> when clicking on the configuration
+ itself in Hibernate Configuration View( </diffmk:wrapper><link linkend="modif_console_conf"><diffmk:wrapper diffmk:change="changed">Modifying a
+ Hibernate Console Configuration section</diffmk:wrapper></link>). </para>
</section>
</section>
<section id="jpa_annotations">
- <title>Hibernate:add JPA annotations view
- </title>
- <para>Using this wizard you can add the next Hibernate annotations to the class:
- <emphasis>
- <property moreinfo="none">@Column</property></emphasis>,<emphasis>
- <property moreinfo="none">@Entity</property></emphasis>,<emphasis>
- <property moreinfo="none">@ManyToOne</property></emphasis>,<emphasis>
- <property moreinfo="none">@OneToMany</property></emphasis>,<emphasis>
- <property moreinfo="none">@OneToOne</property></emphasis>,<emphasis>
- <property moreinfo="none">@ManyToMany</property></emphasis>,<emphasis>
- <property moreinfo="none">@MappedSuperclass</property></emphasis>,<emphasis>
- <property moreinfo="none">@Id</property></emphasis>,<emphasis>
- <property moreinfo="none">@GeneratedValue</property></emphasis> ,<emphasis>
- <property moreinfo="none">@Version </property></emphasis>
+ <title><diffmk:wrapper diffmk:change="changed">Hibernate:add JPA annotations refactoring </diffmk:wrapper></title>
+ <para><diffmk:wrapper diffmk:change="changed">Using this wizard you can add the next Hibernate annotations to the class: </diffmk:wrapper><emphasis>
+ <property moreinfo="none">@Column</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@Entity</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@ManyToOne</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@OneToMany</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@OneToOne</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@ManyToMany</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@MappedSuperclass</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@Id</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@GeneratedValue</property>
+ </emphasis> ,<emphasis>
+ <property moreinfo="none">@Version </property>
+ </emphasis>
</para>
- <itemizedlist>
+ <itemizedlist>
<listitem>
<para><emphasis>
- <property moreinfo="none">@Column</property></emphasis> is added to all String properties.</para>
+ <property moreinfo="none">@Column</property>
+ </emphasis> is added to all String properties.</para>
</listitem>
- <listitem>
- <para><emphasis>
- <property moreinfo="none">@Entity</property></emphasis> is always declared before any class where it doesn't present.</para>
- </listitem>
- <listitem>
- <para><emphasis>
- <property moreinfo="none">@ManyToOne</property></emphasis>,<emphasis>
- <property moreinfo="none">@OneToMany</property></emphasis>,<emphasis>
- <property moreinfo="none">@OneToOne</property></emphasis>,<emphasis>
- <property moreinfo="none">@ManyToMany</property></emphasis> - this annotations are declared according to the classes hierarchy.</para>
- </listitem>
- <listitem>
- <para><emphasis>
- <property moreinfo="none">@MappedSuperclass</property></emphasis> is added to abstract superclasses.</para>
- </listitem>
- <listitem>
- <para><emphasis>
- <property moreinfo="none">@Id</property></emphasis>,<emphasis>
- <property moreinfo="none">@GeneratedValue</property></emphasis> are added automatically only to the properties under the name "Id",where they don't present.</para>
- </listitem>
-
- <listitem>
- <para><emphasis>
- <property moreinfo="none">@Version</property></emphasis> is declared in case you select <link linkend="optim_lock">Enable optimistic locking</link>.</para>
- </listitem>
- </itemizedlist>
+ <listitem>
+ <para><emphasis>
+ <property moreinfo="none">@Entity</property>
+ </emphasis> is always declared before any class where it doesn't present.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>
+ <property moreinfo="none">@ManyToOne</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@OneToMany</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@OneToOne</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@ManyToMany</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> - this annotations are declared according to the classes hierarchy.</diffmk:wrapper></para>
+ </listitem>
+ <listitem>
+ <para><emphasis>
+ <property moreinfo="none">@MappedSuperclass</property>
+ </emphasis> is added to abstract superclasses.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>
+ <property moreinfo="none">@Id</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@GeneratedValue</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> are added automatically only to the properties under the name "Id",where they
+ don't present.</diffmk:wrapper></para>
+ </listitem>
+ <listitem>
+ <para><emphasis>
+ <property moreinfo="none">@Version</property>
+ </emphasis> is declared in case you select <link linkend="optim_lock"><diffmk:wrapper diffmk:change="changed">Enable optimistic
+ locking</diffmk:wrapper></link>.</para>
+ </listitem>
+ </itemizedlist>
<note>
<title>Note:</title>
- <para>This section doesn't cover the meaning of the <property moreinfo="none">Hibernate annotations</property>
- , for more information read <ulink url="http://docs.jboss.org/hibernate/stable/annotations/reference/en/html/">Hibernate Annotations Documentation</ulink> .</para>
+ <para><diffmk:wrapper diffmk:change="changed">This section doesn't cover the meaning of the </diffmk:wrapper><property moreinfo="none">Hibernate annotations</property>
+ , for more information read <ulink url="http://docs.jboss.org/hibernate/stable/annotations/reference/en/html/"><diffmk:wrapper diffmk:change="changed">Hibernate
+ Annotations Documentation</diffmk:wrapper></ulink> .</para>
</note>
-
- <para>To open this wizard you should right click the class you want to enrich with annotations <emphasis>
- <property moreinfo="none">>Source>Generate Hibernate/JPA annotations</property></emphasis>. You will see the Hibernate:add JPA annotations dialog.
- </para>
+ <para><diffmk:wrapper diffmk:change="changed">To open this wizard you should right click the class you want to enrich with annotations
+ </diffmk:wrapper><emphasis>
+ <property moreinfo="none">>Source>Generate Hibernate/JPA annotations</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed">. You will see the Hibernate:add JPA annotations dialog. </diffmk:wrapper></para>
<figure float="0">
- <title>Starting Hibernate:add JPA annotations view</title>
+ <title><diffmk:wrapper diffmk:change="changed">Starting Hibernate:add JPA annotations dialog</diffmk:wrapper></title>
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/annotations1.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para> In the top of it you can see the list of all classes that will be passed through refactoring.
- Besides the class you have selected in this list you can also find its superclasses and the classes that objects present in the current class as properties.
- </para>
- <para>By default the tags are added to the fields of selected classes. But you can change this option to <emphasis><property moreinfo="none">Getters</property></emphasis>in <emphasis><property moreinfo="none"> Preferred location of Annotations</property></emphasis> dropdownlist
- and then all the annotations will be added to the getter methods. If you choose <emphasis><property moreinfo="none">Auto select from class preference</property></emphasis> then the annotations are added according to the majority of the already existed ones positions.
- </para>
- <para> If it's nessecary to map your String properties to the columns that length differ from the default value(255) ,change <emphasis><property moreinfo="none">Default string length field</property></emphasis> and <code>@Column(length = your length)</code> will be created before every String property.
- </para>
- <para id="optim_lock">You can add optimistic locking capability to an entity bean by selecting <emphasis><property moreinfo="none">Enable optimistic locking</property></emphasis> checkbox.
- This operation will add version property to all the selected classes. The property will be also annotated with @Version ,getter and setter will be created. If the property is already exists,it won't be created ,but the getters,setters will be generated.
- If there is already @MappedSuperclass with version in the base class of the current class - <emphasis><property moreinfo="none">"version"</property></emphasis> is not inserted into the current class.
- </para>
- <para>After defining all necessary settings in the current step press <emphasis><property moreinfo="none">Next</property></emphasis> and follow the next wizard steps.
- </para>
+ <para><diffmk:wrapper diffmk:change="added"> In the top of it you can see the list of all classes that will be passed through
+ refactoring. Besides the class you have selected in this list you can also find its
+ superclasses and the classes that objects present in the current class as properties. If you
+ want to add new classes or package to the list of classes, you should click the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Back</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button. In result you will see </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Add classes and
+ packages</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> page.</diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Add classes and packages page </diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/plugins/annotations1_a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Here you can add one more classes or whole package, moreover you can limit dependencies
+ depth by selecting </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">depth control</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> option (more about this option you will
+ find in </diffmk:wrapper><link diffmk:change="added" linkend="depth_control"><diffmk:wrapper diffmk:change="added">Creating a Hibernate Mapping File</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">). When finished
+ just press the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button and you will be returned to </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">The
+ following classes will be changed</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> page and will be able to continue work with
+ it.</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">By default the tags are added to the fields of selected classes. But you can change this
+ option to </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Getters</property>
+ </emphasis>in <emphasis>
+ <property moreinfo="none"> Preferred location of Annotations</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> dropdownlist and then all the annotations will be added to the getter methods. If
+ you choose </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Auto select from class preference</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> then the annotations are added according to the majority of the already existed
+ ones positions. </diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed"> If it's nessecary to map your String properties to the columns that length differ from
+ the default value(255) ,change </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Default string length field</property>
+ </emphasis> and <code>@Column(length = your length)</code><diffmk:wrapper diffmk:change="changed"> will be created before every String
+ property. </diffmk:wrapper></para>
+ <para id="optim_lock"><diffmk:wrapper diffmk:change="changed">You can add optimistic locking capability to an entity bean by selecting
+ </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Enable optimistic locking</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> checkbox. This operation will add version property to all the selected classes.
+ The property will be also annotated with @Version ,getter and setter will be created. If the
+ property is already exists,it won't be created ,but the getters,setters will be generated. If
+ there is already @MappedSuperclass with version in the base class of the current class -
+ </diffmk:wrapper><emphasis>
+ <property moreinfo="none">"version"</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> is not inserted into the current class. </diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">After defining all necessary settings in the current step press </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> and follow the next wizard steps. </diffmk:wrapper></para>
<figure float="0">
<title>Hibernate:add JPA annotations view</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/plugins/annotations2.png"></imagedata>
- </imageobject>
- </mediaobject>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata fileref="images/plugins/annotations2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
</figure>
- <para>The view represents two windows: one with the source code and and the second with refactored one.
- With the help of <inlinemediaobject><imageobject>
- <imagedata fileref="images/plugins/butt1.png"></imagedata>
- </imageobject></inlinemediaobject> ,<inlinemediaobject><imageobject>
- <imagedata fileref="images/plugins/butt2.png"></imagedata>
- </imageobject></inlinemediaobject> ,<inlinemediaobject><imageobject>
- <imagedata fileref="images/plugins/butt3.png"></imagedata>
- </imageobject></inlinemediaobject> ,<inlinemediaobject><imageobject>
- <imagedata fileref="images/plugins/butt4.png"></imagedata>
- </imageobject></inlinemediaobject> buttons you can quickly navigate between the differences in the code. If you don't agree with some changes you can't undo them but you can remove the class from the list of classes that need refactoring.
- </para>
+ <para><diffmk:wrapper diffmk:change="changed">The view represents two windows: one with the source code and and the second with
+ refactored one. With the help of </diffmk:wrapper><inlinemediaobject>
+ <imageobject diffmk:change="added">
+ <imagedata fileref="images/plugins/butt1.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject> ,<inlinemediaobject>
+ <imageobject diffmk:change="added">
+ <imagedata fileref="images/plugins/butt2.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject> ,<inlinemediaobject>
+ <imageobject diffmk:change="added">
+ <imagedata fileref="images/plugins/butt3.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject> ,<inlinemediaobject>
+ <imageobject diffmk:change="added">
+ <imagedata fileref="images/plugins/butt4.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="changed"> buttons you can quickly navigate between the differences in the code. If
+ you don't agree with some changes you can't undo them but you can remove the class from the
+ list of classes that need refactoring. </diffmk:wrapper></para>
<figure float="0">
<title>List of classes that need refactoring</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/plugins/annotations3.png"></imagedata>
- </imageobject>
- </mediaobject>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata fileref="images/plugins/annotations3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
</figure>
<para>To apply the changes click <emphasis>
- <property moreinfo="none">Finish</property></emphasis>.</para>
-
- </section>
+ <property moreinfo="none">Finish</property>
+ </emphasis>.</para>
+ </section>
<section id="debug_log">
<title>Enable debug logging in the plugins</title>
-
<para>It is possible to configure the eclipse plugin to route all logging made by the plugins
and hibernate code it self to the <property moreinfo="none">Error Log View</property> in Eclipse.</para>
-
+ <para diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Error Log View</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is very useful tool to solve any problem which appears in Hibernate Tools Plugins.
+ You can use if there are troubles with setting up </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Hibernate Console Configuration</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
<para>This is done by editing the <emphasis>
- <property moreinfo="none">hibernate-log4j.properties</property>
+ <property moreinfo="none">hibernate-log4j.properties</property>
</emphasis> in <emphasis>
<property moreinfo="none">org.hibernate.eclipse/ directory/jar</property>
</emphasis>. This file includes a default configuration that only logs WARN and above to a set
of custom appenders (PluginFileAppender and PluginLogAppender). You can change these settings
to be as verbose or silent as you please - see <ulink url="http://www.hibernate.org/5.html">Hibernate Documentation</ulink> for interesting categories and Log4j documentation.</para>
-
<section>
<title>Relevant Resources Links</title>
<para>Find more on how to configure logging via a log4j property file in <ulink url="http://supportweb.cs.bham.ac.uk/docs/tutorials/docsystem/build/tutorials/...">Log4j documentation</ulink>.</para>
</section>
</section>
-
<section id="dali_integration">
<title>Hibernate support for Dali plugins in Eclipse WTP</title>
-
<para>Starting from 3.0.0 Alpha1 version of <property moreinfo="none">JBoss Tools</property> Hibernate plugins
support Eclipse Dali integration what now makes it possible to use a Hibernate as a complete
JPA development platform.</para>
-
<para>When starting a new JPA project from <emphasis>
<property moreinfo="none">New > Other > JPA > JPA Project</property>
</emphasis> (or simply <emphasis>
<property moreinfo="none">New > JPA Project</property>
</emphasis> in <property moreinfo="none">JPA Perspective</property>), the first wizard page looks as
follows.</para>
-
<figure float="0">
<title>Starting JPA Project</title>
<mediaobject>
@@ -3016,19 +2895,15 @@
</imageobject>
</mediaobject>
</figure>
-
- <para>It's possible here to select a target runtime and change the project
- configuration, or you can leave everything as it is.</para>
-
+ <para><diffmk:wrapper diffmk:change="changed">It's possible here to select a target runtime and change the project configuration,
+ or you can leave everything as it is.</diffmk:wrapper></para>
<para>On the JPA Facet page you should choose Hibernate as a target platform. Also select the
proper database connection, if it is defined, or add a new one by clicking the <emphasis>
<property moreinfo="none">Add connection</property>
</emphasis> link.</para>
-
<para>Hitting <emphasis>
<property moreinfo="none">Finish</property>
</emphasis> will generate the project.</para>
-
<figure float="0">
<title>Targeting at Hibernate Platform</title>
<mediaobject>
@@ -3037,21 +2912,17 @@
</imageobject>
</mediaobject>
</figure>
-
<note>
<title>Note:</title>
-
- <para>Please note, if you choose Hibernate as a platform while creating a JPA/Dali project, a
- Hibernate Console Configuration for the project is created automatically when the
- wizard finishes its work. It allows a full usage of <property moreinfo="none">Hibernate Tools</property>
- features without additional setup.</para>
+ <para><diffmk:wrapper diffmk:change="changed">Please note, if you choose Hibernate as a platform while creating a JPA/Dali project, a
+ Hibernate Console Configuration for the project is created automatically when the wizard
+ finishes its work. It allows a full usage of </diffmk:wrapper><property moreinfo="none">Hibernate Tools</property><diffmk:wrapper diffmk:change="changed"> features
+ without additional setup.</diffmk:wrapper></para>
</note>
-
<para>By enabling Hibernate platform specific features you can now generate DDL and Entities.
For that find <emphasis>
<property moreinfo="none">JPA Tools > Generate Tables from Entities/Generate Entities from Tables</property>
- </emphasis> options in the context menu of your JPA project.</para>
-
+ </emphasis> options in the context menu of your JPA project.</para>
<figure float="0">
<title>Generate DDL/Entities</title>
<mediaobject>
@@ -3060,17 +2931,13 @@
</imageobject>
</mediaobject>
</figure>
-
<note>
<title>Note:</title>
-
<para>Please, remember to put the proper database driver to the classpath of your
project.</para>
</note>
-
- <para>The <property moreinfo="none">Generate Entities wizard</property> first will ask you to choose the directory where all
- output will be written.</para>
-
+ <para>The <property moreinfo="none">Generate Entities wizard</property><diffmk:wrapper diffmk:change="changed"> first will ask you to choose the
+ directory where all output will be written.</diffmk:wrapper></para>
<figure float="0">
<title>Generate Entities Wizard</title>
<mediaobject>
@@ -3079,18 +2946,15 @@
</imageobject>
</mediaobject>
</figure>
-
<para>To generate entities you can use:</para>
-
<itemizedlist>
<listitem>
<para>a Hibernate Console Configuration (proposed by default)</para>
<para>Just make sure that the <emphasis>
<property moreinfo="none">Use Console Configuration</property>
- </emphasis> checkbox is selected and choose a needed configuration from the <emphasis>
- <property moreinfo="none">Console
- configurations</property></emphasis> list box.</para>
-
+ </emphasis> checkbox is selected and choose a needed configuration from the <emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Console configurations</diffmk:wrapper></property>
+ </emphasis> list box.</para>
<figure float="0">
<title>Generate Entities Wizard</title>
<mediaobject>
@@ -3101,31 +2965,31 @@
</figure>
</listitem>
</itemizedlist>
-
<itemizedlist>
<listitem>
<para>or a DTP connection directly</para>
<para>Just uncheck <emphasis>
- <property moreinfo="none">Use Console Configuration</property>
- </emphasis> and adjust database settings.</para>
+ <property moreinfo="none">Use Console Configuration</property>
+ </emphasis> and adjust database settings.</para>
</listitem>
</itemizedlist>
-
-<para>All the same you do with Generate Entities Wizard you can do with Generate DDL wizard. Special feature for Generate DDL wizard is possible automatic execution of Generation DDL in the database. </para>
- <figure float="0">
- <title>Generate DDL Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/plugins/dali_integration6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
+ <para><diffmk:wrapper diffmk:change="changed">All the same you do with Generate Entities Wizard you can do with Generate DDL wizard.
+ Special feature for Generate DDL wizard is possible automatic execution of Generation DDL in
+ the database. </diffmk:wrapper></para>
+ <figure float="0">
+ <title>Generate DDL Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/dali_integration6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
<para>Thus, you can now have the Hibernate runtime support in Eclipse JPA projects.</para>
</section>
</chapter>
-<chapter id="ant" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/hibernatetools/docs/reference/en/modules/ant.xml">
+<chapter id="ant" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/hibernatetools/docs/reference/en/modules/ant.xml">
<title>Ant Tools</title>
<para>Maybe somebody will find it more preferable to use Ant for generation purposes. Thus, this
@@ -4363,7 +4227,7 @@
</chapter>
-<chapter id="reverseengineering" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/hibernatetools/docs/reference/en/modules/reverseengineering.xml">
+<chapter id="reverseengineering" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/hibernatetools/docs/reference/en/modules/reverseengineering.xml">
<title>Controlling reverse engineering</title>
<para>When using the <code><jdbcconfiguration></code>, the ant task will read the
@@ -5241,7 +5105,7 @@
</chapter>
-<chapter id="codegen" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/hibernatetools/docs/reference/en/modules/codegen.xml">
+<chapter id="codegen" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/hibernatetools/docs/reference/en/modules/codegen.xml">
<title>Controlling POJO code generation</title>
<para>When using <code><hbm2java></code> or the eclipse plugin to generate POJO java code you have the possibility to control
14 years, 7 months
JBoss Tools SVN: r20350 - trunk/birt/docs/en.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2010-02-18 03:55:20 -0500 (Thu, 18 Feb 2010)
New Revision: 20350
Modified:
trunk/birt/docs/en/master.xml
trunk/birt/docs/en/master_output.xml
Log:
<html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif">
<p>https://jira.jboss.org/jira/browse/JBDS-1104 - Updated versions,corrected master_output file</p>
</body></html>
Modified: trunk/birt/docs/en/master.xml
===================================================================
--- trunk/birt/docs/en/master.xml 2010-02-18 08:42:54 UTC (rev 20349)
+++ trunk/birt/docs/en/master.xml 2010-02-18 08:55:20 UTC (rev 20350)
@@ -53,14 +53,14 @@
<copyright>
<year>2008</year>
- <year>2009</year>
+ <year>2009</year>
<year>2010</year>
<holder>JBoss by Red Hat</holder>
</copyright>
<releaseinfo>
- Version: 1.1.0.CR1
+ Version: 1.1.0.CR2
</releaseinfo>
@@ -81,4 +81,4 @@
&links;
-</book>
+</book>
Modified: trunk/birt/docs/en/master_output.xml
===================================================================
--- trunk/birt/docs/en/master_output.xml 2010-02-18 08:42:54 UTC (rev 20349)
+++ trunk/birt/docs/en/master_output.xml 2010-02-18 08:55:20 UTC (rev 20350)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-"http://www.docbook.org/xml/4.3/docbookx.dtd"
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V5.0//EN"
+"http://www.docbook.org/xml/5.0/dtd/docbook.dtd"
[
<!ENTITY introduction SYSTEM "modules/introduction.xml">
@@ -9,162 +9,170 @@
<!ENTITY birt_reports_deployment SYSTEM "modules/birt_reports_deployment.xml">
<!ENTITY framework SYSTEM "modules/framework.xml">
<!ENTITY tasks SYSTEM "modules/tasks.xml">
-<!ENTITY links SYSTEM "modules/links.xml">
-
-<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
-]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+<!ENTITY links SYSTEM "modules/links.xml">
+]><book xmlns="http://docbook.org/ns/docbook" xmlns:diffmk="http://diffmk.sf.net/ns/diff" xmlns:xlink="http://www.w3.org/1999/xlink">
<bookinfo>
- <title><diffmk:wrapper diffmk:change="changed">JBoss BIRT Integration User Guide</diffmk:wrapper></title>
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss BIRT Integration User Guide</title>
<corpauthor>
- <inlinemediaobject>
- <imageobject role="fo">
- <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata>
+ <inlinemediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imageobject role="fo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imagedata fileref="images/jbosstools_logo.png" format="PNG" xmlns="http://docbook.org/ns/docbook"></imagedata>
</imageobject>
- <imageobject role="html">
- <imagedata></imagedata>
+ <imageobject role="html" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imagedata xmlns="http://docbook.org/ns/docbook"></imagedata>
</imageobject>
</inlinemediaobject>
</corpauthor>
- <author diffmk:change="added"><firstname diffmk:change="added"><diffmk:wrapper diffmk:change="added">Michael</diffmk:wrapper></firstname><surname diffmk:change="added"><diffmk:wrapper diffmk:change="added">Sorokin</diffmk:wrapper></surname><email diffmk:change="added"><diffmk:wrapper diffmk:change="added">msorokin(a)exadel.com</diffmk:wrapper></email></author>
- <author><firstname>Anastasiya</firstname><surname>Bogachuk</surname><email>abogachuk(a)exadel.com</email></author>
- <author><firstname>Olga</firstname><surname>Chikvina</surname></author>
+ <author xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><firstname xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Michael</firstname><surname xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Sorokin</surname><email xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">msorokin(a)exadel.com</email></author>
+ <author xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><firstname xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Anastasiya</firstname><surname xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Bogachuk</surname><email xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">abogachuk(a)exadel.com</email></author>
+ <author xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><firstname xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Olga</firstname><surname xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Chikvina</surname></author>
- <othercredit diffmk:change="added">
+ <othercredit xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
- <contrib diffmk:change="added"><diffmk:wrapper diffmk:change="added">
+ <contrib xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
Special thanks to Snjezana Peco
- </diffmk:wrapper></contrib>
+ </contrib>
</othercredit>
+
+
+
+
+
+
+
+
+
- <copyright>
- <year>2008</year>
- <year>2009</year>
- <holder>JBoss by Red Hat</holder>
+ <copyright xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <year xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">2008</year>
+ <year xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">2009</year>
+ <year diffmk:change="added" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><diffmk:wrapper diffmk:change="added">2010</diffmk:wrapper></year>
+ <holder xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss by Red Hat</holder>
</copyright>
- <releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 1.1.0.CR1
+ <releaseinfo xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><diffmk:wrapper diffmk:change="changed">
+ Version: 1.1.0.CR2
</diffmk:wrapper></releaseinfo>
-<abstract>
- <title></title>
- <para>
+<abstract xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"></title>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jboss_birt_plugin_re...">PDF version</ulink>
</para>
</abstract>
</bookinfo>
- <toc></toc>
+ <toc xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"></toc>
-<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/introduction.xml">
+<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/birt/docs/en/modules/introduction.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<?dbhtml filename="introduction.html"?>
<chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>Eclipse</keyword>
- <keyword>JBoss</keyword>
- <keyword>JBoss Tools</keyword>
- <keyword>JBDS</keyword>
- <keyword>BIRT Plugin</keyword>
+ <keywordset xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Developer Studio</keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Eclipse</keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss</keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBDS</keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Plugin</keyword>
</keywordset>
</chapterinfo>
- <title>Introduction</title>
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Introduction</title>
- <section>
+ <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
- <title>What is BIRT?</title>
- <para>BIRT plugin is an Eclipse-based open source reporting system for web applications
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">What is BIRT?</title>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT plugin is an Eclipse-based open source reporting system for web applications
based on Java and J2EE. BIRT consists of two main components: a report designer based on
Eclipse, and a runtime component that can be added to your app server. BIRT also offers
a charting engine that lets you add charts to your own Web application.</para>
- <para>With the help of BIRT you can generate a great number of reports to be used in your
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">With the help of BIRT you can generate a great number of reports to be used in your
application:</para>
- <itemizedlist>
- <listitem>
- <para>Lists</para>
+ <itemizedlist xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Lists</para>
</listitem>
- <listitem>
- <para>Charts</para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Charts</para>
</listitem>
- <listitem>
- <para>Crosstabs, or cross-tabulation, or matrix</para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Crosstabs, or cross-tabulation, or matrix</para>
</listitem>
- <listitem>
- <para>Letters and Documents</para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Letters and Documents</para>
</listitem>
- <listitem>
- <para>Compound Reports</para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Compound Reports</para>
</listitem>
</itemizedlist>
- <para>You can find more detailed information on the BIRT plugin, its report types and
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You can find more detailed information on the BIRT plugin, its report types and
anatomy on the <ulink url="http://www.eclipse.org/birt/phoenix/intro/">BIRT Homepage</ulink>.</para>
- <para>To understand the basic BIRT concepts and to know how to create a basic BIRT report,
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">To understand the basic BIRT concepts and to know how to create a basic BIRT report,
refer to the <ulink url="http://www.eclipse.org/birt/phoenix/tutorial/">Eclipse BIRT
- Tutorials</ulink>. What extensions <property moreinfo="none">JBoss Tools</property> provides for
+ Tutorials</ulink>. What extensions <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</property> provides for
Eclipse BIRT you'll find out in the next sections.</para>
</section>
- <section>
- <title>JBoss BIRT Integration Functionality Overview</title>
+ <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss BIRT Integration Functionality Overview</title>
- <para><diffmk:wrapper diffmk:change="added">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
The key feature of JBoss BIRT Integration is the JBoss BIRT Integration Framework, which allows to integrate a BIRT report into Seam/JSF container.
The framework API reference is in the
- </diffmk:wrapper><link diffmk:change="added" linkend="framework"><diffmk:wrapper diffmk:change="added">JBoss BIRT Integraion Framework API Reference</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> chapter of the guide.
- </diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">
+ <link linkend="framework" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss BIRT Integraion Framework API Reference</link> chapter of the guide.
+ </para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
- This guide also covers functionality of </diffmk:wrapper><property moreinfo="none">JBoss Tools</property><diffmk:wrapper diffmk:change="added"> module which assists in
+ This guide also covers functionality of <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</property> module which assists in
integration with BIRT.
- The integration plug-in allows you to visually configure </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Hibernate Data Source</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> (specify a Hibernate configuration or JNDI URL),
+ The integration plug-in allows you to visually configure <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hibernate Data Source</property> (specify a Hibernate configuration or JNDI URL),
compose HQL queries with syntax-highlighting, content-assist, formatting as well as other functionalities available in the HQL editor.
- </diffmk:wrapper></para>
+ </para>
- <para><diffmk:wrapper diffmk:change="changed">
- To enable </diffmk:wrapper><property moreinfo="none">JBoss Tools</property><diffmk:wrapper diffmk:change="changed"> integration with BIRT you are intended to
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ To enable <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</property> integration with BIRT you are intended to
have the next:
- </diffmk:wrapper></para>
- <itemizedlist>
- <listitem>
- <para>Eclipse with <property moreinfo="none">JBoss Tools</property>
- installed (how to install <property moreinfo="none">JBoss Tools</property> on Eclipse, what
- dependences and versions requirements are needed reed in the <ulink diffmk:change="added" url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">JBoss Tools Installation</ulink> section)</para>
+ </para>
+ <itemizedlist xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Eclipse with <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</property>
+ installed (how to install <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</property> on Eclipse, what
+ dependences and versions requirements are needed reed in the <ulink url="#JBossToolsInstall">JBoss Tools Installation</ulink> section)</para>
</listitem>
- <listitem>
- <para>BIRT Report Designer (BIRT Report Designer 2.3.2
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Report Designer (BIRT Report Designer 2.3.2
you can download from <ulink url="http://www.eclipse.org/downloads/download.php?file=/birt/downloads/drops/...">Eclipse downloads site</ulink>)</para>
</listitem>
- <listitem>
- <para>BIRT Web Tools Integration ( BIRT WTP Integration 2.3.2 you can download from
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Web Tools Integration ( BIRT WTP Integration 2.3.2 you can download from
<ulink url="http://www.eclipse.org/downloads/download.php?file=/birt/downloads/drops/...">Eclipse downloads site</ulink>)</para>
</listitem>
</itemizedlist>
- <note>
- <title>Note:</title>
- <para>Versions of BIRT framework and BIRT WTP integration should be no less than RC4 in
+ <note xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Note:</title>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Versions of BIRT framework and BIRT WTP integration should be no less than RC4 in
order to the BIRT facet works correctly.</para>
</note>
</section>
@@ -175,101 +183,106 @@
-<chapter diffmk:change="added" id="tasks" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/tasks.xml" xreflabel="tasks">
+<chapter id="tasks" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/birt/docs/en/modules/tasks.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xreflabel="tasks">
<?dbhtml filename="tasks.html"?>
<chapterinfo>
- <keywordset>
+ <keywordset xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
- <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">Eclipse</diffmk:wrapper></keyword>
- <keyword>JBoss</keyword>
- <keyword><diffmk:wrapper diffmk:change="changed">JBoss Tools</diffmk:wrapper></keyword>
- <keyword><diffmk:wrapper diffmk:change="changed">BIRT Integration</diffmk:wrapper></keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Eclipse</keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss</keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Integration</keyword>
</keywordset>
</chapterinfo>
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tasks</diffmk:wrapper></title>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> In this chapter of the guide you will find information on the tasks that you can perform integrating BIRT. The required version of BIRT is 2.3.2 or greater.</diffmk:wrapper></para>
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Tasks</title>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> In this chapter of the guide you will find information on the tasks that you can perform integrating BIRT. The required version of BIRT is 2.3.2 or greater.</para>
-<section diffmk:change="added" id="birt_integration_with_seam" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/birt_integration_with_seam.xml">
- <title>Adding BIRT Functionality to Standard Seam Web Project</title>
+<section id="birt_integration_with_seam" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/birt/docs/en/modules/birt_integration_with_seam.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Adding BIRT Functionality to Standard Seam Web Project</title>
- <para><diffmk:wrapper diffmk:change="changed">In this section you'll know how to integrate BIRT into a Seam web project. </diffmk:wrapper></para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">In this section you'll know how to integrate BIRT into a Seam web project. </para>
- <para><diffmk:wrapper diffmk:change="added">You are supposed to have Seam runtime and JBoss Application Server downloaded and
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You are supposed to have Seam runtime and JBoss Application Server downloaded and
extracted on your hard drive.
You can download Seam from the
- </diffmk:wrapper><ulink diffmk:change="added" url="http://seamframework.org/Download"><diffmk:wrapper diffmk:change="added">Seam Framework</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> web page and
- JBoss Application Server from </diffmk:wrapper><ulink diffmk:change="added" url="http://jboss.org/jbossas/downloads/"><diffmk:wrapper diffmk:change="added">JBoss Application Server</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> official site.
+ <ulink url="http://seamframework.org/Download">Seam Framework</ulink> web page and
+ JBoss Application Server from <ulink url="http://jboss.org/jbossas/downloads/">JBoss Application Server</ulink> official site.
- </diffmk:wrapper></para>
+ </para>
+
<tip>
<title>Tip:</title>
- <para><diffmk:wrapper diffmk:change="changed">We used </diffmk:wrapper><ulink url="http://sourceforge.net/project/showfiles.php?group_id=22866&package_i...">JBoss Seam 2.0.1 GA</ulink> and <ulink url="http://sourceforge.net/project/showfiles.php?group_id=22866&package_i...">JBoss Application Server 4.2.2 GA</ulink> in examples of this guide.</para>
+ <para>We used <ulink
+ url="http://sourceforge.net/project/showfiles.php?group_id=22866&package_i..."
+ >JBoss Seam 2.0.1 GA</ulink> and <ulink
+ url="http://sourceforge.net/project/showfiles.php?group_id=22866&package_i..."
+ >JBoss Application Server 4.2.2 GA</ulink> in examples of this guide.</para>
</tip>
- <section id="creatin_project_with_birt">
- <title>Creating Seam Web Project with Birt Facet</title>
+ <section id="creatin_project_with_birt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Creating Seam Web Project with Birt Facet</title>
- <para><diffmk:wrapper diffmk:change="changed">We recommend to open </diffmk:wrapper><property moreinfo="none">Seam perspective</property> by going to <emphasis>
- <property moreinfo="none">Window > Open Perspective > Other > Seam</property></emphasis><diffmk:wrapper diffmk:change="changed"> , this way you will have all the tools to work with Seam at hand.
- To create a new Seam Web project navigate to </diffmk:wrapper><emphasis>
- <property moreinfo="none">File > New > Seam Web Project</property>
- </emphasis><diffmk:wrapper diffmk:change="changed">. Otherwise you should go to </diffmk:wrapper><emphasis>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">We recommend to open <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Seam perspective</property> by going to <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Window > Open Perspective > Other > Seam</property></emphasis> , this way you will have all the tools to work with Seam at hand.
+ To create a new Seam Web project navigate to <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">File > New > Seam Web Project</property>
+ </emphasis>. Otherwise you should go to <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
- <property moreinfo="none">File > New > Other > Seam > Seam Web
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">File > New > Other > Seam > Seam Web
Project</property>
- </emphasis><diffmk:wrapper diffmk:change="changed"> if </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Seam</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> perspective is not active.</diffmk:wrapper></para>
+ </emphasis> if <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Seam</property> perspective is not active.</para>
- <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore">
+ <orderedlist xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
- <listitem diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">On the first wizard page enter the project name, then specify the target runtime and
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">On the first wizard page enter the project name, then specify the target runtime and
target server. We recommend to use JBoss AS server and runtime environment to ensure best performance.
- </diffmk:wrapper></para>
+ </para>
- <figure float="0" id="CreatingSeamWebProject">
- <title>Creating Seam Web Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/birt_integration_with_seam/testBirtProject.png"></imagedata>
+ <figure id="CreatingSeamWebProject" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Creating Seam Web Project</title>
+ <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imagedata fileref="images/birt_integration_with_seam/testBirtProject.png" xmlns="http://docbook.org/ns/docbook"></imagedata>
</imageobject>
</mediaobject>
</figure>
</listitem>
- <listitem diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Configuration</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> group choose the version of </diffmk:wrapper><emphasis>
- <property moreinfo="none">Seam</property>
- </emphasis><diffmk:wrapper diffmk:change="added"> framework you are planning to use in your application. In this guide we used Seam 2.2. </diffmk:wrapper></para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">In the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Configuration</property></emphasis> group choose the version of <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Seam</property>
+ </emphasis> framework you are planning to use in your application. In this guide we used Seam 2.2. </para>
</listitem>
- <listitem diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Modify</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> button
- and enable the </diffmk:wrapper><emphasis>
- <property moreinfo="none">Birt Reporting Runtime Component</property>
- </emphasis><diffmk:wrapper diffmk:change="changed"> facet by checking the appropriate option.</diffmk:wrapper></para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Click the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Modify</property></emphasis> button
+ and enable the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Birt Reporting Runtime Component</property>
+ </emphasis> facet by checking the appropriate option.</para>
- <figure float="0">
- <title>Adding the Birt Reporting Runtime Component Facet </title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/birt_integration_with_seam/addingBirtFacet.png"></imagedata>
+ <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Adding the Birt Reporting Runtime Component Facet </title>
+ <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imagedata fileref="images/birt_integration_with_seam/addingBirtFacet.png" xmlns="http://docbook.org/ns/docbook"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para><diffmk:wrapper diffmk:change="changed">Alternatively you can just choose the </diffmk:wrapper><emphasis>
- <property moreinfo="none">JBoss BIRT Integration Web Project</property>
- </emphasis><diffmk:wrapper diffmk:change="added"> configuration from the drop-down list in the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Configuration</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> group </diffmk:wrapper></para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Alternatively you can just choose the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss BIRT Integration Web Project</property>
+ </emphasis> configuration from the drop-down list in the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Configuration</property></emphasis> group </para>
- <figure float="0">
- <title>Choosing the JBoss BIRT Integration Web Project Configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/birt_integration_with_seam/projectBirtConfiguration.png"></imagedata>
+ <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Choosing the JBoss BIRT Integration Web Project Configuration</title>
+ <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imagedata fileref="images/birt_integration_with_seam/projectBirtConfiguration.png" xmlns="http://docbook.org/ns/docbook"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -277,21 +290,21 @@
</listitem>
- <listitem diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="changed">You may leave the next two pages with default values, just press </diffmk:wrapper><emphasis><property moreinfo="none">Next</property></emphasis><diffmk:wrapper diffmk:change="added"> to proceed.
- </diffmk:wrapper></para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You may leave the next two pages with default values, just press <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Next</property></emphasis> to proceed.
+ </para>
</listitem>
- <listitem diffmk:change="added">
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">On the </diffmk:wrapper><emphasis><property moreinfo="none">Birt Configuration</property></emphasis><diffmk:wrapper diffmk:change="changed"> page you can modify the BIRT deployment settings, which you can edit afterwards in the web.xml of the generated project. Let's keep the default values for now.
- </diffmk:wrapper></para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">On the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Birt Configuration</property></emphasis> page you can modify the BIRT deployment settings, which you can edit afterwards in the web.xml of the generated project. Let's keep the default values for now.
+ </para>
- <figure float="0">
- <title>Configuring BIRT Deployment Settings</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/birt_integration_with_seam/birtDeploymentSettings.png"></imagedata>
+ <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Configuring BIRT Deployment Settings</title>
+ <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imagedata fileref="images/birt_integration_with_seam/birtDeploymentSettings.png" xmlns="http://docbook.org/ns/docbook"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -300,23 +313,23 @@
</listitem>
- <listitem diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="changed">You can also leave the </diffmk:wrapper><emphasis><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JSF Capabilities</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> page with default values. </diffmk:wrapper></para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You can also leave the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JSF Capabilities</property></emphasis> page with default values. </para>
</listitem>
- <listitem diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">On the </diffmk:wrapper><emphasis diffmk:change="added">
- <property moreinfo="none">Seam Facet</property>
- </emphasis><diffmk:wrapper diffmk:change="added"> page you should specify the Seam runtime and Connection profile. Please note, that the Seam runtime must be of the version you initially specified in the project settings (See the </diffmk:wrapper><link diffmk:change="added" linkend="CreatingSeamWebProject"><diffmk:wrapper diffmk:change="added">Creating Seam Web Project</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> figure). </diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> When creating a Seam project with BIRT capabilities you can use the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">BIRT Classic Models Sample Database</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> connection profile to work with the BIRT sample database.</diffmk:wrapper></para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">On the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Seam Facet</property>
+ </emphasis> page you should specify the Seam runtime and Connection profile. Please note, that the Seam runtime must be of the version you initially specified in the project settings (See the <link linkend="CreatingSeamWebProject" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Creating Seam Web Project</link> figure). </para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> When creating a Seam project with BIRT capabilities you can use the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Classic Models Sample Database</property> connection profile to work with the BIRT sample database.</para>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For more details on how to configure database connection for a Seam project please read the
- </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/tools/3.0.0.GA/en/seam/html_single/index.html#seamF..."><diffmk:wrapper diffmk:change="added">Configure Seam Facet Settings</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> chapter of Seam Dev Tools Reference Guide.</diffmk:wrapper></para>
- <figure float="0">
- <title>Configuring the Seam Facet settings</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/birt_integration_with_seam/seamFacet.png"></imagedata>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">For more details on how to configure database connection for a Seam project please read the
+ <ulink url="http://docs.jboss.org/tools/3.0.0.GA/en/seam/html_single/index.html#seamF...">Configure Seam Facet Settings</ulink> chapter of Seam Dev Tools Reference Guide.</para>
+ <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Configuring the Seam Facet settings</title>
+ <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imagedata fileref="images/birt_integration_with_seam/seamFacet.png" xmlns="http://docbook.org/ns/docbook"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -324,75 +337,75 @@
</listitem>
- <listitem diffmk:change="added">
- <para>Hit <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis><diffmk:wrapper diffmk:change="changed"> to create the project with BIRT functionality enabled.</diffmk:wrapper></para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hit <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Finish</property>
+ </emphasis> to create the project with BIRT functionality enabled.</para>
</listitem>
</orderedlist>
</section>
- <section id="integration">
- <title>Integration with Seam</title>
-<para><diffmk:wrapper diffmk:change="changed">
+ <section id="integration" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Integration with Seam</title>
+<para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
In the previous section you have created a Seam project with BIRT capabilities.
Now you can create a simple kick start project to see that everything is configured correctly.
-</diffmk:wrapper></para>
+</para>
- <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore">
- <listitem diffmk:change="added"><para><diffmk:wrapper diffmk:change="added">Now create a BIRT report file and insert test data into the file.
- Name the report file </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt.rptdesign</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, the report should print the data from the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">CLASSICMODELS.CUSTOMERS</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> table of the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">BIRT Classic Models Sample Database</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, namely: customer number (</diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">CLASSICMODELS.CUSTOMERS.CUSTOMERNAME</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added">),
- contact person first name ( </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">CLASSICMODELS.CUSTOMERS.CONTACTFIRSTNAME</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added">) ,
- contact person last name (</diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">CLASSICMODELS.CUSTOMERS.CONTACTLASTNAME</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added">) and
- contact person phone number(</diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">CLASSICMODELS.CUSTOMERS.PHONE</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added">).
- </diffmk:wrapper></para>
- <para><diffmk:wrapper diffmk:change="added">The title of the report should be set via </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">reportTitle</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> parameter</diffmk:wrapper></para>
- <para><diffmk:wrapper diffmk:change="added">
- As this guide is primarily focused on the BIRT integration and not the BIRT technology itself we will not show the steps required to make the report. If you do not feel strong about creating a BIRT report file please read </diffmk:wrapper><ulink diffmk:change="added" url="http://eclipse.org/birt/phoenix/tutorial/"><diffmk:wrapper diffmk:change="added">BIRT documentation</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.
- </diffmk:wrapper></para>
- <para><diffmk:wrapper diffmk:change="added">You can download the file </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt.rptdesign</diffmk:wrapper></property> <ulink diffmk:change="added" url="files/helloBirt.rptdesign"><diffmk:wrapper diffmk:change="added">here</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> and copy it to the WebContent folder of your Seam project.</diffmk:wrapper></para>
+ <orderedlist xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Now create a BIRT report file and insert test data into the file.
+ Name the report file <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">helloBirt.rptdesign</property>, the report should print the data from the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">CLASSICMODELS.CUSTOMERS</code> table of the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Classic Models Sample Database</property>, namely: customer number (<code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">CLASSICMODELS.CUSTOMERS.CUSTOMERNAME</code>),
+ contact person first name ( <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">CLASSICMODELS.CUSTOMERS.CONTACTFIRSTNAME</code>) ,
+ contact person last name (<code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">CLASSICMODELS.CUSTOMERS.CONTACTLASTNAME</code>) and
+ contact person phone number(<code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">CLASSICMODELS.CUSTOMERS.PHONE</code>).
+ </para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The title of the report should be set via <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">reportTitle</code> parameter</para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ As this guide is primarily focused on the BIRT integration and not the BIRT technology itself we will not show the steps required to make the report. If you do not feel strong about creating a BIRT report file please read <ulink url="http://eclipse.org/birt/phoenix/tutorial/">BIRT documentation</ulink>.
+ </para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You can download the file <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">helloBirt.rptdesign</property> <ulink url="files/helloBirt.rptdesign">here</ulink> and copy it to the WebContent folder of your Seam project.</para>
</listitem>
- <listitem diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="added">
- When you are done with the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt.rptdesign</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file, you should create a </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file that will contain the BIRT report you have just created.
- </diffmk:wrapper></para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ When you are done with the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">helloBirt.rptdesign</property> file, you should create a <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">.xhtml</property> file that will contain the BIRT report you have just created.
+ </para>
- <para><diffmk:wrapper diffmk:change="added">
- The JBoss BIRT Integration framework provides 2 components represented as </diffmk:wrapper><emphasis diffmk:change="added" role="bold"> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:birt></diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><emphasis diffmk:change="added" role="bold"> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:param></diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> tags. The jboss-seam-birt.jar library implements the functionality of the components. To find more information about the framework pleas read the </diffmk:wrapper><link diffmk:change="added" linkend="framework"><diffmk:wrapper diffmk:change="added">JBoss BIRT Integraion Framework API Reference</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> chapter.
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ The JBoss BIRT Integration framework provides 2 components represented as <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> and <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:param></property></emphasis> tags. The jboss-seam-birt.jar library implements the functionality of the components. To find more information about the framework pleas read the <link linkend="framework" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss BIRT Integraion Framework API Reference</link> chapter.
To use that tags on the page you need to declare the tag library and define the name space like this:
- </diffmk:wrapper></para>
+ </para>
- <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[
+ <programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[
xmlns:b="http://jboss.com/products/seam/birt"
- ]]></diffmk:wrapper></programlisting>
+ ]]></programlisting>
- <para><diffmk:wrapper diffmk:change="changed">
- The </diffmk:wrapper> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:birt></diffmk:wrapper></property></para><diffmk:wrapper diffmk:change="added"> is a container for a BIRT report, that helps you integrate the report into Seam environment.
- You can manage the properties of the report using the attributes of the </diffmk:wrapper><emphasis diffmk:change="added" role="bold"> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:birt></diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> tag.
- </diffmk:wrapper></listitem>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ The <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> is a container for a BIRT report, that helps you integrate the report into Seam environment.
+ You can manage the properties of the report using the attributes of the <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> tag.
+ </para>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
- The </diffmk:wrapper><emphasis diffmk:change="added" role="bold"> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:param></diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> tag describes report parameters. To set a parameter you need to specify it's name the value you want to pass.
+ The <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:param></property></emphasis> tag describes report parameters. To set a parameter you need to specify it's name the value you want to pass.
You can use EL expressions to bind the representation layer with back-end logic.
- </diffmk:wrapper></para>
+ </para>
- </orderedlist>
+ </listitem>
- <listitem diffmk:change="added">
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
- <para><diffmk:wrapper diffmk:change="added">Create the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file in the WebContent with the following content: </diffmk:wrapper></para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Create the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">helloBirt.xhtml</property> file in the WebContent with the following content: </para>
- <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[...
+ <programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[...
<!DOCTYPE composition PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<ui:composition xmlns="http://www.w3.org/1999/xhtml"
@@ -410,315 +423,321 @@
</rich:panel>
</ui:define>
</ui:composition>
-...]]></diffmk:wrapper></programlisting>
+...]]></programlisting>
- <para><diffmk:wrapper diffmk:change="changed">From this listing above you see that the title of the report is set via </diffmk:wrapper> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:param></diffmk:wrapper></property></para><diffmk:wrapper diffmk:change="added"> by setting the parameter name and defining the </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">"value"</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> attribute with the "Customers Contacts" value.</diffmk:wrapper></listitem>
- <listitem>
- <para><diffmk:wrapper diffmk:change="added">We have created a Seam project and inserted the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> report into the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> view file.</diffmk:wrapper></para>
-
-
-<para><diffmk:wrapper diffmk:change="added">To see that the application works correctly and as you expect, you need to launch it on the server.</diffmk:wrapper></para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">From this listing above you see that the title of the report is set via <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:param></property></emphasis> by setting the parameter name and defining the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">"value"</property></emphasis> attribute with the "Customers Contacts" value.</para>
+
+ </listitem>
+
+
+
+
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">We have created a Seam project and inserted the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">helloBirt</property> report into the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">helloBirt.xhtml</property> view file.</para>
+
+
+<para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">To see that the application works correctly and as you expect, you need to launch it on the server.</para>
</listitem>
- <listitem><para><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss Server View </diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> (If it is not open navigate to </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Windows > Show View > Other > JBoss Server View </diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">), select the server the application is deployed to and hit the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Start</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button. </diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="added">When the server is started, open your favourite browser and point it to </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">http://localhost:8080/HelloBirt/helloBirt.seam</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> .</diffmk:wrapper></para>
-
-
-<figure float="0">
- <title><diffmk:wrapper diffmk:change="changed">Integrating BIRT into Seam Project</diffmk:wrapper></title>
- <mediaobject>
- <imageobject>
- <imagedata diffmk:change="added" fileref="images/birt_integration_with_seam/helloBirtproject.png"></imagedata>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">In the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Server View </property> (If it is not open navigate to <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Windows > Show View > Other > JBoss Server View </property>), select the server the application is deployed to and hit the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Start</property> button. </para></listitem>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">When the server is started, open your favourite browser and point it to <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">http://localhost:8080/HelloBirt/helloBirt.seam</code> .</para>
+
+
+<figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Integrating BIRT into Seam Project</title>
+ <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imagedata fileref="images/birt_integration_with_seam/helloBirtproject.png" xmlns="http://docbook.org/ns/docbook"></imagedata>
</imageobject>
</mediaobject>
-</figure>
+</figure>
</listitem>
- </section>
- </section>
- <section id="hibernate_datasource">
+ </orderedlist>
+
+ </section>
+</section>
+
+<section id="hibernate_datasource" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/birt/docs/en/modules/hibernate_datasource.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
- <title>Using Hibernate ODA Data Source</title>
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Using Hibernate ODA Data Source</title>
- <para>The JBoss BIRT Integration feature includes the Hibernate ODA Data Source which is completely
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The JBoss BIRT Integration feature includes the Hibernate ODA Data Source which is completely
integrated with Hibernate Tools. You can use it the way as you would use any of BIRT ODA drivers.
</para>
-<orderedlist>
- <listitem>
- <para>First, you need to reverse engineer from the database to generate Seam entities. You can perform this operation going to <emphasis>
- <property>File > New > Seam Generate Entities</property>
- </emphasis> in the <property>Seam perspective</property>. More details on the Seam Generate
- Entities please read <ulink
- url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_single/ind..."
- >Seam Dev Tools Reference guide</ulink>).
- In this guide we will use the <property>Employees</property> table of the <property>DATAMODELS</property> database.
+<orderedlist xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">First, you need to reverse engineer from the database to generate Seam entities. You can perform this operation going to <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">File > New > Seam Generate Entities</property>
+ </emphasis> in the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Seam perspective</property>. More details on the Seam Generate
+ Entities please read <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_single/ind...">Seam Dev Tools Reference guide</ulink>).
+ In this guide we will use the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Employees</property> table of the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">DATAMODELS</property> database.
</para>
- <tip>
- <title>Tip:</title>
- <para>Before performing Seam Generate Entities, you should have a connection profile
- adjusted and connected to a database. How to do this see in the <ulink
- url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_single/ind..."
- >CRUD Database Application</ulink> chapter of the Seam Dev Tools Reference
+ <tip xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Tip:</title>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Before performing Seam Generate Entities, you should have a connection profile
+ adjusted and connected to a database. How to do this see in the <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_single/ind...">CRUD Database Application</ulink> chapter of the Seam Dev Tools Reference
guide.</para>
- <para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
If you followed the steps described in the
- <link linkend="birt_integration_with_seam">Adding BIRT Functionality to Standard Seam Web Project</link> chapter,
- you would have a connection profile already configured.
+ <link linkend="birt_integration_with_seam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Adding BIRT Functionality to Standard Seam Web Project</link> chapter,
+ you would have a connection profile already configured.
</para>
</tip>
</listitem>
- <listitem>
-<para>
- Next you should create a new BIRT report file ( <emphasis>><property>File > New > Other > Business Intelligence and Reporting
- Tools > Report</property></emphasis>) to represent the data from the <property>Employees</property> table. Call the file <property>employees.rptdesign</property>.
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ Next you should create a new BIRT report file ( <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">File > New > Other > Business Intelligence and Reporting
+ Tools > Report</property></emphasis>) to represent the data from the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Employees</property> table. Call the file <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">employees.rptdesign</property>.
</para>
</listitem>
-<listitem>
-
-
- <para>Now switch to the <property>BIRT Report Design</property> perspective.</para>
+<listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+
+
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Now switch to the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Report Design</property> perspective.</para>
</listitem>
- <listitem>
- <para>In the <property>Data Explorer</property> view right-click the <emphasis>
- <property>Data Source</property>
- </emphasis> node and choose <emphasis>
- <property>New Data Source</property>.</emphasis></para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">In the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Data Explorer</property> view right-click the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Data Source</property>
+ </emphasis> node and choose <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">New Data Source</property>.</emphasis></para>
- <figure>
- <title>Creating a New Data Source</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/hibernate_datasource/creatingDataSource.png"/>
+ <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Creating a New Data Source</title>
+ <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imagedata fileref="images/hibernate_datasource/creatingDataSource.png" xmlns="http://docbook.org/ns/docbook"></imagedata>
</imageobject>
</mediaobject>
</figure>
</listitem>
- <listitem>
- <para>The wizard will prompt you to select data source type. Choose <emphasis>
- <property>Hibernate Data Source</property>
- </emphasis> and give it a meaningful name, for instance <emphasis>
- <property>HibernateDataSource</property>
- </emphasis>. Hit <emphasis>
- <property>Next</property> to proceed.</emphasis></para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The wizard will prompt you to select data source type. Choose <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hibernate Data Source</property>
+ </emphasis> and give it a meaningful name, for instance <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">HibernateDataSource</property>
+ </emphasis>. Hit <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Next</property> to proceed.</emphasis></para>
- <figure>
- <title>Creating Hibernate Data Source</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/hibernate_datasource/hibernateDataSource.png"/>
+ <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Creating Hibernate Data Source</title>
+ <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imagedata fileref="images/hibernate_datasource/hibernateDataSource.png" xmlns="http://docbook.org/ns/docbook"></imagedata>
</imageobject>
</mediaobject>
</figure>
</listitem>
- <listitem>
- <para>On the next wizard's dialog you can leave the everything with default values, press the <emphasis>
- <property>Test Connection</property>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">On the next wizard's dialog you can leave the everything with default values, press the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Test Connection</property>
</emphasis> button to verify that the connection is established successfully.</para>
-
- <para>
- The <property>Hibernate Data Source</property> enables you to specify a Hibernate Configuration or JNDI URL.
-
+
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ The <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hibernate Data Source</property> enables you to specify a Hibernate Configuration or JNDI URL.
+
</para>
- <figure>
- <title>Hibernate Data Source Profile</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/hibernate_datasource/connectionSuccessful.png"/>
+ <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hibernate Data Source Profile</title>
+ <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imagedata fileref="images/hibernate_datasource/connectionSuccessful.png" xmlns="http://docbook.org/ns/docbook"></imagedata>
</imageobject>
</mediaobject>
</figure>
</listitem>
- <listitem>
- <para>Press <emphasis>
- <property>Finish</property>
- </emphasis> to complete <property>New Data Source</property> wizard.</para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Press <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Finish</property>
+ </emphasis> to complete <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">New Data Source</property> wizard.</para>
</listitem>
+
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Now you need to configure a new Hibernate ODA data set. Launch the
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">New Data Set</property> wizard. In the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Data Explorer View</property>
+ right-click the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Data Set</property>
+ </emphasis> node and select <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">New Data Set</property>.</emphasis></para>
- <listitem>
- <para>Now you need to configure a new Hibernate ODA data set. Launch the
- <property>New Data Set</property> wizard. In the <property>Data Explorer View</property>
- right-click the <emphasis>
- <property>Data Set</property>
- </emphasis> node and select <emphasis>
- <property>New Data Set</property>.</emphasis></para>
-
</listitem>
- <listitem>
- <para>Select <property>HibernateDataSource</property> as target data source and type in the new data set name.
- Call it <property>HibernateDataSet</property>.</para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Select <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">HibernateDataSource</property> as target data source and type in the new data set name.
+ Call it <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">HibernateDataSet</property>.</para>
- <figure>
- <title>Creating a Hibernate ODA Data Set</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/hibernate_datasource/addingHibernateODADataset.png"/>
+ <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Creating a Hibernate ODA Data Set</title>
+ <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imagedata fileref="images/hibernate_datasource/addingHibernateODADataset.png" xmlns="http://docbook.org/ns/docbook"></imagedata>
</imageobject>
</mediaobject>
</figure>
</listitem>
- <listitem>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
- <para>The next dialog of the wizard will help you compose a query for the new data set.</para>
- <para>We will make a report that will print all employees in the database who has Sales Rep job title.</para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The next dialog of the wizard will help you compose a query for the new data set.</para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">We will make a report that will print all employees in the database who has Sales Rep job title.</para>
- <programlisting role="SQL"><![CDATA[...
+ <programlisting role="SQL" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[...
select jobtitle, firstname, lastname, email
from Employees as employees where employees.jobtitle = 'Sales Rep'
-...]]></programlisting>
-
-
-
- <para>
-
+...]]></programlisting>
+
+
+
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+
To validate the
- entered query you can press the <emphasis>
- <property>Test query</property>
+ entered query you can press the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Test query</property>
</emphasis> button. All the HQL features like syntax highlighting, content assist,
formatting, drag-and-drop, etc., are available to facilitate query composing.</para>
- <figure>
- <title>Composing query for Data Set</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/hibernate_datasource/testingQuery.png"/>
+ <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Composing query for Data Set</title>
+ <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imagedata fileref="images/hibernate_datasource/testingQuery.png" xmlns="http://docbook.org/ns/docbook"></imagedata>
</imageobject>
</mediaobject>
</figure>
</listitem>
- <listitem>
-
- <para>Pressing <property>Finish</property> will call the <property>Edit Data Set</property> dialog where you can adjust the parameters of the data set and preview the resulted set.
- If everything looks good, hit <property>Ok</property> to generate a new data set.
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Pressing <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Finish</property> will call the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Edit Data Set</property> dialog where you can adjust the parameters of the data set and preview the resulted set.
+ If everything looks good, hit <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Ok</property> to generate a new data set.
</para>
</listitem>
- <listitem>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Now you can insert the data set items of <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">HibernateDataSet</property> into the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">employees.rptdesign</property>.</para>
+
- <para>Now you can insert the data set items of <property>HibernateDataSet</property> into the <property>employees.rptdesign</property>.</para>
-
-
- <tip>
- <title>Tip:</title>
- <para>If you don't know how to do this we suggest that you refer to the <ulink
- url="http://www.eclipse.org/birt/phoenix/tutorial/">Eclipse BIRT Tutorial</ulink>.</para>
+ <tip xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Tip:</title>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">If you don't know how to do this we suggest that you refer to the <ulink url="http://www.eclipse.org/birt/phoenix/tutorial/">Eclipse BIRT Tutorial</ulink>.</para>
</tip>
+
-
-<para>You can also use parameters in the query to add dynamics to your report. In the previous example we hardcoded the selection criterion in the <code>where</code> clause. </para>
- <para>To specify the job title on-the-fly your query should look like this:</para>
- <programlisting role="XML"><![CDATA[
+<para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You can also use parameters in the query to add dynamics to your report. In the previous example we hardcoded the selection criterion in the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">where</code> clause. </para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">To specify the job title on-the-fly your query should look like this:</para>
+ <programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[
select jobtitle,firstname, lastname,email
from Employees as employees where employees.jobtitle = ?
-]]></programlisting>
-
- <para>The question mark represents a data set input parameter, which is not the same as a report parameter.
- Now you need to define an new report parameter to pass the data to the report, call it <code>JobTitle</code>.
-
-
-
+]]></programlisting>
+
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The question mark represents a data set input parameter, which is not the same as a report parameter.
+ Now you need to define an new report parameter to pass the data to the report, call it <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JobTitle</code>.
+
+
+
The dataset parameter can be linked to a report parameter.
- In the <property>Data Explorer</property> view click the Data Set node to open it and right-click
- on the data set you created previously( in our case it is <property>HibernateDataSet</property>),
- choose <property>Edit</property> and navigate to the <property>Parameters</property> section.
- Declare a new data set parameter, name it <code>jobtitle</code> and map it to the already existing <code>JobTitle</code> report parameter.
+ In the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Data Explorer</property> view click the Data Set node to open it and right-click
+ on the data set you created previously( in our case it is <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">HibernateDataSet</property>),
+ choose <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Edit</property> and navigate to the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Parameters</property> section.
+ Declare a new data set parameter, name it <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">jobtitle</code> and map it to the already existing <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JobTitle</code> report parameter.
</para>
</listitem>
- <listitem>
- <para>You report is ready, you can view it by clicking on the <property>Preview</property> tab of the <property>BIRT Report Designer</property> editor. </para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You report is ready, you can view it by clicking on the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Preview</property> tab of the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Report Designer</property> editor. </para>
+
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You will be prompted to assign a value to the report parameter. For instance you can enter "Sales Rep". </para>
- <para>You will be prompted to assign a value to the report parameter. For instance you can enter "Sales Rep". </para>
-
- <figure>
- <title>Resulted Dynamic Report</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/hibernate_datasource/finalReport.png"/>
+ <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Resulted Dynamic Report</title>
+ <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imagedata fileref="images/hibernate_datasource/finalReport.png" xmlns="http://docbook.org/ns/docbook"></imagedata>
</imageobject>
</mediaobject>
</figure>
</listitem>
</orderedlist>
</section>
- <section diffmk:change="added" id="birt_reports_deployment" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/birt_reports_deployment.xml">
- <title><diffmk:wrapper diffmk:change="changed">Creating a Dynamic BIRT Report</diffmk:wrapper></title>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><link diffmk:change="added" linkend="birt_integration_with_seam"><diffmk:wrapper diffmk:change="added">Adding BIRT Functionality to Standard Seam Web Project</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">
- and </diffmk:wrapper><link diffmk:change="added" linkend="hibernate_datasource"><diffmk:wrapper diffmk:change="added">Using Hibernate ODA Data Sourc</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> sections tell how to integrate a BIRT report into
+
+<section id="birt_reports_deployment" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/birt/docs/en/modules/birt_reports_deployment.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Creating a Dynamic BIRT Report</title>
+
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The <link linkend="birt_integration_with_seam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Adding BIRT Functionality to Standard Seam Web Project</link>
+ and <link linkend="hibernate_datasource" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Using Hibernate ODA Data Sourc</link> sections tell how to integrate a BIRT report into
a Seam web project and how to use Hibernate data source to generate a dynamic report.
- In this section we will create a Seam web project that can make a dynamic report using the parameters that are defined on a web page.</diffmk:wrapper></para>
+ In this section we will create a Seam web project that can make a dynamic report using the parameters that are defined on a web page.</para>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">We will use the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">PRODUCTS</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> table of </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">DATAMODELS</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> database for the purpose of this demo project.
- In the first place, you need to generate Seam entities like we did in the previous chapter (</diffmk:wrapper><link diffmk:change="added" linkend="hibernate_datasource"><diffmk:wrapper diffmk:change="added">Hibernate ODA Data Source</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> ). The demo application will generate a report about the company's products, whereas it will allow to specify a product line. </diffmk:wrapper></para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">We will use the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">PRODUCTS</property> table of <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">DATAMODELS</property> database for the purpose of this demo project.
+ In the first place, you need to generate Seam entities like we did in the previous chapter (<link linkend="hibernate_datasource" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hibernate ODA Data Source</link> ). The demo application will generate a report about the company's products, whereas it will allow to specify a product line. </para>
-<orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore">
- <listitem diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The next step is to create a Java class that will store the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">sortOrder</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> variable and its assessors, register the class in faces.config.xml.
- The variable will be needed to pass dynamic data to the report via report parameters, therefore it has to be of session scope.</diffmk:wrapper></para>
+<orderedlist xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The next step is to create a Java class that will store the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">sortOrder</code> variable and its assessors, register the class in faces.config.xml.
+ The variable will be needed to pass dynamic data to the report via report parameters, therefore it has to be of session scope.</para>
</listitem>
- <listitem diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="added">
-
-
- The report will print the data from the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">Products</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> table, hence you need to create a report file first.
- You can use either the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">BIRT JDBC Data Source</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> or </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Hibernate Data Source</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> data source to create the data set for this project. If you want to use the latter please read the previous chapter </diffmk:wrapper><link diffmk:change="added" linkend="hibernate_datasource"><diffmk:wrapper diffmk:change="added">Hibernate ODA Data Source</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">.
-</diffmk:wrapper></para>
-
-
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+
+
+ The report will print the data from the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Products</code> table, hence you need to create a report file first.
+ You can use either the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT JDBC Data Source</property> or <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hibernate Data Source</property> data source to create the data set for this project. If you want to use the latter please read the previous chapter <link linkend="hibernate_datasource" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hibernate ODA Data Source</link>.
+</para>
+
+
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
The data set should have at least the following data set items: product vendor, product name, quantity in stock and buy price. The data is retrieved from the database with this query :
- </diffmk:wrapper></para>
-
-
- <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[
+ </para>
+
+
+ <programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[
SELECT productvedor,
productname,
quantityinstock,
buyprice
-FROM Products as products
+FROM Products as products
-]]></diffmk:wrapper></programlisting>
+]]></programlisting>
</listitem>
- <listitem diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Make a table in the report and put each data set item into a column.</diffmk:wrapper></para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Make a table in the report and put each data set item into a column.</para>
</listitem>
- <listitem diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">As it was stated in the beginning of the chapter the report will be dynamic, therefore you need to declare a report parameter first, let it be </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">sortOrder</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> and to add the parameter to the query. BIRT offers rich JavaScript API, so you can modify the query programmatically like this:</diffmk:wrapper></para>
-<programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added">
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">As it was stated in the beginning of the chapter the report will be dynamic, therefore you need to declare a report parameter first, let it be <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">sortOrder</code> and to add the parameter to the query. BIRT offers rich JavaScript API, so you can modify the query programmatically like this:</para>
+<programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<xml-property name="queryText"><![CDATA[
SELECT productvedor,
productname,
quantityinstock,
buyprice
-FROM Products as products
+FROM Products as products
]]></xml-property>
<method name="beforeOpen"><![CDATA[
queryString = " ORDER BY products."+reportContext.getParameterValue("sortOrder")+" "+"DESC";
this.queryText = this.queryText+queryString;
]]></method>
-
-</diffmk:wrapper></programlisting>
+
+</programlisting>
</listitem>
- <listitem diffmk:change="added">
-<para><diffmk:wrapper diffmk:change="changed">The report is ready. You can preview it to make sure it works properly. </diffmk:wrapper></para>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The report is ready. You can preview it to make sure it works properly. </para>
</listitem>
- <listitem diffmk:change="added"> <para><diffmk:wrapper diffmk:change="added">To set the report parameter you should create an </diffmk:wrapper><property moreinfo="none">.xhtml</property><diffmk:wrapper diffmk:change="added"> view page, call it </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Products.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. On the page you can set the value of the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">sortOrder</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> Java bean variable and press the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Generate Report</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button to open another view page that will display the resulted report.
- </diffmk:wrapper></para>
-
-
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The source code of the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Products.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> should be the following:</diffmk:wrapper></para>
-
- <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">To set the report parameter you should create an <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">.xhtml</property> view page, call it <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Products.xhtml</property>. On the page you can set the value of the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">sortOrder</code> Java bean variable and press the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Generate Report</property> button to open another view page that will display the resulted report.
+ </para>
+
+
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The source code of the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Products.xhtml</property> should be the following:</para>
+
+ <programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[
<!DOCTYPE composition PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<ui:composition xmlns="http://www.w3.org/1999/xhtml"
@@ -731,7 +750,7 @@
<ui:define name="body">
<rich:panel>
<f:facet name="header">BIRT Report Generator</f:facet>
- <a4j:form ajaxSubmit="true" reRender="criterion">
+ <a4j:form ajaxSubmit="true" reRender="criterion">
<table>
<tr>
<td>Select sort order criterion:</td>
@@ -742,384 +761,418 @@
</h:selectOneMenu>
</td>
</tr>
- </table>
+ </table>
</a4j:form>
<s:button
view="/#{!empty reportParameters.order ? 'Products' : 'ProductsReport'}.xhtml" id="generate" value="Generate Report" /> <!-- If the sertOrder variable is not set the button won't work -->
</rich:panel>
</ui:define>
-</ui:composition>
-]]></diffmk:wrapper></programlisting>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The logic of the file is quite simple, when the sort order criterion is select the value of </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">yourJavaBean.sortOrder</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added">
- is set automatically via Ajax and the report is ready to be generated.</diffmk:wrapper></para>
+</ui:composition>
+]]></programlisting>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The logic of the file is quite simple, when the sort order criterion is select the value of <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">yourJavaBean.sortOrder</code>
+ is set automatically via Ajax and the report is ready to be generated.</para>
</listitem>
- <listitem diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="added">Now you need to create the web page that will print the report, name the file </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">ProductsReport.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.
- The file to output the report should have the following content:</diffmk:wrapper></para>
-
-
- <para><diffmk:wrapper diffmk:change="added">
- As you know from the </diffmk:wrapper><link diffmk:change="added" linkend="birt_integration_with_seam"><diffmk:wrapper diffmk:change="added">Adding BIRT Functionality to Standard Seam Web Project</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> chapter, before using the BIRT Integration framework tags on the page you need to declare the tag library and specify the name space with this line:
- </diffmk:wrapper></para>
-
- <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Now you need to create the web page that will print the report, name the file <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">ProductsReport.xhtml</property>.
+ The file to output the report should have the following content:</para>
+
+<programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[
+<!DOCTYPE composition PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<ui:composition xmlns="http://www.w3.org/1999/xhtml"
+ xmlns:s="http://jboss.com/products/seam/taglib"
+ xmlns:ui="http://java.sun.com/jsf/facelets"
+ xmlns:f="http://java.sun.com/jsf/core"
+ xmlns:h="http://java.sun.com/jsf/html"
xmlns:b="http://jboss.com/products/seam/birt"
-]]></diffmk:wrapper></programlisting>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">
- The dynamics to the report adds this line:
- </diffmk:wrapper></para>
- <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[
+ xmlns:rich="http://richfaces.org/rich" template="layout/template.xhtml">
+ <ui:define name="body">
+ <rich:panel>
+ <f:facet name="header">Products Report</f:facet>
+ <b:birt designType="embed" designName="products.rptdesign"
+ embeddable="true" masterpage="true">
+ <b:param name="sortOrder" value="#{yourJavaBean.sortOrder}" />
+ </b:birt>
+ </rich:panel>
+</ui:define>
+</ui:composition>
+]]></programlisting>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ As you know from the <link linkend="birt_integration_with_seam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Adding BIRT Functionality to Standard Seam Web Project</link> chapter, before using the BIRT Integration framework tags on the page you need to declare the tag library and specify the name space with this line:
+ </para>
+
+ <programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[
+ xmlns:b="http://jboss.com/products/seam/birt"
+]]></programlisting>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ The dynamics to the report adds this line:
+ </para>
+ <programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[
<b:param name="sortOrder" value="#{yourJavaBean.sortOrder}" />
-]]></diffmk:wrapper></programlisting>
-
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">We bound the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">sortOrder</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> report parameter to Java Bean variable </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">value="#{yourJavaBean.sortOrder}"</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> using EL expression, and the value to the variable is assigned in the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Products.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file. </diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">By default if you embed a report into HTML page the HTML-format report contains the <html>,
- <head>, <body> etc., tags. However if your HTML page already has those tags, you can rid of them using the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">embeddable="true"</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> attribute of
-
- the </diffmk:wrapper><emphasis diffmk:change="added" role="bold"><property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:birt></diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> component.</diffmk:wrapper></para>
+]]></programlisting>
+
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">We bound the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">sortOrder</code> report parameter to Java Bean variable <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">value="#{yourJavaBean.sortOrder}"</code> using EL expression, and the value to the variable is assigned in the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Products.xhtml</property> file. </para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">By default if you embed a report into HTML page the HTML-format report contains the <html>,
+ <head>, <body> etc., tags. However if your HTML page already has those tags, you can rid of them using the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">embeddable="true"</code> attribute of
+
+ the <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> component.</para>
</listitem>
- <listitem diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="added">Deploy the project onto the server and open your browser to see the report is successfully generated. You should navigate to
-
- </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">http://localhost:8080/yourProjectName/Products.seam</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> to select the criterion and press the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Generate Report</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button. You will be redirected to the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">http://localhost:8080/HelloBirt/ProductsReport.seam</diffmk:wrapper></code>
-
- </para>
- <figure float="0">
- <title><diffmk:wrapper diffmk:change="changed">Dynamic Report</diffmk:wrapper></title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/hibernate_datasource/finalReport.png"/>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Deploy the project onto the server and open your browser to see the report is successfully generated. You should navigate to
+
+ <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">http://localhost:8080/yourProjectName/Products.seam</code> to select the criterion and press the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Generate Report</property> button. You will be redirected to the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">http://localhost:8080/HelloBirt/ProductsReport.seam</code>
+
+ </para>
+ <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Dynamic Report</title>
+ <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <imagedata fileref="images/birt_reports_deployment/productReport.png" xmlns="http://docbook.org/ns/docbook"></imagedata>
</imageobject>
</mediaobject>
</figure>
</listitem>
</orderedlist>
- <para><diffmk:wrapper diffmk:change="changed">Thus, a Seam project that includes the BIRT facet can be deployed as any project. If you
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Thus, a Seam project that includes the BIRT facet can be deployed as any project. If you
define the Hibernate ODA driver, the JBoss BIRT engine will use JNDI URL that has to be bound
to either Hibernate Session Factory or Hibernate Entity Manager Factory. If you
don't specify the JNDI URL property, our engine will try the following JNDI
- URLs:</diffmk:wrapper></para>
- <itemizedlist>
- <listitem>
- <para>
- <emphasis>java:/<project_name></emphasis>
+ URLs:</para>
+ <itemizedlist xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">java:/<project_name></emphasis>
</para>
</listitem>
- <listitem>
- <para>
- <emphasis>java:/<project_name>EntityManagerFactory</emphasis>
+ <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">java:/<project_name>EntityManagerFactory</emphasis>
</para>
</listitem>
</itemizedlist>
- <para>When creating a Seam EAR project, Hibernate Entity Manager Factory is bound to
- <emphasis>java:/{projectName}EntityManagerFactory</emphasis><diffmk:wrapper diffmk:change="changed">. All you need to do is
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">When creating a Seam EAR project, Hibernate Entity Manager Factory is bound to
+ <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">java:/{projectName}EntityManagerFactory</emphasis>. All you need to do is
to use the Hibernate Configuration created automatically. You can use default values for the
- Hibernate Configuration and JNDI URL within the BIRT Hibernate Data Source.</diffmk:wrapper></para>
+ Hibernate Configuration and JNDI URL within the BIRT Hibernate Data Source.</para>
- <para><diffmk:wrapper diffmk:change="changed">When using a Seam WAR project, neither HSF nor HEMF aren't bound to JNDI by
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">When using a Seam WAR project, neither HSF nor HEMF aren't bound to JNDI by
default. You have to do this manually. For instance, HSF can be bound to JNDI by adding the
- following property to the </diffmk:wrapper><emphasis>
- <property moreinfo="none">persistence.xml</property></emphasis> file:</para>
+ following property to the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">persistence.xml</property></emphasis> file:</para>
- <programlisting format="linespecific" role="XHTML"><![CDATA[<property name="hibernate.session_factory_name" value="java:/projectname"/>
+ <programlisting role="XHTML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[<property name="hibernate.session_factory_name" value="java:/projectname"/>
]]></programlisting>
- <para>And you can use <emphasis>java:/projectname</emphasis> as the JNDI URL property when creating a BIRT
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">And you can use <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">java:/projectname</emphasis> as the JNDI URL property when creating a BIRT
Hibernate Data Source.</para>
- <note>
- <title>Note:</title>
- <para>If you want to test this feature using PDE Runtime, you need to add <emphasis>
- <property moreinfo="none">osgi.dev=bin</property>
- </emphasis> to the <emphasis>
- <property moreinfo="none">WebContent/WEB-INF/platform/configuration/config.ini</property>
+ <note xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Note:</title>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">If you want to test this feature using PDE Runtime, you need to add <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">osgi.dev=bin</property>
+ </emphasis> to the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">WebContent/WEB-INF/platform/configuration/config.ini</property>
</emphasis> file.</para>
</note>
-
- <para><diffmk:wrapper diffmk:change="changed">In conclusion, the main goal of this document is to get you to know with a full feature set
- that </diffmk:wrapper><property moreinfo="none">JBoss BIRT Tools</property> provide. Thus if you have some questions,
- comments or suggestions on the topic, please feel free to ask in the <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=201">JBoss
+
+ <para>In conclusion, the main goal of this document is to get you to know with a full feature set
+ that <property>JBoss BIRT Tools</property> provide. Thus if you have some questions,
+ comments or suggestions on the topic, please feel free to ask in the <ulink
+ url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=201">JBoss
Tools Forum</ulink>. You can also influence on how you want to see JBoss Tools docs in
- future leaving your vote on the article <ulink url="http://www.jboss.org/community/docs/DOC-10795">Overview of the improvements required by JBossTools/JBDS Docs users</ulink>.</para>
-
+ future leaving your vote on the article <ulink
+ url="http://www.jboss.org/community/docs/DOC-10795">Overview of the improvements required by JBossTools/JBDS Docs users</ulink>.</para>
+
+
</section>
- </chapter>
-<chapter diffmk:change="added" id="framework" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/tasks.xml" xreflabel="framework">
+
+</chapter>
+
+
+<chapter id="framework" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/birt/docs/en/modules/framework.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<?dbhtml filename="framework.html"?>
<chapterinfo>
- <keywordset>
+ <keywordset xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
- <keyword>Eclipse</keyword>
- <keyword>JBoss</keyword>
- <keyword>JBoss Tools</keyword>
- <keyword>BIRT Integration</keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Eclipse</keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss</keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Integration</keyword>
</keywordset>
</chapterinfo>
- <title>JBoss BIRT Integraion Framework API Reference</title>
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss BIRT Integraion Framework API Reference</title>
-<section>
-
- <title>
- <emphasis role="bold"> <property><b:birt></property></emphasis> Component
+<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> Component
</title>
-
-
-
-<para>
- The <emphasis role="bold"> <property><b:birt></property></emphasis> component servers to integrate a BIRT report into Seam/JSF container.
- The <emphasis role="bold"> <property><b:birt></property></emphasis> tag recognizes most of the parameters described on the BIRT
+
+
+
+<para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ The <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> component servers to integrate a BIRT report into Seam/JSF container.
+ The <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> tag recognizes most of the parameters described on the BIRT
<ulink url="http://www.eclipse.org/birt/phoenix/deploy/viewerUsage2.2.php#parameters">Report Viewer Parameters</ulink> page, though it has attributes of its own.
-
+
</para>
-
-
- <table>
- <title><emphasis role="bold"> <property><b:birt></property></emphasis> Component Reference</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Attribute</entry>
- <entry>Correspondance to BIRT Report Viewer parameters</entry>
- <entry>Description/</entry>
-
+
+
+ <table xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> Component Reference</title>
+ <tgroup cols="3" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <thead xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Attribute</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Correspondance to BIRT Report Viewer parameters</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Description/</entry>
+
</row>
</thead>
- <tbody>
- <row>
- <entry>designType</entry>
- <entry> - </entry>
- <entry>Corresponds to the BIRT servlet mappings. Possible values are run, frameset, preview and embed.
- If the attribute is set to embed the component is used for
- embeddable html. This type ignores all the attributes except designName
+ <tbody xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">designType</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - </entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Corresponds to the BIRT servlet mappings. Possible values are run, frameset, preview and embed.
+ If the attribute is set to embed the component is used for
+ embeddable html. This type ignores all the attributes except designName
and masterpage.
</entry>
- </row>
- <row>
- <entry>embeddable</entry>
- <entry> - </entry>
- <entry>A BIRT report occupies the whole page by default. It contains the <html>,
+ </row>
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">embeddable</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - </entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">A BIRT report occupies the whole page by default. It contains the <html>,
<head>, <body> etc., tags. Embedded report can be a part of another page.
It doesn't contain the above mentioned tags. Only HTML report can be embedded.</entry>
- </row>
- <row>
- <entry>designName</entry>
- <entry>__report</entry>
- <entry>Sets the name of the report design to process. This can be an absolute path or relative to the working folder. Valid values are run, frameset and preview</entry>
- </row>
-
- <row>
- <entry>format</entry>
- <entry>__format</entry>
- <entry>Specifies the desired output format, such as pdf, html, doc, ppt, or xls.</entry>
- </row>
-
- <row>
- <entry>title</entry>
- <entry>__title</entry>
- <entry>Sets the report title.</entry>
- </row>
-
- <row>
- <entry>showtitle</entry>
- <entry>__showtitle</entry>
- <entry>Determines if the report title is shown in the frameset viewer. Defaults to true.</entry>
- </row>
-
- <row>
- <entry>toolbar</entry>
- <entry>__toolbar</entry>
- <entry>
-
+ </row>
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">designName</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__report</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Sets the name of the report design to process. This can be an absolute path or relative to the working folder. Valid values are run, frameset and preview</entry>
+ </row>
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">format</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__format</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Specifies the desired output format, such as pdf, html, doc, ppt, or xls.</entry>
+ </row>
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">title</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__title</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Sets the report title.</entry>
+ </row>
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">showtitle</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__showtitle</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Determines if the report title is shown in the frameset viewer. Defaults to true.</entry>
+ </row>
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">toolbar</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__toolbar</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+
Determines if the report toolbar is shown in the frameset viewer.Defaults to true. Valid values are true and false.</entry>
- </row>
-
-
-
- <row>
- <entry>navigationbar</entry>
- <entry>__navigationbar</entry>
- <entry>
-
+ </row>
+
+
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">navigationbar</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__navigationbar</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+
Determines if the navigation bar is shown in the frameset viewer. Defaults to true. Valid values are true and false.</entry>
- </row>
-
-
- <row>
- <entry>document</entry>
- <entry>__document</entry>
- <entry>
+ </row>
+
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">document</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__document</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
Sets the name for the rptdocument. The document is created when the report engine separates run and render tasks, and
- is used to support features like table of contents and pagination.
+ is used to support features like table of contents and pagination.
This setting can be an absolute path or relative to the working folder. If no document parameter is used, a unique document is created in the document folder.
</entry>
- </row>
-
- <row>
- <entry>locale</entry>
- <entry>__locale</entry>
- <entry>
+ </row>
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">locale</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__locale</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
Specifies the locale for the specific operation. Note that this will override the default locale.
</entry>
- </row>
- <row>
- <entry>svg</entry>
- <entry>__svg</entry>
- <entry>
+ </row>
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">svg</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__svg</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
Specifies whether SVG is supported.
</entry>
- </row>
-
-
-
- <row>
- <entry>page</entry>
- <entry>__page</entry>
- <entry>
+ </row>
+
+
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">page</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__page</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
Specifies specific page to render.
</entry>
- </row>
-
-
- <row>
- <entry>pagerange</entry>
- <entry>__pagerange</entry>
- <entry>
+ </row>
+
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">pagerange</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__pagerange</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
Specifies page range to render. Eg 1-4,7.
</entry>
- </row>
-
-
- <row>
- <entry>masterpage</entry>
- <entry>__masterpage</entry>
- <entry>
-
+ </row>
+
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">masterpage</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__masterpage</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+
Indicates that the report master page should be used or not. Validvalues are true and false.
</entry>
</row>
-
-
- <row>
- <entry>overwrite</entry>
- <entry>__overwrite</entry>
- <entry>
-
- This setting if set to true will force an overwrite of the existing report document.
+
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">overwrite</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__overwrite</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+
+ This setting if set to true will force an overwrite of the existing report document.
</entry>
</row>
-
- <row>
- <entry>bookmark</entry>
- <entry>__bookmark</entry>
- <entry>
-
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">bookmark</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__bookmark</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+
Specifies a specific bookmark within the report to load. The viewer will automatically load the appropriate page.
</entry>
</row>
-
-
-
- <row>
- <entry>rtl</entry>
- <entry>__rtl</entry>
- <entry>
+
+
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">rtl</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__rtl</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
Specifies whether to display the report in right to left format. This setting defaults to false.
</entry>
</row>
-
-
-
- <row>
- <entry>fittopage</entry>
- <entry>__fittopage</entry>
- <entry>
+
+
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">fittopage</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__fittopage</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
Specifies whether PDF generation should fit content to a page. Valid values are true and false.
</entry>
</row>
-
-
- <row>
- <entry>resourceFolder</entry>
- <entry>__resourceFolder</entry>
- <entry>
+
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">resourceFolder</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__resourceFolder</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
Specifies the resource folder to use. This setting will override the default setting in the web.xml. The resource folder is used to locate libraries, images, and resource files.
</entry>
</row>
-
+
</tbody>
</tgroup>
</table>
-
+
</section>
-
- <section>
- <title><emphasis role="bold"> <property><b:param></property></emphasis> Component</title>
- <para>
- The <emphasis role="bold"> <property><b:param></property></emphasis> tag describes report parameter.
+
+ <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:param></property></emphasis> Component</title>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ The <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:param></property></emphasis> tag describes report parameter.
</para>
-
- <table>
- <title><emphasis role="bold"> <property><b:param></property></emphasis> Component</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Attribute</entry>
-
- <entry>Description</entry>
+
+ <table xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:param></property></emphasis> Component</title>
+ <tgroup cols="2" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <thead xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Attribute</entry>
+
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Description</entry>
</row>
</thead>
- <tbody>
- <row>
- <entry>name</entry>
- <entry>The parameter name. Required.</entry>
- </row>
- <row>
- <entry>value</entry>
- <entry>The parameter value. Required.</entry>
- </row>
-
- <row>
- <entry>isnull</entry>
- <entry>Specifies that a report parameter has a null value</entry>
- </row>
- <row>
- <entry>islocale</entry>
- <entry>Specifies whether the parameter is localized</entry>
- </row>
-
+ <tbody xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">name</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The parameter name. Required.</entry>
+ </row>
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">value</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The parameter value. Required.</entry>
+ </row>
+
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">isnull</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Specifies that a report parameter has a null value</entry>
+ </row>
+ <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">islocale</entry>
+ <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Specifies whether the parameter is localized</entry>
+ </row>
+
</tbody>
-
+
</tgroup>
</table>
</section>
+
+
+
+
+
+
</chapter>
-<chapter diffmk:change="added" id="birt_plugin_rel_resources" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/links.xml" xreflabel="birt_plugin_rel_resources">
+
+
+<chapter id="birt_plugin_rel_resources" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/birt/docs/en/modules/links.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xreflabel="birt_plugin_rel_resources">
<?dbhtml filename="links.html"?>
- <chapterinfo diffmk:change="added">
- <keywordset diffmk:change="added">
+ <chapterinfo>
+ <keywordset xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
- <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">Eclipse</diffmk:wrapper></keyword>
- <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss</diffmk:wrapper></keyword>
- <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss Tools</diffmk:wrapper></keyword>
- <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">BIRT Integration</diffmk:wrapper></keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Eclipse</keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss</keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</keyword>
+ <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Integration</keyword>
</keywordset>
</chapterinfo>
- <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Other Relevant Resources on the Topic</diffmk:wrapper></title>
+ <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Other Relevant Resources on the Topic</title>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">All JBoss Developer Studio/JBoss Tools release documentation you can find at </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/tools/"><diffmk:wrapper diffmk:change="added">http://docs.jboss.org/tools</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> in the corresponding release directory.</diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The latest documentation builds are available at </diffmk:wrapper><ulink diffmk:change="added" url="http://download.jboss.org/jbosstools/nightly-docs/"><diffmk:wrapper diffmk:change="added">http://download.jboss.org/jbosstools/nightly-docs</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">All JBoss Developer Studio/JBoss Tools release documentation you can find at <ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.
-</diffmk:wrapper></para>
+</para>
</chapter>
14 years, 7 months
JBoss Tools SVN: r20349 - in trunk/jmx/docs/reference/en: modules and 1 other directory.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2010-02-18 03:42:54 -0500 (Thu, 18 Feb 2010)
New Revision: 20349
Modified:
trunk/jmx/docs/reference/en/master.xml
trunk/jmx/docs/reference/en/master_output.xml
trunk/jmx/docs/reference/en/modules/references.xml
Log:
<html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif">
<p>https://jira.jboss.org/jira/browse/JBDS-1104 - Updated versions,corrected master_output file</p>
</body></html>
Modified: trunk/jmx/docs/reference/en/master.xml
===================================================================
--- trunk/jmx/docs/reference/en/master.xml 2010-02-18 08:32:50 UTC (rev 20348)
+++ trunk/jmx/docs/reference/en/master.xml 2010-02-18 08:42:54 UTC (rev 20349)
@@ -50,7 +50,7 @@
<holder>JBoss by Red Hat</holder>
</copyright>
<releaseinfo>
- Version: 1.1.0.CR1
+ Version: 1.1.0.CR2
</releaseinfo>
<abstract>
<title/>
Modified: trunk/jmx/docs/reference/en/master_output.xml
===================================================================
--- trunk/jmx/docs/reference/en/master_output.xml 2010-02-18 08:32:50 UTC (rev 20348)
+++ trunk/jmx/docs/reference/en/master_output.xml 2010-02-18 08:42:54 UTC (rev 20349)
@@ -8,8 +8,9 @@
<!ENTITY connection SYSTEM "modules/connection.xml">
<!ENTITY how_to SYSTEM "modules/how_to.xml">
<!ENTITY extensions SYSTEM "modules/extensions.xml">
-
-
+<!ENTITY tasks SYSTEM "modules/tasks.xml">
+<!ENTITY references SYSTEM "modules/references.xml">
+<!ENTITY summary SYSTEM "modules/summary.xml">
<!ENTITY seamlink "../../seam/html_single/index.html">
<!ENTITY aslink "../../as/html_single/index.html">
<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
@@ -23,594 +24,609 @@
<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
-]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
-
- <bookinfo>
- <title>JMX Tools Reference Guide</title>
-
- <corpauthor>
- <inlinemediaobject>
- <imageobject role="fo">
- <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata>
- </imageobject>
- <imageobject role="html">
- <imagedata></imagedata>
- </imageobject>
- </inlinemediaobject>
- </corpauthor>
-
-
- <copyright>
- <year>2007</year>
- <year>2008</year>
- <year>2009</year>
- <year>2010</year>
- <holder>JBoss by Red Hat</holder>
- </copyright>
- <releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 1.1.0.CR1
- </diffmk:wrapper></releaseinfo>
-<abstract>
- <title></title>
- <para>
- <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jmx_ref_guide/pdf/JM...">PDF version</ulink>
- </para>
-</abstract>
-
- </bookinfo>
-
-
- <toc></toc>
-
-<chapter id="intruduction" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/jmx/docs/reference/en/modules/introduction.xml" xreflabel="introduction">
- <?dbhtml filename="introduction.html"?>
-
- <title>Introduction</title>
-
- <para><property moreinfo="none">JMX Tools</property> allows to setup multiple JMX connections and provides view
- for exploring the JMX tree and execute operations directly from Eclipse.</para>
-
- <para>This chapter covers the basics of working with <property moreinfo="none">JMX plugin</property>, which is
- used to manage Java applications through JMX and its RMI Connector.</para>
-
- <figure float="0">
- <title>JMX Tools</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/eclipse-jmx_0.2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <section>
- <title> Requirements </title>
- <para>Requirements to use <property moreinfo="none">JMX Tools</property> are the following:</para>
-
- <itemizedlist>
- <listitem>
- <para><property moreinfo="none">JMX Tools</property> is developed on Eclipse 3.4.x milestones</para>
- </listitem>
- <listitem>
- <para><property moreinfo="none">JMX Tools</property> requires that Eclipse is run on a JDK 1.5.0 or above
- (due to dependencies on JMX packages which were introduced in Java 1.5.0)</para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section>
- <title>History</title>
- <para><property moreinfo="none">JBoss Tools</property>' JMX project is a fork of <ulink url="http://code.google.com/p/eclipse-jmx/">eclipse-jmx</ulink>, a project by Jeff Mesnil.
- It was forked with permission. </para>
- </section>
-
- <section><title>Key Features of JMX Tools</title>
- <para>For a start, we propose you to look through the table of main features of JMX Tools:</para>
- <table>
-
- <title>Key Functionality for JMX Tools</title>
- <tgroup cols="3">
-
- <colspec align="left" colnum="1" colwidth="2*"></colspec>
- <colspec colnum="2" colwidth="4*"></colspec>
- <colspec align="left" colnum="3" colwidth="2*"></colspec>
-
- <thead>
- <row>
- <entry>Feature</entry>
- <entry>Benefit</entry>
- <entry>Chapter</entry>
- </row>
- </thead>
-
- <tbody>
-
- <row>
- <entry><para>MBean Explorer</para></entry>
- <entry><para>MBean Explorer is a useful view with a text filter that displays domains, mbeans, attributes, and operations inside a connection.</para></entry>
- <entry>
- <link linkend="mbean_explorer">MBean Explorer</link>
- </entry>
- </row>
-
- <row>
- <entry><para>MBean Editor</para></entry>
- <entry><para>MBean Editor is a multi-page editor to manage MBeans.</para></entry>
- <entry>
- <link linkend="mbean_editor">MBean Editor</link>
- </entry>
- </row>
-
-
- </tbody>
-
- </tgroup>
- </table>
-
-
-
-
- </section>
-
-
-
- <section>
- <title>Installation</title>
- <para>Here, we are going to explain how to install the <property moreinfo="none">JMX plugin</property> into
- Eclipse.</para>
-
- <para><property moreinfo="none">JMX Tools</property> is one module of the <property moreinfo="none">JBoss Tools</property>
- project. <property moreinfo="none">JMX Tools</property> has no dependency on any other part of <property moreinfo="none">JBoss
- Tools</property>, and can be downloaded standalone. Even though the <property moreinfo="none">JMX
- Tools</property> have no dependencies, other plugins, such as <property moreinfo="none">AS Tools</property>,
- do depend on the JMX Tooling and even extend it. </para>
-
- <para>You can find the <property moreinfo="none">JBoss Tools</property> plugins over at the <ulink url="http://labs.jboss.com/tools/download.html">download pages</ulink>. The only
- package you'll need to get is the JMX Tooling, however the <property moreinfo="none">AS
- Tools</property> would give you a more full experience when using JMX with JBoss Servers.
- You can find further download and installation instructions on the JBoss Wiki in the <ulink url="http://labs.jboss.com/wiki/InstallingJBossTools">InstallingJBossTools</ulink>
- section.</para>
- </section>
-
-
- <section>
- <title>Quick Start</title>
-
- <para>To start using the <property moreinfo="none">JMX Tools</property>, it's necessary to open
- <property moreinfo="none">MBean Explorer</property>. Go to <emphasis><property moreinfo="none">Window > Show View > Other</property></emphasis> and then select
- <property moreinfo="none">MBean Explorer</property> and click <emphasis><property moreinfo="none">OK</property>.</emphasis></para>
-
- <para>The <property moreinfo="none">MBean Explorer</property> lists all of the domains, mbeans, attributes, and operations inside a
- connection. When you double-click on a MBean in the <emphasis><property moreinfo="none">MBean Explorer</property>,</emphasis> it opens a multi-page
- editor to manage the MBean. The <property moreinfo="none">MBean Editor</property> is composed of these pages:</para>
-
- <itemizedlist>
- <listitem>
- <para><emphasis><property moreinfo="none">Attributes page</property>,</emphasis> to get/set the attributes of the MBean</para>
- </listitem>
- <listitem>
- <para><emphasis><property moreinfo="none">Operations page</property>,</emphasis> to invoke operations on the MBean</para>
- </listitem>
- <listitem>
- <para><emphasis><property moreinfo="none">Notifications page</property>,</emphasis> to receive notifications from the MBean</para>
- </listitem>
- <listitem>
- <para><emphasis><property moreinfo="none">Info page</property>,</emphasis> which displays general information about the MBean </para>
- </listitem>
- </itemizedlist>
-
- </section>
- <section>
- <title>Other relevant resources on the topic</title>
-
- <para>You can find a set of benefits and other extra information on:</para>
- <itemizedlist>
- <listitem>
- <para>
- <ulink url="http://www.jboss.org/community/wiki/JBossMX">JBoss Wiki</ulink>
- </para>
- </listitem>
-
- </itemizedlist>
-
-
-
- </section>
-
-</chapter>
-
-
-<chapter id="mbean_explorer" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/jmx/docs/reference/en/modules/mbean_explorer.xml" xreflabel="mbean_explorer">
- <?dbhtml filename="mbean_explorer.html"?>
-
- <title>MBean Explorer</title>
- <para>The <property moreinfo="none">MBean Explorer</property> displays the MBean features (both attributes and operations) in its
- hierarchy. Double-clicking on a feature will open a <property moreinfo="none">MBean Editor</property>, display the page
- corresponding to the feature type and select the feature.</para>
-
- <figure float="0">
- <title>MBean Explorer Features</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/mbean-explorer-features.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Since it's possible to have many MBean Editors opened at the same time, the <property moreinfo="none">MBean Explorer</property>
- has the Link With Editor button
-
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/link-with-editor_0.2.0.png"></imagedata>
- </imageobject>
- </inlinemediaobject>
-
- to synchronize selections between the active <property moreinfo="none">MBean Editor</property> and
- the <property moreinfo="none">MBean Explorer</property> (and vice versa).</para>
-
- <para>The <property moreinfo="none">MBean Explorer</property> has also a filter text that can be used to filter among all the MBeans
- the few ones, which interest you.</para>
-
- <para>For example, if you are only interested by MBeans related to memory, typing memo will show
- any node (domain, mbean, attribute, or operation) that matches that text, as well as
- that node's parents and children. So if an MBean matches, all attributes and operations from
- that bean will show. If, however, an attribute or operation name (a leaf node) matches,
- only that node and its parents in the tree will show.</para>
-
- <figure float="0">
- <title>Query Filter</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/mbean-explorer-query.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para>The <emphasis>
- <property moreinfo="none">Collapse All</property></emphasis> button
-
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/collaps_all.png"></imagedata>
- </imageobject>
- </inlinemediaobject>
-
- on the <property moreinfo="none">MBean Explorer</property> toolbar is used to collapse all the MBeans and
- display only the domains. It is also possible to double click on a node to expand/collapse it. </para>
-
-</chapter>
-
-
-<chapter id="mbean_editor" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/jmx/docs/reference/en/modules/mbean_editor.xml" xreflabel="mbean_editor">
- <?dbhtml filename="mbean_editor.html"?>
-
- <title>MBean Editor</title>
-
- <figure float="0">
- <title>MBean Editor Pages</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/mbean-editor_0.2.0.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The <property moreinfo="none">MBean Editor</property> is composed of several pages:</para>
-
- <itemizedlist>
- <listitem>
- <para>the <emphasis>
- <property moreinfo="none">Attributes</property></emphasis> page</para>
- </listitem>
- <listitem>
- <para>the <emphasis>
- <property moreinfo="none">Operations</property></emphasis> page</para>
- </listitem>
- <listitem>
- <para>the <emphasis>
- <property moreinfo="none">Notifications</property></emphasis> page </para>
- </listitem>
- <listitem>
- <para>the <emphasis>
- <property moreinfo="none">Info</property></emphasis> page </para>
- </listitem>
- </itemizedlist>
-
- <para> The <emphasis>
- <property moreinfo="none">Attributes</property>
- </emphasis> and <emphasis>
- <property moreinfo="none">Operations</property>
- </emphasis> pages display a list for either the MBean attributes or operations as well as
- details for the selection.</para>
-
- <para> It is possible to toggle the layout between the list and the details either vertically
- (by default) or horizontally with the help of the special icons
-
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/mbean-editor-layout-buttons_0.2.0.png"></imagedata>
- </imageobject>
- </inlinemediaobject>
-
- in the right top corner of the editor.</para>
-
- <figure float="0">
- <title>MBean Editor Horizontal Layout</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <section>
- <title>Notifications Page</title>
- <para>One more page in the <property moreinfo="none">MBean Editor</property> is the <emphasis>
- <property moreinfo="none">Notifications</property></emphasis> page, which gives the possibility to
- subscribe (resp. unsubscribe) to a MBean to receive its notifications by checking (resp.
- unchecking) the <emphasis>
- <property moreinfo="none">Subscribe</property></emphasis> button in the right top corner. </para>
- <para>The list of notifications is refreshed every time a new notification is
- received:</para>
-
- <figure float="0">
- <title>MBean Editor Notifications Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/notifications.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Note</title>
- <para>It is only possible to subscribe to MBean, which emits notifications (they must be
- NotificationBroadcaster).</para>
- </note>
-
- </section>
-
-</chapter>
-
-
-<chapter id="connection" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/jmx/docs/reference/en/modules/connection.xml" xreflabel="connection">
- <?dbhtml filename="connection.html"?>
-
- <title>Connections</title>
-
- <para>The <property moreinfo="none">MBean Explorer</property> supports several different types of connections.
- The tooling itself comes only with a default connection type, however other
- adopters can provide additional connection types that may require additional
- or non-spec behavior. Connections can be in either the connected state or
- the disconnected state. Some connection types (such as the default connection type)
- allow you to control the current state. Other connection types may not. </para>
-
- <para>Similarly, some connection types may be able to be created, and others may not.
- The default connection type, for example, can be created and deleted by you
- at will. The AS Tools connection type, which represents a JBoss server, does not
- allow you this level of control. A JBoss JMX connection is created when a JBoss server is created
- in the server's view, and deleted when said server is deleted. The JMX connection for
- this server is in the connected state only when the server is started. </para>
-
-
- <section><title>The Default Connection</title>
-
- <para> There are two ways to connect to an application with remote management enabled:</para>
-
- <para> The first step is the same for both - to connect to a MBean Server, click on the
- <emphasis>
- <property moreinfo="none">New Connection</property></emphasis> icon
-
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/new_connection_icon.png"></imagedata>
- </imageobject>
- </inlinemediaobject>
-
- in the <property moreinfo="none">MBean Explorer</property> menu bar.</para>
-
- <para>Then to follow the simple one you just need to specify host, port (and optionally user
- name and password) and click <emphasis>
- <property moreinfo="none">OK</property>.</emphasis></para>
-
- <para>The default JMX URL is <emphasis>
- <property moreinfo="none">service:jmx:rmi:///jndi/rmi://localhost:3000/jmxrmi</property>.</emphasis></para>
-
- <para>In case you need to connect to an application which has not used the "standard" JMX URL
- (e.g. Eclipse Equinox), you need chose more advance way, where it's necessary to specify
- explicitly a JMX URL in the Advanced tab of the JMX Connection window.</para>
-
- <note>
- <title>Note</title>
- <para>Only JMX URL based on RMI are supported.</para>
- </note>
- </section>
-</chapter>
-
-
-<chapter id="how_to" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/jmx/docs/reference/en/modules/how_to.xml" xreflabel="how_to">
- <?dbhtml filename="how_to.html"?>
- <title>How to ...</title>
- <para>This chapter will give you answers on most popular questions asked by <property moreinfo="none">JMX
- plugin</property> users.</para>
-
- <section>
- <title>How to Manage Tomcat</title>
-
- <para>It's possible to manage Tomcat using <property moreinfo="none">JMX Tools</property>.</para>
-
- <para>Currently, JMX Tooling is able to connect to Tomcat without authentication or with
- password-based authentication.</para>
- <para>Using SSL for authentication is not supported: you need to make sure that the System
- property <emphasis>
- <property moreinfo="none">com.sun.management.jmxremote.ssl</property>
- </emphasis> is set to false. </para>
- <para>More information to manage Tomcat can be found in Tomcat management
- documentation.</para>
- <para>Instructions to manage remotely Tomcat are available in Tomcat's monitoring
- documentation.</para>
-
- </section>
-
- <section>
- <title>How to manage Eclipse Equinox</title>
-
- <para>You can manage Equinox through the Equinox monitoring framework.</para>
- <para>Once you have installed the Equinox monitoring framework and restarted Eclipse:</para>
-
- <itemizedlist>
- <listitem>
- <para>Go to <emphasis>
- <property moreinfo="none">Window > Open Perspective > Other</property>
- </emphasis> and select the <property moreinfo="none">JMX perspective</property></para>
- </listitem>
-
- <listitem>
- <para>Select <emphasis>
- <property moreinfo="none">JMX Server > Open Connection</property>
- </emphasis> and click on <emphasis>
- <property moreinfo="none">OK</property>
- </emphasis></para>
- </listitem>
-
- <listitem>
- <para>Switch to the <property moreinfo="none">MBean Explorer</property> by going to <emphasis>
- <property moreinfo="none">Window > Show View > Other</property>
- </emphasis> and selecting the MBean Explorer</para>
- </listitem>
-
- <listitem>
- <para>Click on the <emphasis>
- <property moreinfo="none">New Connection</property></emphasis> icon
-
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/new_connection_icon.png"></imagedata>
- </imageobject>
- </inlinemediaobject>
-
- in the <property moreinfo="none">MBean Explorer</property> menu
- bar </para>
- </listitem>
-
- <listitem>
- <para>Select the <emphasis>
- <property moreinfo="none">Advanced tab</property></emphasis> and set the JMX URL to <emphasis>
- <property moreinfo="none">service:jmx:rmi:///jndi/rmi://:8118/jmxserver</property>
- </emphasis></para>
- </listitem>
- </itemizedlist>
-
- <para>You now have access to the MBeans exposed by Equinox.</para>
- </section>
-
-
- <section>
- <title>Managing JBoss Instances</title>
-
- <para>Managing JBoss instances is not supported with the <property moreinfo="none">JMX Tools</property>
- alone. You must also download and install the <property moreinfo="none">AS Tools</property> portion of
- the <property moreinfo="none">JBoss Tools</property> distribution. Even after installing the proper
- tooling, you cannot create a JBoss JMX connection yourself or through the Connection
- Wizard. The first step is to create a JBoss Server. The full instructions for this can
- be found in the AS Tools section, however, the short summary is: </para>
- <itemizedlist>
- <listitem>
- <para>Open the <property moreinfo="none">JBoss Servers View</property> or the <property moreinfo="none">Servers
- View</property></para>
- </listitem>
-
- <listitem>
- <para>Right-click in the view and select <emphasis>
- <property moreinfo="none">New > Server</property>
- </emphasis></para>
- </listitem>
-
- <listitem>
- <para>In the <emphasis>
- <property moreinfo="none">JBoss Community</property>
- </emphasis> section, select a server version</para>
- </listitem>
-
- <listitem>
- <para>If a runtime has not yet been created, you'll be prompted for the
- server's home directory, JDK, and configuration</para>
- </listitem>
-
- <listitem>
- <para>Finish the wizard and note that you have a new entry in both the
- <property moreinfo="none">JBoss Server View</property> and the <property moreinfo="none">MBean
- Explorer</property></para>
- </listitem>
-
- <listitem>
- <para>Start the server by right-clicking it and selecting <emphasis>
- <property moreinfo="none">Start</property></emphasis></para>
- </listitem>
- <listitem>
- <para>Note that once the server is started, the JMX connection can be
- expanded</para>
- </listitem>
- </itemizedlist>
-
- <para>Now you can explore MBeans exposed by a JBoss instance.</para>
- </section>
-
-</chapter>
-
-
-<chapter id="extensions" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/jmx/docs/reference/en/modules/extensions.xml" xreflabel="extensions">
- <?dbhtml filename="extensions"?>
- <title>Extension API</title>
- <para>This chapter will outline how to contribute your own Server type with some default
- behavior.</para>
-
- <section>
- <title>Why??</title>
-
- <para>You might be asking yourself why you'd need to extend this framework if JMX is
- a standard. Perhaps you want a connection to be automatically created after some specific
- action, or perhaps you want your connection wizard to do more than simply set a host and
- port. JBoss, for example, requires setting some credentials on the client machine, but
- using JBoss classes to do it. This requires that the connection have access to JBoss
- jars.</para>
- </section>
-
- <section>
- <title>Core Extensions</title>
-
- <para>To create your own JMX Connection type, you must use the
- org.jboss.tools.jmx.core.MBeanServerConnectionProvider extension point. This point takes
- one child, a connectionProvider with a class that implements
- org.jboss.tools.jmx.core.IConnectionProvider.</para>
-
- <para>An IConnectionProvider is responsible for creation and deletion of IConnectionWrapper
- objects. It must also keep a list of listeners that it is expected to inform when a
- connection is added or removed from its list. </para>
-
- <para>Each IConnectionWrapper is expected to handle running arbitrary JMX runnables or getting
- a "Root" object representing all JMX nodes. There are some utility methods the
- IConnectionWrapper can make use of.</para>
- </section>
-
-
- <section>
- <title>UI Extensions</title>
- <para>There are two extension points currently approved for use in the UI</para>
- <itemizedlist>
- <listitem>
- <para>org.jboss.tools.jmx.ui.providerUI - provide an icon, id, displayable name, and
- wizardPage class for creation of new connections</para>
- </listitem>
- <listitem>
- <para>org.jboss.tools.jmx.ui.attribute.controls - allows you to map class types to some
- Control to present them in the MBean Editor</para>
- <para>We hope, this guide helped you to get started with the JBoss JMX Tools. Besides, for additional information you are welcome on <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para>
- </listitem>
- </itemizedlist>
- </section>
-
-</chapter>
-
-</book>
+]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+ <title>JMX Tools Reference Guide</title>
+
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata>
+ </imageobject>
+ <imageobject role="html">
+ <imagedata></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </corpauthor>
+
+ <copyright>
+ <year>2007</year>
+ <year><diffmk:wrapper diffmk:change="added">2008</diffmk:wrapper></year>
+ <year diffmk:change="added">2009</year>
+ <year diffmk:change="added"><diffmk:wrapper diffmk:change="added">2010</diffmk:wrapper></year>
+ <holder>JBoss by Red Hat</holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ Version: 1.1.0.CR2
+ </diffmk:wrapper></releaseinfo>
+<abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jmx_ref_guide/pdf/JM...">PDF version</ulink>
+ </para>
+</abstract>
+ </bookinfo>
+
+ <toc></toc>
+
+<chapter id="intruduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jmx/docs/reference/en/modules/introduction.xml" xreflabel="introduction">
+ <?dbhtml filename="introduction.html"?>
+
+ <title>Introduction</title>
+ <para diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">' JMX project is a fork of </diffmk:wrapper><ulink diffmk:change="added" url="http://code.google.com/p/eclipse-jmx/"><diffmk:wrapper diffmk:change="added">eclipse-jmx</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">, a project by Jeff Mesnil.
+ It was forked with permission. </diffmk:wrapper></para>
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">What is JMX Tools?</diffmk:wrapper></title>
+ <para><property moreinfo="none">JMX Tools</property> allows to setup multiple JMX connections and provides view
+ for exploring the JMX tree and execute operations directly from Eclipse.</para>
+
+ <para>This chapter covers the basics of working with <property moreinfo="none">JMX plugin</property>, which is
+ used to manage Java applications through JMX and its RMI Connector.</para>
+
+ <figure float="0">
+ <title>JMX Tools</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/eclipse-jmx_0.2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section><title>Key Features of JMX Tools</title>
+ <para>For a start, we propose you to look through the table of main features of JMX Tools:</para>
+ <table>
+
+ <title>Key Functionality for JMX Tools</title>
+ <tgroup cols="3">
+
+ <colspec align="left" colnum="1" colwidth="2*"></colspec>
+ <colspec colnum="2" colwidth="4*"></colspec>
+ <colspec align="left" colnum="3" colwidth="2*"></colspec>
+
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+ <entry>Chapter</entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry><para>MBean Explorer</para></entry>
+ <entry><para>MBean Explorer is a useful view with a text filter that displays domains, mbeans, attributes, and operations inside a connection.</para></entry>
+ <entry>
+ <link linkend="mbean_explorer">MBean Explorer</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry><para>MBean Editor</para></entry>
+ <entry><para>MBean Editor is a multi-page editor to manage MBeans.</para></entry>
+ <entry>
+ <link linkend="mbean_editor">MBean Editor</link>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Requirements and Installation</diffmk:wrapper></title>
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added"> Requirements</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Requirements to use </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JMX Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> are the following:</diffmk:wrapper></para>
+
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JMX Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is developed on Eclipse 3.4.x milestones</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JMX Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> requires that Eclipse is run on a JDK 1.5.0 or above
+ (due to dependencies on JMX packages which were introduced in Java 1.5.0)</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section>
+ <title>Installation</title>
+ <para>Here, we are going to explain how to install the <property moreinfo="none">JMX plugin</property> into
+ Eclipse.</para>
+
+ <para><property moreinfo="none">JMX Tools</property> is one module of the <property moreinfo="none">JBoss Tools</property>
+ project. <property moreinfo="none">JMX Tools</property> has no dependency on any other part of <property moreinfo="none">JBoss
+ Tools</property>, and can be downloaded standalone. Even though the <property moreinfo="none">JMX
+ Tools</property> have no dependencies, other plugins, such as <property moreinfo="none">AS Tools</property>,
+ do depend on the JMX Tooling and even extend it. </para>
+
+ <para>You can find the <property moreinfo="none">JBoss Tools</property> plugins over at the <ulink url="http://labs.jboss.com/tools/download.html">download pages</ulink>. The only
+ package you'll need to get is the JMX Tooling, however the <property moreinfo="none">AS
+ Tools</property> would give you a more full experience when using JMX with JBoss Servers.
+ You can find further download and installation instructions on the JBoss Wiki in the <ulink url="http://labs.jboss.com/wiki/InstallingJBossTools">InstallingJBossTools</ulink>
+ section.</para>
+ </section>
+ </section>
+</chapter>
+
+
+<chapter diffmk:change="added" id="tasks" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jmx/docs/reference/en/modules/tasks.xml" xreflabel="tasks">
+ <?dbhtml filename="tasks.html"?>
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">JMX Tools Tasks</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">This chapter will give you answers on most popular questions asked by </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JMX
+ plugin</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> users.</diffmk:wrapper></para>
+ <section diffmk:change="added">
+ <title>Quick Start</title>
+
+ <para>To start using the <property moreinfo="none">JMX Tools</property><diffmk:wrapper diffmk:change="changed">, it's necessary to open
+ </diffmk:wrapper><property moreinfo="none">MBean Explorer</property>. Go to <emphasis><property moreinfo="none">Window > Show View > Other</property></emphasis><diffmk:wrapper diffmk:change="changed"> and then select
+ </diffmk:wrapper><property moreinfo="none">MBean Explorer</property> and click <emphasis><property moreinfo="none">OK</property>.</emphasis></para>
+
+ <para>The <property moreinfo="none">MBean Explorer</property><diffmk:wrapper diffmk:change="changed"> lists all of the domains, mbeans, attributes, and operations inside a
+ connection. When you double-click on a MBean in the </diffmk:wrapper><emphasis><property moreinfo="none">MBean Explorer</property>,</emphasis><diffmk:wrapper diffmk:change="changed"> it opens a multi-page
+ editor to manage the MBean. The </diffmk:wrapper><property moreinfo="none">MBean Editor</property> is composed of these pages:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><emphasis><property moreinfo="none">Attributes page</property>,</emphasis> to get/set the attributes of the MBean</para>
+ </listitem>
+ <listitem>
+ <para><emphasis><property moreinfo="none">Operations page</property>,</emphasis> to invoke operations on the MBean</para>
+ </listitem>
+ <listitem>
+ <para><emphasis><property moreinfo="none">Notifications page</property>,</emphasis> to receive notifications from the MBean</para>
+ </listitem>
+ <listitem>
+ <para><emphasis><property moreinfo="none">Info page</property>,</emphasis> which displays general information about the MBean </para>
+ </listitem>
+ </itemizedlist>
+
+ </section>
+ <section>
+ <title><diffmk:wrapper diffmk:change="changed">Tomcat Managing</diffmk:wrapper></title>
+
+ <para><diffmk:wrapper diffmk:change="added">It's possible to manage Tomcat using </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JMX Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+
+ <para><diffmk:wrapper diffmk:change="added">Currently, JMX Tooling is able to connect to Tomcat without authentication or with
+ password-based authentication.</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="added">Using SSL for authentication is not supported: you need to make sure that the System
+ property </diffmk:wrapper><emphasis diffmk:change="added">
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">com.sun.management.jmxremote.ssl</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> is set to false. </diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">More information to manage Tomcat can be found in Tomcat management
+ documentation.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Instructions to manage remotely Tomcat are available in Tomcat's monitoring
+ documentation.</diffmk:wrapper></para>
+
+ </section>
+
+ <section diffmk:change="added">
+ <title><diffmk:wrapper diffmk:change="changed">Eclipse Equinox Managing</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can manage Equinox through the Equinox monitoring framework.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Once you have installed the Equinox monitoring framework and restarted Eclipse:</diffmk:wrapper></para>
+
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="added">Go to </diffmk:wrapper><emphasis diffmk:change="added">
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Window > Open Perspective > Other</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> and select the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JMX perspective</diffmk:wrapper></property></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Select </diffmk:wrapper><emphasis diffmk:change="added">
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JMX Server > Open Connection</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> and click on </diffmk:wrapper><emphasis diffmk:change="added">
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">OK</diffmk:wrapper></property>
+ </emphasis></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">Switch to the </diffmk:wrapper><property moreinfo="none">MBean Explorer</property><diffmk:wrapper diffmk:change="added"> by going to </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Window > Show View > Other</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> and selecting the MBean Explorer</diffmk:wrapper></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">Click on the </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">New Connection</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> icon
+
+ </diffmk:wrapper><inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/new_connection_icon.png"/>
+ </imageobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="changed">
+
+ in the </diffmk:wrapper><property moreinfo="none">MBean Explorer</property><diffmk:wrapper diffmk:change="changed"> menu
+ bar </diffmk:wrapper></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Select the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Advanced tab</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and set the JMX URL to </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">service:jmx:rmi:///jndi/rmi://:8118/jmxserver</diffmk:wrapper></property>
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You now have access to the MBeans exposed by Equinox.</diffmk:wrapper></para>
+ </section>
+
+
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Managing JBoss Instances</diffmk:wrapper></title>
+
+ <para><diffmk:wrapper diffmk:change="changed">Managing JBoss instances is not supported with the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JMX Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">
+ alone. You must also download and install the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">AS Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> portion of
+ the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> distribution. Even after installing the proper
+ tooling, you cannot create a JBoss JMX connection yourself or through the Connection
+ Wizard. The first step is to create a JBoss Server. The full instructions for this can
+ be found in the AS Tools section, however, the short summary is: </diffmk:wrapper></para>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Open the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss Servers View</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> or the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Servers
+ View</diffmk:wrapper></property></para>
+ </listitem>
+
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="changed">Right-click in the view and select </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">New > Server</diffmk:wrapper></property>
+ </emphasis></para>
+ </listitem>
+
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="changed">In the </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss Community</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> section, select a server version</diffmk:wrapper></para>
+ </listitem>
+
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="added">If a runtime has not yet been created, you'll be prompted for the
+ server's home directory, JDK, and configuration</diffmk:wrapper></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Finish the wizard and note that you have a new entry in both the
+ </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss Server View</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean
+ Explorer</diffmk:wrapper></property></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="added">Start the server by right-clicking it and selecting </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Start</diffmk:wrapper></property></emphasis></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note that once the server is started, the JMX connection can be
+ expanded</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Now you can explore MBeans exposed by a JBoss instance.</diffmk:wrapper></para>
+ </section>
+ <section diffmk:change="added" id="extensions" xreflabel="extensions">
+ <title><diffmk:wrapper diffmk:change="changed">Extension Task</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">This section will outline how to contribute your own Server type with some default
+ behavior.</diffmk:wrapper></para>
+
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Why we should do that?</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You might be asking yourself why you'd need to extend this framework if JMX is
+ a standard. Perhaps you want a connection to be automatically created after some specific
+ action, or perhaps you want your connection wizard to do more than simply set a host and
+ port. JBoss, for example, requires setting some credentials on the client machine, but
+ using JBoss classes to do it. This requires that the connection have access to JBoss
+ jars.</diffmk:wrapper></para>
+ </section>
+
+ <section>
+ <title><diffmk:wrapper diffmk:change="changed">Core Extensions</diffmk:wrapper></title>
+
+ <para><diffmk:wrapper diffmk:change="added">To create your own JMX Connection type, you must use the
+ org.jboss.tools.jmx.core.MBeanServerConnectionProvider extension point. This point takes
+ one child, a connectionProvider with a class that implements
+ org.jboss.tools.jmx.core.IConnectionProvider.</diffmk:wrapper></para>
+
+ <para><diffmk:wrapper diffmk:change="changed">An IConnectionProvider is responsible for creation and deletion of IConnectionWrapper
+ objects. It must also keep a list of listeners that it is expected to inform when a
+ connection is added or removed from its list. </diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Each IConnectionWrapper is expected to handle running arbitrary JMX runnables or getting
+ a "Root" object representing all JMX nodes. There are some utility methods the
+ IConnectionWrapper can make use of.</diffmk:wrapper></para>
+ </section>
+
+ <section diffmk:change="added">
+ <title><diffmk:wrapper diffmk:change="changed">UI Extensions</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">There are two extension points currently approved for use in the UI</diffmk:wrapper></para>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">org.jboss.tools.jmx.ui.providerUI - provide an icon, id, displayable name, and
+ wizardPage class for creation of new connections</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="added">org.jboss.tools.jmx.ui.attribute.controls - allows you to map class types to some
+ Control to present them in the MBean Editor</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">We hope, this guide helped you to get started with the JBoss JMX Tools. Besides, for additional information you are welcome on </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">"><diffmk:wrapper diffmk:change="added">JBoss forum</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ </section>
+ <section diffmk:change="added" id="connection" xreflabel="connection">
+
+ <title><diffmk:wrapper diffmk:change="changed">Connections Creation Task</diffmk:wrapper></title>
+
+ <para>The <property moreinfo="none">MBean Explorer</property><diffmk:wrapper diffmk:change="changed"> supports several different types of connections.
+ The tooling itself comes only with a default connection type, however other
+ adopters can provide additional connection types that may require additional
+ or non-spec behavior. Connections can be in either the connected state or
+ the disconnected state. Some connection types (such as the default connection type)
+ allow you to control the current state. Other connection types may not. </diffmk:wrapper></para>
+
+ <para><diffmk:wrapper diffmk:change="changed">Similarly, some connection types may be able to be created, and others may not.
+ The default connection type, for example, can be created and deleted by you
+ at will. The AS Tools connection type, which represents a JBoss server, does not
+ allow you this level of control. A JBoss JMX connection is created when a JBoss server is created
+ in the server's view, and deleted when said server is deleted. The JMX connection for
+ this server is in the connected state only when the server is started. </diffmk:wrapper></para>
+
+
+ <section><title>The Default Connection</title>
+
+ <para> There are two ways to connect to an application with remote management enabled:</para>
+
+ <para><diffmk:wrapper diffmk:change="changed"> The first step is the same for both - to connect to a MBean Server, click on the
+ </diffmk:wrapper><emphasis>
+ <property moreinfo="none">New Connection</property></emphasis><diffmk:wrapper diffmk:change="changed"> icon
+
+ </diffmk:wrapper><inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/new_connection_icon.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="changed">
+
+ in the </diffmk:wrapper><property moreinfo="none">MBean Explorer</property> menu bar.</para>
+
+ <para><diffmk:wrapper diffmk:change="changed">Then to follow the simple one you just need to specify host, port (and optionally user
+ name and password) and click </diffmk:wrapper><emphasis>
+ <property moreinfo="none">OK</property>.</emphasis></para>
+
+ <para>The default JMX URL is <emphasis>
+ <property moreinfo="none">service:jmx:rmi:///jndi/rmi://localhost:3000/jmxrmi</property>.</emphasis></para>
+
+ <para><diffmk:wrapper diffmk:change="changed">In case you need to connect to an application which has not used the "standard" JMX URL
+ (e.g. Eclipse Equinox), you need chose more advance way, where it's necessary to specify
+ explicitly a JMX URL in the Advanced tab of the JMX Connection window.</diffmk:wrapper></para>
+
+ <note>
+ <title>Note</title>
+ <para>Only JMX URL based on RMI are supported.</para>
+ </note>
+ </section>
+ </section>
+</chapter>
+
+
+
+<chapter id="references" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jmx/docs/reference/en/modules/references.xml" xreflabel="references">
+ <?dbhtml filename="references.html"?>
+ <title><diffmk:wrapper diffmk:change="changed">References</diffmk:wrapper></title>
+
+ <section diffmk:change="added" id="mbean_explorer" xreflabel="mbean_explorer">
+ <?dbhtml filename="mbean_explorer.html"?>
+
+ <title><diffmk:wrapper diffmk:change="changed">MBean Explorer</diffmk:wrapper></title>
+ <para><diffmk:wrapper diffmk:change="changed">The </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> displays the MBean features (both attributes and operations) in its
+ hierarchy. Double-clicking on a feature will open a </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">MBean Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, display the page
+ corresponding to the feature type and select the feature.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title><diffmk:wrapper diffmk:change="changed">MBean Explorer Features</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/mbean-explorer-features.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="added">Since it's possible to have many MBean Editors opened at the same time, the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">
+ has the Link With Editor button
+
+ </diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/link-with-editor_0.2.0.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added">
+
+ to synchronize selections between the active </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">MBean Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and
+ the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> (and vice versa).</diffmk:wrapper></para>
+
+ <para><diffmk:wrapper diffmk:change="changed">The </diffmk:wrapper><property moreinfo="none">MBean Explorer</property><diffmk:wrapper diffmk:change="added"> has also a filter text that can be used to filter among all the MBeans
+ the few ones, which interest you.</diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For example, if you are only interested by MBeans related to memory, typing memo will show
+ any node (domain, mbean, attribute, or operation) that matches that text, as well as
+ that node's parents and children. So if an MBean matches, all attributes and operations from
+ that bean will show. If, however, an attribute or operation name (a leaf node) matches,
+ only that node and its parents in the tree will show.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Query Filter</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/mbean-explorer-query.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para><diffmk:wrapper diffmk:change="changed">The </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Collapse All</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> button
+
+ </diffmk:wrapper><inlinemediaobject>
+ <imageobject>
+ <imagedata diffmk:change="added" fileref="images/collaps_all.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="changed">
+
+ on the </diffmk:wrapper><property moreinfo="none">MBean Explorer</property><diffmk:wrapper diffmk:change="changed"> toolbar is used to collapse all the MBeans and
+ display only the domains. It is also possible to double click on a node to expand/collapse it. </diffmk:wrapper></para>
+
+ </section>
+ <section diffmk:change="added" id="mbean_editor" xreflabel="mbean_editor">
+ <?dbhtml filename="mbean_editor.html"?>
+
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">MBean Editor</diffmk:wrapper></title>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">MBean Editor Pages</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/mbean-editor_0.2.0.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">MBean Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> is composed of several pages:</diffmk:wrapper></para>
+
+ <itemizedlist>
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="added">the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Attributes</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> page</diffmk:wrapper></para>
+ </listitem>
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="changed">the </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Operations</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> page</diffmk:wrapper></para>
+ </listitem>
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="changed">the </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Notifications</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> page </diffmk:wrapper></para>
+ </listitem>
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="added">the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Info</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> page </diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+
+ <para><diffmk:wrapper diffmk:change="added"> The </diffmk:wrapper><emphasis diffmk:change="added">
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Attributes</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><emphasis diffmk:change="added">
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Operations</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> pages display a list for either the MBean attributes or operations as well as
+ details for the selection.</diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> It is possible to toggle the layout between the list and the details either vertically
+ (by default) or horizontally with the help of the special icons
+
+ </diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/mbean-editor-layout-buttons_0.2.0.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added">
+
+ in the right top corner of the editor.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">MBean Editor Horizontal Layout</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/mbean-editor-horizontal-layout_0.2.0.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure diffmk:change="added" float="0" id="figu-Beginners_Guide-Visual_Web_Tools-Visual_Page_Editor">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Visual Page Editor</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/mbean-editor-horizontal-layout_0.2.0.png" format="PNG" width="444"></imagedata>
+ </imageobject>
+ <textobject diffmk:change="added">
+ <phrase diffmk:change="added"><diffmk:wrapper diffmk:change="added">
+ The Visual Page Editor, showing both the source and a visual preview simultaneously.
+ </diffmk:wrapper></phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Notifications Page</diffmk:wrapper></title>
+ <para><diffmk:wrapper diffmk:change="added">One more page in the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Notifications</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> page, which gives the possibility to
+ subscribe (resp. unsubscribe) to a MBean to receive its notifications by checking (resp.
+ unchecking) the </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Subscribe</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> button in the right top corner. </diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">The list of notifications is refreshed every time a new notification is
+ received:</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title><diffmk:wrapper diffmk:change="changed">MBean Editor Notifications Page</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/notifications.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note diffmk:change="added">
+ <title><diffmk:wrapper diffmk:change="changed">Note</diffmk:wrapper></title>
+ <para><diffmk:wrapper diffmk:change="changed">It is only possible to subscribe to MBean, which emits notifications (they must be
+ NotificationBroadcaster).</diffmk:wrapper></para>
+ </note>
+
+ </section>
+
+ </section>
+
+ </chapter>
+
+
+<chapter diffmk:change="added" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jmx/docs/reference/en/modules/summary.xml">
+ <?dbhtml filename="summary.html"?>
+ <title><diffmk:wrapper diffmk:change="changed">Summary</diffmk:wrapper></title>
+ <para><diffmk:wrapper diffmk:change="changed">In conclusion, with this document you could easily start with JXM Tools.
+ The chapters above walked you through the steps on how to do Tomcat,Eclipse Equinox or JBoss Instances managing and how to create new JMX connections.
+ The document also includes the reference of JMX Tools features.
+
+ If you have questions or suggestions concerned both the documentation and tools behavior,
+ you are welcome to JBoss Tools Users forum.
+ Please, use Jira to report bugs and requests on documentation.</diffmk:wrapper></para>
+
+ <section>
+ <title><diffmk:wrapper diffmk:change="changed">Other relevant resources on the topic</diffmk:wrapper></title>
+ <para><diffmk:wrapper diffmk:change="added">All JBoss Developer Studio/JBoss Tools release documentation you can find at
+ </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/tools"><diffmk:wrapper diffmk:change="added">http://docs.jboss.org/tools</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> in the corresponding release directory.
+ </diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The latest documentation builds are available at </diffmk:wrapper><ulink diffmk:change="added" url="http://download.jboss.org/jbosstools/nightly-docs"><diffmk:wrapper diffmk:change="added">http://download.jboss.org/jbosstools/nightly-docs</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can find a set of benefits and other extra information on:</diffmk:wrapper></para>
+ <itemizedlist>
+ <listitem diffmk:change="added">
+ <para>
+ <ulink diffmk:change="added" url="http://www.jboss.org/community/wiki/JBossMX"><diffmk:wrapper diffmk:change="added">JBoss Wiki</diffmk:wrapper></ulink>
+ </para>
+ </listitem>
+ <listitem diffmk:change="added"><para><diffmk:wrapper diffmk:change="added">For more information about JMX technology please visit
+ </diffmk:wrapper><ulink diffmk:change="added" url="http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement/"><diffmk:wrapper diffmk:change="added">
+ JMX Technology Home Page</diffmk:wrapper></ulink></para>
+ </listitem>
+ </itemizedlist>
+ </section>
+</chapter>
+ <!--&connection;
+ &how_to;
+ &extensions;
+ &mbean_explorer;
+ &mbean_editor;-->
+
+</book>
Modified: trunk/jmx/docs/reference/en/modules/references.xml
===================================================================
--- trunk/jmx/docs/reference/en/modules/references.xml 2010-02-18 08:32:50 UTC (rev 20348)
+++ trunk/jmx/docs/reference/en/modules/references.xml 2010-02-18 08:42:54 UTC (rev 20349)
@@ -125,7 +125,19 @@
</imageobject>
</mediaobject>
</figure>
-
+ <figure id="figu-Beginners_Guide-Visual_Web_Tools-Visual_Page_Editor">
+ <title>Visual Page Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png" format="PNG" width="444" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ The Visual Page Editor, showing both the source and a visual preview simultaneously.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
<section>
<title>Notifications Page</title>
<para>One more page in the <property>MBean Editor</property> is the <emphasis>
14 years, 7 months
JBoss Tools SVN: r20348 - in trunk/seam/tests/org.jboss.tools.seam.ui.bot.test: src/org/jboss/tools/seam/ui/bot/test and 1 other directories.
by jbosstools-commits@lists.jboss.org
Author: vpakan(a)redhat.com
Date: 2010-02-18 03:32:50 -0500 (Thu, 18 Feb 2010)
New Revision: 20348
Modified:
trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/META-INF/MANIFEST.MF
trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/SeamAllBotTests.java
trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/TestControl.java
trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateActions.java
trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateConversations.java
trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateEntities.java
trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateForms.java
trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateSeamProjects.java
trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateSeamRuntimes.java
Log:
Fixes for Hudson
Modified: trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/META-INF/MANIFEST.MF
===================================================================
--- trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/META-INF/MANIFEST.MF 2010-02-18 08:23:56 UTC (rev 20347)
+++ trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/META-INF/MANIFEST.MF 2010-02-18 08:32:50 UTC (rev 20348)
@@ -13,7 +13,8 @@
org.eclipse.swtbot.eclipse.ui;bundle-version="2.0.0",
org.eclipse.swtbot.swt.finder;bundle-version="2.0.0",
org.apache.log4j;bundle-version="1.2.13",
- org.junit4;bundle-version="4.5.0"
+ org.junit4;bundle-version="4.5.0",
+ org.jboss.tools.ui.bot.ext;bundle-version="1.0.0"
Eclipse-RegisterBuddy: org.apache.log4j
Bundle-ActivationPolicy: lazy
Bundle-RequiredExecutionEnvironment: J2SE-1.5
Modified: trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/SeamAllBotTests.java
===================================================================
--- trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/SeamAllBotTests.java 2010-02-18 08:23:56 UTC (rev 20347)
+++ trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/SeamAllBotTests.java 2010-02-18 08:32:50 UTC (rev 20348)
@@ -6,6 +6,8 @@
import org.jboss.tools.seam.ui.bot.test.create.CreateActions;
import org.jboss.tools.seam.ui.bot.test.create.CreateConversations;
import org.jboss.tools.seam.ui.bot.test.create.CreateEntities;
+import org.jboss.tools.seam.ui.bot.test.create.CreateServerRuntimes;
+
import junit.framework.Test;
import junit.framework.TestSuite;
@@ -19,6 +21,7 @@
public class SeamAllBotTests {
public static Test suite(){
TestSuite suite = new TestSuite("Seam tests");
+ suite.addTestSuite(CreateServerRuntimes.class);
suite.addTestSuite(CreateSeamRuntimes.class);
suite.addTestSuite(CreateSeamProjects.class);
suite.addTestSuite(CreateForms.class);
Modified: trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/TestControl.java
===================================================================
--- trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/TestControl.java 2010-02-18 08:23:56 UTC (rev 20347)
+++ trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/TestControl.java 2010-02-18 08:32:50 UTC (rev 20348)
@@ -6,8 +6,11 @@
import org.eclipse.swtbot.swt.finder.SWTBot;
import org.eclipse.swtbot.swt.finder.waits.Conditions;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotShell;
+import org.eclipse.swtbot.swt.finder.widgets.SWTBotTable;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotTree;
import org.jboss.tools.test.TestProperties;
+import org.jboss.tools.ui.bot.ext.types.IDELabel;
+import org.jboss.tools.ui.bot.ext.types.IDELabel.PreferencesDialog;
import org.jboss.tools.ui.bot.test.JBTSWTBotTestCase;
import org.jboss.tools.ui.bot.test.WidgetVariables;
@@ -19,33 +22,26 @@
protected static Properties jbossEAPRuntime;
protected static Properties seam12Settings;
protected static Properties seam2fpSettings;
- protected static Properties seam21Settings;
+ protected static Properties seam22Settings;
private static final String PROJECT_PROPERTIES = "projectProperties.properties";
private static final String EAP_RUNTIME = "jbossEAPRuntime.properties";
private static final String SEAM_SET_12 = "seam12Settings.properties";
private static final String SEAM_SET_2FP = "seam2fpSettings.properties";
- private static final String SEAM_SET_21 = "seam21Settings.properties";
+ private static final String SEAM_SET_22 = "seam22Settings.properties";
protected static final String VALIDATION = "Validation";
protected static final String DEPLOY_SOURCE = "Deploying datasource to server";
protected static final String REG_IN_SERVER = "Register in server";
public static String JBOSS_EAP_HOME;
public static String SEAM_12_SETTINGS_HOME;
- public static String SEAM_21_SETTINGS_HOME;
+ public static String SEAM_22_SETTINGS_HOME;
public static String SEAM_2FP_SETTINGS_HOME;
- public static final String[] SUBSTITUTE_PROPERTIES = {
- "jbosstools.test.jboss.home",
- "jbosstools.test.seam.1.2.1.eap.home",
- "jbosstools.test.seam.2.1.0.GA.home",
- "jbosstools.test.seam.2fp.eap.home"
- };
-
static {
-// System.setProperty("jbosstools.test.seam.1.2.1.eap.home", "C:/jbdevstudio0609/jboss-eap/seam");
-// System.setProperty("jbosstools.test.seam.2fp.eap.home", "C:/jbdevstudio0609/jboss-eap/seamfp");
-// System.setProperty("jbosstools.test.seam.2.1.0.GA.home", "C:/jbdevstudio0609/jboss-eap/jboss-seam-2.1.1.GA");
+
+ Properties vmArgsProps = TestControl.parseEclipseVMArgs();
+
try {
InputStream is = TestControl.class.getResourceAsStream("/" + PROJECT_PROPERTIES);
projectProperties = new TestProperties();
@@ -60,7 +56,8 @@
InputStream is = TestControl.class.getResourceAsStream("/" + EAP_RUNTIME);
jbossEAPRuntime = new TestProperties();
jbossEAPRuntime.load(is);
- } catch (IOException e) {
+ TestControl.overrideValueFromSystemProperty(jbossEAPRuntime,"runtimePath","-Djboss.tools.test.jboss.home",vmArgsProps);
+ } catch (IOException e) {
fail("Can't load properties from " + EAP_RUNTIME + " file");
}
catch (IllegalStateException e) {
@@ -70,6 +67,7 @@
InputStream is = TestControl.class.getResourceAsStream("/" + SEAM_SET_12);
seam12Settings = new TestProperties();
seam12Settings.load(is);
+ TestControl.overrideValueFromSystemProperty(seam12Settings,"seamRuntimePath","-Djboss.tools.test.seam.1.2.1.eap.home",vmArgsProps);
} catch (IOException e) {
fail("Can't load properties from " + SEAM_SET_12 + " file");
}
@@ -80,6 +78,7 @@
InputStream is = TestControl.class.getResourceAsStream("/" + SEAM_SET_2FP);
seam2fpSettings = new TestProperties();
seam2fpSettings.load(is);
+ TestControl.overrideValueFromSystemProperty(seam2fpSettings,"seamRuntimePath","-Djboss.tools.test.seam.2fp.eap.home",vmArgsProps);
} catch (IOException e) {
fail("Can't load properties from " + SEAM_SET_2FP + " file");
}
@@ -87,24 +86,21 @@
fail("Property file " + SEAM_SET_2FP + " was not found");
}
try {
- InputStream is = TestControl.class.getResourceAsStream("/" + SEAM_SET_21);
- seam21Settings = new TestProperties();
- seam21Settings.load(is);
+ InputStream is = TestControl.class.getResourceAsStream("/" + SEAM_SET_22);
+ seam22Settings = new TestProperties();
+ seam22Settings.load(is);
+ TestControl.overrideValueFromSystemProperty(seam22Settings,"seamRuntimePath","-Djboss.tools.test.seam.2.2.0.eap.home",vmArgsProps);
} catch (IOException e) {
- fail("Can't load properties from " + SEAM_SET_21 + " file");
+ fail("Can't load properties from " + SEAM_SET_22 + " file");
}
catch (IllegalStateException e) {
- fail("Property file " + SEAM_SET_21 + " was not found");
+ fail("Property file " + SEAM_SET_22 + " was not found");
}
JBOSS_EAP_HOME = jbossEAPRuntime.getProperty("runtimePath");
SEAM_12_SETTINGS_HOME = seam12Settings.getProperty("seamRuntimePath");
- SEAM_21_SETTINGS_HOME = seam21Settings.getProperty("seamRuntimePath");
- SEAM_2FP_SETTINGS_HOME = seam2fpSettings.getProperty("seamRuntimePath");
+ SEAM_22_SETTINGS_HOME = seam22Settings.getProperty("seamRuntimePath");
+ SEAM_2FP_SETTINGS_HOME = seam2fpSettings.getProperty("seamRuntimePath");
}
-
-
-
-
/*Pre-launch operations here:*/
@Override
@@ -134,17 +130,40 @@
/**Creates any Server Runtime + Server. */
protected void createServerRuntime(Properties serverType){
- bot.menu("File").menu("New").menu("Other...").click();
- SWTBotTree tree = bot.tree();
- tree.expandNode("Server").select("Server");
- bot.button("Next >").click();
- SWTBotTree tree2 = bot.tree();
- tree2.expandNode(serverType.getProperty("runtimeGroup")).select(serverType.getProperty("runtimeItem"));
- bot.textWithLabel("Server name:").setText(serverType.getProperty("serverName"));
- bot.button("Next >").click();
- bot.textWithLabel("Name").setText(serverType.getProperty("runtimeName"));
- bot.textWithLabel("Home Directory").setText(serverType.getProperty("runtimePath"));
- bot.button("Finish").click();
+ // Check if server is not already defined
+ bot.menu(IDELabel.Menu.WINDOW).menu(IDELabel.Menu.PREFERENCES).click();
+ bot.shell(IDELabel.Shell.PREFERENCES).activate();
+ bot.tree().expandNode(IDELabel.PreferencesDialog.SERVER_GROUP).select(
+ PreferencesDialog.RUNTIME_ENVIRONMENTS);
+ SWTBotTable tbRuntimeEnvironments = bot.table();
+ boolean createRuntime = true;
+ int numRows = tbRuntimeEnvironments.rowCount();
+ if (numRows > 0) {
+ int currentRow = 0;
+ while (createRuntime && currentRow < numRows) {
+ if (tbRuntimeEnvironments.cell(currentRow, 0).equalsIgnoreCase(
+ serverType.getProperty("runtimeName"))) {
+ createRuntime = false;
+ } else {
+ currentRow++;
+ }
+ }
+ }
+ bot.button(IDELabel.Button.OK).click();
+
+ if (createRuntime){
+ bot.menu("File").menu("New").menu("Other...").click();
+ SWTBotTree tree = bot.tree();
+ tree.expandNode("Server").select("Server");
+ bot.button("Next >").click();
+ SWTBotTree tree2 = bot.tree();
+ tree2.expandNode(serverType.getProperty("runtimeGroup")).select(serverType.getProperty("runtimeItem"));
+ bot.textWithLabel("Server name:").setText(serverType.getProperty("serverName"));
+ bot.button("Next >").click();
+ bot.textWithLabel("Name").setText(serverType.getProperty("runtimeName"));
+ bot.textWithLabel("Home Directory").setText(serverType.getProperty("runtimePath"));
+ bot.button("Finish").click();
+ }
}
/** Creates any Seam runtime. */
@@ -223,4 +242,43 @@
bot.sleep(1000);
}
}
+ /**
+ * Overrides propertyName property value within properties with value stored within vmargProperties with name vmargPropertyName
+ * @param properties
+ * @param propertyName
+ * @param vmargPropertyName
+ * @param vmargProperties
+ */
+ private static void overrideValueFromSystemProperty (Properties properties, String propertyName ,
+ String vmargPropertyName, Properties vmargProperties){
+
+ String vmargProperty = vmargProperties.getProperty(vmargPropertyName);
+ if (vmargProperty != null){
+ properties.setProperty(propertyName, vmargProperty);
+ }
+
+ }
+ /**
+ * Returns Properties which contains Virtual Machine arguments
+ * with name starting with "-D"
+ * @return
+ */
+ private static Properties parseEclipseVMArgs (){
+
+ Properties vmArgsProps = new Properties();
+
+ String vmArgs = System.getProperty("eclipse.vmargs");
+
+ if (vmArgs != null){
+ for (String line : vmArgs.split("\n")){
+ if (line.startsWith("-D")){
+ String[] splitLine = line.split("=");
+ vmArgsProps.setProperty(splitLine[0], splitLine[1]);
+ }
+ }
+ }
+
+ return vmArgsProps;
+
+ }
}
Modified: trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateActions.java
===================================================================
--- trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateActions.java 2010-02-18 08:23:56 UTC (rev 20347)
+++ trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateActions.java 2010-02-18 08:32:50 UTC (rev 20348)
@@ -10,7 +10,7 @@
createSeamUnit(TEST_TYPE, seam12Settings, TYPE_WAR);
}
-/* public void testCreateActionFor12ear(){
+ public void testCreateActionFor12ear(){
createSeamUnit(TEST_TYPE, seam12Settings, TYPE_EAR);
}
@@ -22,12 +22,12 @@
createSeamUnit(TEST_TYPE, seam2fpSettings, TYPE_EAR);
}
- public void testCreateActionFor21war(){
- createSeamUnit(TEST_TYPE, seam21Settings, TYPE_WAR);
+ public void testCreateActionFor22war(){
+ createSeamUnit(TEST_TYPE, seam22Settings, TYPE_WAR);
}
- public void testCreateActionFor21ear(){
- createSeamUnit(TEST_TYPE, seam21Settings, TYPE_EAR);
- }*/
+ public void testCreateActionFor22ear(){
+ createSeamUnit(TEST_TYPE, seam22Settings, TYPE_EAR);
+ }
}
\ No newline at end of file
Modified: trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateConversations.java
===================================================================
--- trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateConversations.java 2010-02-18 08:23:56 UTC (rev 20347)
+++ trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateConversations.java 2010-02-18 08:32:50 UTC (rev 20348)
@@ -10,7 +10,7 @@
createSeamUnit(TEST_TYPE, seam12Settings, TYPE_WAR);
}
-/* public void testCreateConversationFor12ear(){
+ public void testCreateConversationFor12ear(){
createSeamUnit(TEST_TYPE, seam12Settings, TYPE_EAR);
}
@@ -22,12 +22,12 @@
createSeamUnit(TEST_TYPE, seam2fpSettings, TYPE_EAR);
}
- public void testCreateConversationFor21war(){
- createSeamUnit(TEST_TYPE, seam21Settings, TYPE_WAR);
+ public void testCreateConversationFor22war(){
+ createSeamUnit(TEST_TYPE, seam22Settings, TYPE_WAR);
}
- public void testCreateConversationFor21ear(){
- createSeamUnit(TEST_TYPE, seam21Settings, TYPE_EAR);
- }*/
+ public void testCreateConversationFor22ear(){
+ createSeamUnit(TEST_TYPE, seam22Settings, TYPE_EAR);
+ }
}
\ No newline at end of file
Modified: trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateEntities.java
===================================================================
--- trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateEntities.java 2010-02-18 08:23:56 UTC (rev 20347)
+++ trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateEntities.java 2010-02-18 08:32:50 UTC (rev 20348)
@@ -1,5 +1,7 @@
package org.jboss.tools.seam.ui.bot.test.create;
+import java.io.IOException;
+
import org.jboss.tools.seam.ui.bot.test.TestControl;
public class CreateEntities extends TestControl{
@@ -10,29 +12,32 @@
createSeamUnit(TEST_TYPE, seam12Settings, TYPE_WAR);
}
-/* public void testCreateEntityFor12ear(){
+ public void testCreateEntityFor12ear(){
createSeamUnit(TEST_TYPE, seam12Settings, TYPE_EAR);
- waitForJobs();
}
public void testCreateEntityFor2fpwar(){
createSeamUnit(TEST_TYPE, seam2fpSettings, TYPE_WAR);
- waitForJobs();
}
public void testCreateEntityFor2fpear(){
createSeamUnit(TEST_TYPE, seam2fpSettings, TYPE_EAR);
- waitForJobs();
}
- public void testCreateEntityFor21war(){
- createSeamUnit(TEST_TYPE, seam21Settings, TYPE_WAR);
- waitForJobs();
+ public void testCreateEntityFor22war(){
+ createSeamUnit(TEST_TYPE, seam22Settings, TYPE_WAR);
}
- public void testCreateEntityFor21ear(){
- createSeamUnit(TEST_TYPE, seam21Settings, TYPE_EAR);
- waitForJobs();
- }*/
+ public void testCreateEntityFor22ear(){
+ createSeamUnit(TEST_TYPE, seam22Settings, TYPE_EAR);
+ // TODO: Remove it
+ try {
+ System.in.read();
+ } catch (IOException e) {
+ // TODO Auto-generated catch block
+ e.printStackTrace();
+ }
+ }
+
}
\ No newline at end of file
Modified: trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateForms.java
===================================================================
--- trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateForms.java 2010-02-18 08:23:56 UTC (rev 20347)
+++ trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateForms.java 2010-02-18 08:32:50 UTC (rev 20348)
@@ -10,7 +10,7 @@
createSeamUnit(TEST_TYPE, seam12Settings, TYPE_WAR);
}
-/* public void testCreateFormFor12ear(){
+ public void testCreateFormFor12ear(){
createSeamUnit(TEST_TYPE, seam12Settings, TYPE_EAR);
}
@@ -22,12 +22,12 @@
createSeamUnit(TEST_TYPE, seam2fpSettings, TYPE_EAR);
}
- public void testCreateFormFor21war(){
- createSeamUnit(TEST_TYPE, seam21Settings, TYPE_WAR);
+ public void testCreateFormFor22war(){
+ createSeamUnit(TEST_TYPE, seam22Settings, TYPE_WAR);
}
- public void testCreateFormFor21ear(){
- createSeamUnit(TEST_TYPE, seam21Settings, TYPE_EAR);
- }*/
+ public void testCreateFormFor22ear(){
+ createSeamUnit(TEST_TYPE, seam22Settings, TYPE_EAR);
+ }
}
\ No newline at end of file
Modified: trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateSeamProjects.java
===================================================================
--- trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateSeamProjects.java 2010-02-18 08:23:56 UTC (rev 20347)
+++ trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateSeamProjects.java 2010-02-18 08:32:50 UTC (rev 20348)
@@ -6,43 +6,43 @@
public void testCreateSeamProject12war(){
createSeamProject(seam12Settings, jbossEAPRuntime, TYPE_WAR);
- waitForBlockingJobsAcomplished(180000, BUILDING_WS, VALIDATION +
+ waitForBlockingJobsAcomplished(240000, BUILDING_WS, VALIDATION +
" " + seam12Settings.getProperty("testProjectName")
+TYPE_WAR, DEPLOY_SOURCE, REG_IN_SERVER);
}
public void testCreateSeamProject12ear(){
createSeamProject(seam12Settings, jbossEAPRuntime, TYPE_EAR);
- waitForBlockingJobsAcomplished(180000, BUILDING_WS, VALIDATION +
+ waitForBlockingJobsAcomplished(240000, BUILDING_WS, VALIDATION +
" " + seam12Settings.getProperty("testProjectName")
+TYPE_EAR, DEPLOY_SOURCE, REG_IN_SERVER);
}
public void testCreateSeamProject2fpwar(){
createSeamProject(seam2fpSettings, jbossEAPRuntime, TYPE_WAR);
- waitForBlockingJobsAcomplished(180000, BUILDING_WS, VALIDATION +
+ waitForBlockingJobsAcomplished(240000, BUILDING_WS, VALIDATION +
" " + seam2fpSettings.getProperty("testProjectName")
+TYPE_WAR, DEPLOY_SOURCE, REG_IN_SERVER);
}
public void testCreateSeamProject2fpear(){
createSeamProject(seam2fpSettings, jbossEAPRuntime, TYPE_EAR);
- waitForBlockingJobsAcomplished(180000, BUILDING_WS, VALIDATION +
+ waitForBlockingJobsAcomplished(240000, BUILDING_WS, VALIDATION +
" " + seam2fpSettings.getProperty("testProjectName")
+TYPE_EAR, DEPLOY_SOURCE, REG_IN_SERVER);
}
- public void testCreateSeamProject21war(){
- createSeamProject(seam21Settings, jbossEAPRuntime, TYPE_WAR);
- waitForBlockingJobsAcomplished(180000, BUILDING_WS, VALIDATION +
- " " + seam21Settings.getProperty("testProjectName")
+ public void testCreateSeamProject22war(){
+ createSeamProject(seam22Settings, jbossEAPRuntime, TYPE_WAR);
+ waitForBlockingJobsAcomplished(240000, BUILDING_WS, VALIDATION +
+ " " + seam22Settings.getProperty("testProjectName")
+TYPE_WAR, DEPLOY_SOURCE, REG_IN_SERVER);
}
- public void testCreateSeamProject21ear(){
- createSeamProject(seam21Settings, jbossEAPRuntime, TYPE_EAR);
- waitForBlockingJobsAcomplished(180000, BUILDING_WS, VALIDATION +
- " " + seam21Settings.getProperty("testProjectName")
+ public void testCreateSeamProject22ear(){
+ createSeamProject(seam22Settings, jbossEAPRuntime, TYPE_EAR);
+ waitForBlockingJobsAcomplished(240000, BUILDING_WS, VALIDATION +
+ " " + seam22Settings.getProperty("testProjectName")
+TYPE_EAR, DEPLOY_SOURCE, REG_IN_SERVER);
}
Modified: trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateSeamRuntimes.java
===================================================================
--- trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateSeamRuntimes.java 2010-02-18 08:23:56 UTC (rev 20347)
+++ trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/create/CreateSeamRuntimes.java 2010-02-18 08:32:50 UTC (rev 20348)
@@ -12,7 +12,7 @@
createSeamRuntime(seam2fpSettings, SEAM_2FP_SETTINGS_HOME);
}
- public void testCreateSeamRuntime21(){
- createSeamRuntime(seam21Settings, SEAM_21_SETTINGS_HOME);
+ public void testCreateSeamRuntime22(){
+ createSeamRuntime(seam22Settings, SEAM_22_SETTINGS_HOME);
}
}
14 years, 7 months
JBoss Tools SVN: r20347 - trunk/vpe/tests/org.jboss.tools.vpe.ui.bot.test/src/org/jboss/tools/vpe/ui/bot/test/smoke.
by jbosstools-commits@lists.jboss.org
Author: vpakan(a)redhat.com
Date: 2010-02-18 03:23:56 -0500 (Thu, 18 Feb 2010)
New Revision: 20347
Modified:
trunk/vpe/tests/org.jboss.tools.vpe.ui.bot.test/src/org/jboss/tools/vpe/ui/bot/test/smoke/RenameXHTMLFileTest.java
Log:
Fix path to renamed XHTML page within Web Project tree view.
Modified: trunk/vpe/tests/org.jboss.tools.vpe.ui.bot.test/src/org/jboss/tools/vpe/ui/bot/test/smoke/RenameXHTMLFileTest.java
===================================================================
--- trunk/vpe/tests/org.jboss.tools.vpe.ui.bot.test/src/org/jboss/tools/vpe/ui/bot/test/smoke/RenameXHTMLFileTest.java 2010-02-18 04:46:00 UTC (rev 20346)
+++ trunk/vpe/tests/org.jboss.tools.vpe.ui.bot.test/src/org/jboss/tools/vpe/ui/bot/test/smoke/RenameXHTMLFileTest.java 2010-02-18 08:23:56 UTC (rev 20347)
@@ -37,7 +37,7 @@
}
/**
- * Check renaming of faces-config.xml file
+ * Check renaming of XHTML file
*/
private void checkRenameXHTMLFile() {
@@ -51,7 +51,7 @@
tree.setFocus();
String checkResult = FileRenameHelper.checkFileRenamingWithinWebProjects(bot,
XHTMLPageCreationTest.TEST_NEW_XHTML_FILE_NAME, NEW_XHTML_FILE_NAME,
- new String[] {JBT_TEST_PROJECT_NAME, IDELabel.WebProjectsTree.CONFIGURATION});
+ new String[] {JBT_TEST_PROJECT_NAME, IDELabel.WebProjectsTree.WEB_CONTENT});
assertNull(checkResult, checkResult);
}
14 years, 7 months
JBoss Tools SVN: r20346 - trunk/documentation/guides/JBDS_3.0_Release_Notes/en-US.
by jbosstools-commits@lists.jboss.org
Author: irooskov(a)redhat.com
Date: 2010-02-17 23:46:00 -0500 (Wed, 17 Feb 2010)
New Revision: 20346
Modified:
trunk/documentation/guides/JBDS_3.0_Release_Notes/en-US/Fixed_Issues.xml
Log:
updated with new JIRA
Modified: trunk/documentation/guides/JBDS_3.0_Release_Notes/en-US/Fixed_Issues.xml
===================================================================
--- trunk/documentation/guides/JBDS_3.0_Release_Notes/en-US/Fixed_Issues.xml 2010-02-18 00:25:47 UTC (rev 20345)
+++ trunk/documentation/guides/JBDS_3.0_Release_Notes/en-US/Fixed_Issues.xml 2010-02-18 04:46:00 UTC (rev 20346)
@@ -94,6 +94,11 @@
<ulink url="http://jira.jboss.com/jira/browse/JBIDE-4730">JBIDE-4730</ulink>: The ESB project creation wizard receives a new logo following this update. Instead of using the generic <application>JBoss Developer Studio</application> logo within the ESB project wizard, a new ESB wizard logo is displayed.
</para>
</listitem>
+ <listitem>
+ <para>
+ <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4168">JBIDE-4168</ulink>: The ability to select a directory using a browser window has been added for the FS Message Filter and the FTP Message filter attributes of <property>directory</property>, <property>post-directory</property> and <property>error-directory</property>. This added feature ensures that a user does not need to manually type the entire path to a directory but instead they just select the path from a browser.
+ </para>
+ </listitem>
</itemizedlist>
</para>
</formalpara>
@@ -193,6 +198,26 @@
<ulink url="http://jira.jboss.com/jira/browse/JBIDE-4715">JBIDE-4715</ulink>: A toggle button has been added to the Hibernate Mapping diagram to allow the outline view to be ordered either alphabetically or by the structure outlined in the file. The toggle button interface ensures the experience remains consistent across all tools included within the <application>JBoss Developer Studio</application>.
</para>
</listitem>
+ <listitem>
+ <para>
+ <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4666">JBIDE-4662</ulink>: Annotations support has been added to Hibernate Tools. The addittion of annotations support allows for interaction with the Eclipse Dali Java Persistence Tools Project plug-in.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4451">JBIDE-4451</ulink>: The option is now given to the user to enable the <guilabel>HQL Editor</guilabel> and <guilabel>Hibernate Criteria Editor</guilabel> to be dynamicly updated when opening a new query instead of opening an instance of each editor for each query. This can be achieved by clicking the button of a tack to the right of the <guilabel>Max resutls:</guilabel> drop-won box in the editor.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4450">JBIDE-4450</ulink>: The <guilabel>Properties</guilabel> view has been updated with a new property called <property>Tab name</property>. The addition of this property allows for a user to individually name each query tab, allowing for improved tab management.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4227">JBIDE-4227</ulink>: The <guimenuitem>Open Mapping File</guimenuitem> option now supports all possible configuration files. In the past only files called <filename>orm.xml</filename> have been supported and this update now provides increased user functionality.
+ </para>
+ </listitem>
</itemizedlist>
</para>
</formalpara>
@@ -481,6 +506,11 @@
<ulink url="http://jira.jboss.com/jira/browse/JBIDE-4914">JBIDE-4914</ulink>: The Visual Page Editor has been redesigned so that all drop-down menu items are placed in the toolbar as buttons.
</para>
</listitem>
+ <listitem>
+ <para>
+ <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4323">JBIDE-4323</ulink>: Zoom actions have been added to the visual context menu so that a user can now resize the content of the Visual Page Editor to make it easier to read and manage.
+ </para>
+ </listitem>
</itemizedlist>
</para>
</formalpara>
14 years, 7 months
JBoss Tools SVN: r20345 - in workspace: snjeza/seam-examples and 1 other directory.
by jbosstools-commits@lists.jboss.org
Author: snjeza
Date: 2010-02-17 19:25:47 -0500 (Wed, 17 Feb 2010)
New Revision: 20345
Modified:
workspace/examples/project-examples-3.1.xml
workspace/snjeza/seam-examples/dvdstore22.zip
Log:
https://jira.jboss.org/jira/browse/JBIDE-5856 No possibility to deploy seam examples datasource directly from JBT
Modified: workspace/examples/project-examples-3.1.xml
===================================================================
--- workspace/examples/project-examples-3.1.xml 2010-02-18 00:08:43 UTC (rev 20344)
+++ workspace/examples/project-examples-3.1.xml 2010-02-18 00:25:47 UTC (rev 20345)
@@ -191,6 +191,24 @@
<url>
http://anonsvn.jboss.org/repos/jbosstools/workspace/snjeza/seam-examples/...
</url>
+ <fixes>
+ <fix type="wtpruntime">
+ <property name="allowed-types">org.jboss.ide.eclipse.as.runtime.eap.50</property>
+ <property name="eclipse-projects">dvdstore22,dvdstore22-ejb,dvdstore22-ear</property>
+ <property name="description">This project example requires the JBoss EAP 5.0</property>
+ </fix>
+
+ <fix type="seam">
+ <property name="allowed-versions">2.2.0</property>
+ <property name="eclipse-projects">dvdstore22</property>
+ <property name="description">This project example requires Seam version 2.2.0</property>
+ </fix>
+ <fix type="plugin">
+ <property name="id">org.testng.eclipse</property>
+ <property name="versions">5.8.0, 5.9.0</property>
+ <property name="description">The TestNG plugin is required if you want to run Seam tests. You can install it using the following update site: http://beust.com/eclipse</property>
+ </fix>
+ </fixes>
</project>
<project>
Modified: workspace/snjeza/seam-examples/dvdstore22.zip
===================================================================
(Binary files differ)
14 years, 7 months
JBoss Tools SVN: r20344 - branches/jbosstools-3.1.0.RC2/struts/plugins/org.jboss.tools.struts.ui.
by jbosstools-commits@lists.jboss.org
Author: dgolovin
Date: 2010-02-17 19:08:43 -0500 (Wed, 17 Feb 2010)
New Revision: 20344
Modified:
branches/jbosstools-3.1.0.RC2/struts/plugins/org.jboss.tools.struts.ui/plugin.xml
Log:
https://jira.jboss.org/jira/browse/JBIDE-5469 Unable to Add JSF Capabilities
Verify action removed from popup menu and now available only in Web Projects View
Modified: branches/jbosstools-3.1.0.RC2/struts/plugins/org.jboss.tools.struts.ui/plugin.xml
===================================================================
--- branches/jbosstools-3.1.0.RC2/struts/plugins/org.jboss.tools.struts.ui/plugin.xml 2010-02-18 00:05:13 UTC (rev 20343)
+++ branches/jbosstools-3.1.0.RC2/struts/plugins/org.jboss.tools.struts.ui/plugin.xml 2010-02-18 00:08:43 UTC (rev 20344)
@@ -350,13 +350,13 @@
<separator name="d">
</separator>
</menu>
- <action
+ <!--action
class="org.jboss.tools.struts.ui.internal.action.VerifyActionDelegate"
enablesFor="*"
id="org.jboss.tools.common.xstudio.action.VerifyActionDelegate"
label="%popupMenus.action.verify"
menubarPath="RedHat4Web/b">
- </action>
+ </action-->
</objectContribution>
<objectContribution id="RedHatEclipse4Web_IJavaProject" objectClass="org.eclipse.jdt.core.IJavaProject">
<menu id="RedHat4Web" label="JBoss Tools" path="additions">
@@ -369,13 +369,13 @@
<separator name="d">
</separator>
</menu>
- <action
+ <!--action
class="org.jboss.tools.struts.ui.internal.action.VerifyActionDelegate"
enablesFor="*"
id="org.jboss.tools.common.xstudio.action.VerifyActionDelegate"
label="%popupMenus.action.verify"
menubarPath="RedHat4Web/b">
- </action>
+ </action-->
</objectContribution>
<!--objectContribution id="RedHatEclipse4Web_IFile" objectClass="org.eclipse.core.resources.IFile">
<menu id="RedHat4Web" label="JBoss Tools" path="additions">
14 years, 7 months
JBoss Tools SVN: r20343 - trunk/struts/plugins/org.jboss.tools.struts.ui.
by jbosstools-commits@lists.jboss.org
Author: dgolovin
Date: 2010-02-17 19:05:13 -0500 (Wed, 17 Feb 2010)
New Revision: 20343
Modified:
trunk/struts/plugins/org.jboss.tools.struts.ui/plugin.xml
Log:
https://jira.jboss.org/jira/browse/JBIDE-5469 Unable to Add JSF Capabilities
Verify action removed from popup menu and now available only in Web Projects View
Modified: trunk/struts/plugins/org.jboss.tools.struts.ui/plugin.xml
===================================================================
--- trunk/struts/plugins/org.jboss.tools.struts.ui/plugin.xml 2010-02-17 23:02:59 UTC (rev 20342)
+++ trunk/struts/plugins/org.jboss.tools.struts.ui/plugin.xml 2010-02-18 00:05:13 UTC (rev 20343)
@@ -350,13 +350,13 @@
<separator name="d">
</separator>
</menu>
- <action
+ <!--action
class="org.jboss.tools.struts.ui.internal.action.VerifyActionDelegate"
enablesFor="*"
id="org.jboss.tools.common.xstudio.action.VerifyActionDelegate"
label="%popupMenus.action.verify"
menubarPath="RedHat4Web/b">
- </action>
+ </action-->
</objectContribution>
<objectContribution id="RedHatEclipse4Web_IJavaProject" objectClass="org.eclipse.jdt.core.IJavaProject">
<menu id="RedHat4Web" label="JBoss Tools" path="additions">
@@ -369,13 +369,13 @@
<separator name="d">
</separator>
</menu>
- <action
+ <!--action
class="org.jboss.tools.struts.ui.internal.action.VerifyActionDelegate"
enablesFor="*"
id="org.jboss.tools.common.xstudio.action.VerifyActionDelegate"
label="%popupMenus.action.verify"
menubarPath="RedHat4Web/b">
- </action>
+ </action-->
</objectContribution>
<!--objectContribution id="RedHatEclipse4Web_IFile" objectClass="org.eclipse.core.resources.IFile">
<menu id="RedHat4Web" label="JBoss Tools" path="additions">
14 years, 7 months