[jbosstools-commits] JBoss Tools SVN: r6849 - in trunk/jsf/docs/userguide/en: images/jsf_support and 3 other directories.

Author: ykryvinchanka Date: 2008-03-11 11:27:28 -0400 (Tue, 11 Mar 2008) New Revision: 6849 Removed: trunk/jsf/docs/userguide/en/images/editors_features/editors_features_33.png trunk/jsf/docs/userguide/en/images/editors_features/editors_features_34.png trunk/jsf/docs/userguide/en/images/editors_features/editors_features_36.png trunk/jsf/docs/userguide/en/images/editors_features/editors_features_38.png trunk/jsf/docs/userguide/en/images/editors_features/editors_features_39.png trunk/jsf/docs/userguide/en/images/editors_features/editors_features_40.png trunk/jsf/docs/userguide/en/images/jsf_support/CreateNewJSFProject.png trunk/jsf/docs/userguide/en/images/jsf_support/converter4.png trunk/jsf/docs/userguide/en/images/jsf_support/validator1.png trunk/jsf/docs/userguide/en/images/jsf_support/validator2.png trunk/jsf/docs/userguide/en/images/jsf_support/validator3.png trunk/jsf/docs/userguide/en/images/jsf_support/validator4.png trunk/jsf/docs/userguide/en/images/jsf_support/validator5.png trunk/jsf/docs/userguide/en/images/jsf_support/validator6.png trunk/jsf/docs/userguide/en/images/jsf_support/validator7.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_15.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_16.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_17.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_18.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_19.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_20.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_21.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_22.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_23.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_24.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_25.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_26.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_27.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_28.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_29.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_30.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_31.png trunk/jsf/docs/userguide/en/images/more_editors/more_editors_34.png trunk/jsf/docs/userguide/en/images/more_editors/validator11.png trunk/jsf/docs/userguide/en/images/more_editors/validator12.png trunk/jsf/docs/userguide/en/images/more_editors/validator13.png trunk/jsf/docs/userguide/en/images/more_editors/validator14.png trunk/jsf/docs/userguide/en/images/more_editors/validator15.png trunk/jsf/docs/userguide/en/images/struts/addstrcap1.png trunk/jsf/docs/userguide/en/images/struts/validator11.png trunk/jsf/docs/userguide/en/images/struts/validator12.png trunk/jsf/docs/userguide/en/images/struts/validator13.png trunk/jsf/docs/userguide/en/images/struts/validator14.png trunk/jsf/docs/userguide/en/images/struts/validator15.png trunk/jsf/docs/userguide/en/modules/AddingCustomCapabilityFeaturesTemplates.xml trunk/jsf/docs/userguide/en/modules/DatabaseTools.xml trunk/jsf/docs/userguide/en/modules/DeploymentandRunning.xml trunk/jsf/docs/userguide/en/modules/HibernateTools.xml trunk/jsf/docs/userguide/en/modules/faq.xml Log: http://jira.jboss.com/jira/browse/JBDS-262 delete unusable images Deleted: trunk/jsf/docs/userguide/en/images/editors_features/editors_features_33.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/editors_features/editors_features_34.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/editors_features/editors_features_36.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/editors_features/editors_features_38.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/editors_features/editors_features_39.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/editors_features/editors_features_40.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/jsf_support/CreateNewJSFProject.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/jsf_support/converter4.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/jsf_support/validator1.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/jsf_support/validator2.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/jsf_support/validator3.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/jsf_support/validator4.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/jsf_support/validator5.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/jsf_support/validator6.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/jsf_support/validator7.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_15.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_16.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_17.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_18.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_19.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_20.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_21.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_22.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_23.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_24.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_25.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_26.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_27.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_28.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_29.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_30.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_31.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/more_editors_34.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/validator11.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/validator12.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/validator13.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/validator14.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/more_editors/validator15.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/struts/addstrcap1.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/struts/validator11.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/struts/validator12.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/struts/validator13.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/struts/validator14.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/images/struts/validator15.png =================================================================== (Binary files differ) Deleted: trunk/jsf/docs/userguide/en/modules/AddingCustomCapabilityFeaturesTemplates.xml =================================================================== --- trunk/jsf/docs/userguide/en/modules/AddingCustomCapabilityFeaturesTemplates.xml 2008-03-11 15:24:45 UTC (rev 6848) +++ trunk/jsf/docs/userguide/en/modules/AddingCustomCapabilityFeaturesTemplates.xml 2008-03-11 15:27:28 UTC (rev 6849) @@ -1,382 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="AddingCustomCapabilityFeaturesTemplates" xreflabel="AddingCustomCapabilityFeaturesTemplates"> - <?dbhtml filename="AddingCustomCapabilityFeaturesTemplates.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Eclipse</keyword> - <keyword>Java</keyword> - <keyword>JBoss</keyword> - </keywordset> - </chapterinfo> - <title>Adding Custom Capability, Features and Templates</title> -<section id="CreatingandUsingWithLibrarySets"> -<?dbhtml filename="CreatingandUsingWithLibrarySets.html"?> -<title>Creating and Using With Library Sets</title> -<section id="WhatIsALibrarySet"> -<?dbhtml filename="WhatIsALibrarySet.html"?> -<title>What is a library set?</title> - -<para>A library set is just a collection of any Jar files. You can create as many library sets as you need. Library sets are used to create <property>Custom Capabilities</property> and new JSF or Struts environments.</para> - -<para>A <property>Custom Capability</property> is just a collection of one or more Library Sets. When you add a <property>Custom Capability</property> to your project, the Jar files from Library Sets included in this Capability will be copied to project lib folder.</para> - -<para>A new JSF or Struts environment is also just a collection of one or more Library Sets. When you create a - new project based on this environment, all Jar files form Library Sets included in this environment will be copied to project lib folder. This also works during project import.</para> - -<para>To create a new library set (or edit an existing), select <emphasis>Window/Preferences/Red Hat/Library Sets</emphasis></para> - -<para>The top window shows all existing library sets. The lower window shows what Jar files are included in for - a selected library set. </para> - <figure> -<title>Library Sets</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/LibrarySets.png"/> - </imageobject> -</mediaobject> -</figure> -<para>To add a new library set, click <emphasis>Add</emphasis> for the top window.</para> -<para>To add new Jar files (libraries) to a library set, first select a library set and click <emphasis>Add</emphasis> for the -lower window. Browse to the location of the Jar file you want to add. The file can be anywhere on your machine -and will be copied to your Eclipse workspace. If you upgrade to a new JBoss Developer Studio version, you will not lose - your library sets.</para> - </section> -</section> -<section id="CreatingAndWorkingCustomCapability"> -<?dbhtml filename="CreatingAndWorkingWithCustomCapability.html"?> -<title>Creating and Working With Custom Capability</title> - -<para>What is a <property>custom capability</property>? A custom capability is just a collection of Jars (libraries) that add some capability to a project. When you add a <property>custom capability</property> to a project, the Jar files will be added to project WEB-INF/lib directory.</para> - -<para>A <property>custom capability</property> consists of one or more library sets. <link linkend="WhatIsALibrarySet">See how to create library sets</link>.</para> - -<para>Steps to create a new capability:</para> - -<orderedlist> -<listitem><para>Open <emphasis>Window/Preferences/Red Hat/Custom Capabilities</emphasis></para></listitem> -</orderedlist> -<figure> -<title>Custom Capabilities Window</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/CustomCapabilities.png"/> - </imageobject> -</mediaobject> -</figure> -<para>In the upper window you will see existing capabilities. In the lower window, under Library Sets tab you - will see the library sets of which this capability consists. A <property>capability</property> can consist of any number of - libraries.</para> -<para>The Configuration File Additions lets you add configuration information that is related to this - <property>capability</property>.</para> - <orderedlist continuation="continues"> -<listitem><para>Click <emphasis>Add</emphasis> in the upper window and enter <property>capability</property> name. The <property>capability</property> will now appear in the list.</para></listitem> -<listitem><para>Select the <property>capability</property> just created and click <emphasis>Add</emphasis> in the lower window.</para></listitem> -<listitem><para>Select library set to add to this <property>capability</property> Repeat the process to add as many library sets as you need.</para></listitem> - </orderedlist> -<para>How to add <property>capability</property> to a project:</para> -<itemizedlist> -<listitem><para>From Package Explorer: right click a project and select <emphasis>JBoss Developer Studio/Add Custom Capability...</emphasis> or</para></listitem> -<listitem><para>From Web Projects: right click the project and select <emphasis>JBoss Developer Studio/Add Custom Capability...</emphasis>.</para></listitem> -</itemizedlist> -<orderedlist> -<listitem><para>Use check boxes to select <property>Custom Capabilities</property></para></listitem> -<listitem><para>Click on Finish button.</para></listitem> -</orderedlist> -<figure> -<title>Select Custom Capabilities</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/SelectCustomCap.png"/> - </imageobject> -</mediaobject> -</figure> -<orderedlist continuation="continues"> -<listitem><para>The following updates have been made to the project.</para></listitem> -</orderedlist> -<figure> - <title>Added Custom Capabilities</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/AddedCustomCap.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>When you add a <property>custom capability</property> it is possible to modify application configuration files with parameters related to the added <property>capability</property>.</para> - -<figure> - <title>Configuration File Addition</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/EditCustomCap.png"/> - </imageobject> - </mediaobject> - </figure> -<orderedlist> -<listitem><para>Select Configuration File Additions tab. You will see an existing list of configuration file -additions.</para></listitem> -<listitem><para>Click Add or Edit and enter or edit the following values:</para> -<itemizedlist> -<listitem><para>Label - the name of configuration value</para></listitem> -<listitem><para>File Name - to which file to add this configuration</para></listitem> -<listitem><para>X-Path</para></listitem> -<listitem><para>Text - the text to add to the configuration file</para></listitem> -</itemizedlist></listitem> -</orderedlist> -<para>When you add a <property>capability</property> and have defined configuration files additions values, these values will be added to the configuration files.</para> - </section> -<section id="How To Add Any Custom Capability Including Oracle ADF, any custom component library or any custom support"> -<?dbhtml filename="How To Add Any Custom Capability Including Oracle ADF, any custom component library or any custom support..html"?> -<title>How To Add Any Custom Capability Including Oracle ADF, any custom component library or any custom support</title> - -</section> -<section id="CreateCustomPageTemplates"> -<?dbhtml filename="CreateCustomPageTemplates.html"?> -<title>Create Custom Page Templates</title> -<section id="CreatingCustomJSPTemplates"> -<?dbhtml filename="CreatingCustomJSPTemplates.html"?> -<title>Creating Custom JSP Templates</title> - -<para>When creating a new JSP page, you can base the new page on a pre-existing template instead of a blank - page. The template can contain common header/footer information for the page or really anything you want.</para> - -<para>Separate sets of JSP page templates are associated with the different types of project you work on. The - types of projects are:</para> -<itemizedlist> -<listitem><para>JSF</para></listitem> -<listitem><para>Struts</para></listitem> -</itemizedlist> -</section> -<section id="SavingJSPPageasATemplate"> -<?dbhtml filename="CreatingCustomJSPTemplates.html"?> -<title>Saving JSP Page as a Template</title> -<para>Switch to WebProjects view and right click any JSP page. Select <emphasis>Save as Template...</emphasis>.</para> - -<figure> -<title>Adding Page Template</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/AddTemplate.png"/> - </imageobject> -</mediaobject> -</figure> -<para>Click Ok to create a template based on this page.</para> -</section> -<section id="UsingPreferenceSettingsToCreateATemplate"> -<?dbhtml filename="UsingPreferenceSettingsToCreateATemplate.html"?> -<title>Using Preference Settings to Create a Template</title> - - -<para>Creating your own template based on a page that you have created within one of your projects in your -Eclipse workspace is pretty easy.</para> - -<orderedlist> -<listitem><para>Open the Preferences panel by selecting <emphasis>Windows/Preferences</emphasis> from the menu bar.</para></listitem> -<listitem><para>Navigate to the <emphasis>Red Hat/JSF/JSF Pages</emphasis> or <emphasis>Red Hat/Struts/Struts Pages</emphasis> section.</para></listitem> -<listitem><para>Click on the Add button to the right of the template list.</para></listitem> -<listitem><para>In the dialog box that appears, type in a name for the template and then use the <emphasis>Browse...</emphasis> button to select the location of the page you want to make into a template. </para></listitem> -</orderedlist> - -<para>The location should be located within a project. (Once this is done it doesn&apos;t matter if you delete - the original JSP page or the project containing it.)</para> - -<figure> -<title>Editing Page Path</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/AddTemplateToPref.png"/> - </imageobject> -</mediaobject> -</figure> -</section> -<section id="CreatingAJSPPageWithATemplate"> -<?dbhtml filename="UsingPreferenceSettingsToCreateATemplate.html"?> -<title>Creating a JSP Page with a Template</title> -<section id="JSF"> -<?dbhtml filename="JSF.html"?> -<title>JSF</title> -<orderedlist> -<listitem><para>In the Project Explorer view select the folder where you want to create JSP file.</para></listitem> -<listitem><para><emphasis>Right click &gt; New &gt; JSP File (or in the Web Projects view, right click the project folder &gt; New &gt; File &gt; JSP File)</emphasis></para></listitem> -<listitem><para>Expand Template field and select the template. </para></listitem> -</orderedlist> -<figure> -<title>File JSP</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/CreatingJSPwithTempl.png"/> - </imageobject> -</mediaobject> -</figure> - -<section id="JSFBasePage"> -<?dbhtml filename="JSFBasePage.html"?> -<title>JSFBasePage</title> -<figure> -<title>JSFBasePage</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/JSFBasePage.png"/> - </imageobject> -</mediaobject> -</figure> -</section> -<section id="JSPRedirect"> -<?dbhtml filename="JSPRedirect.html"?> -<title>JSPRedirect</title> -<figure> -<title>JSPRedirect</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/JSPRedirect.png"/> - </imageobject> -</mediaobject> -</figure> -</section> - - -<section id="Struts"> -<?dbhtml filename="Struts.html"?> -<title>Struts</title> -<section id="StrutsForm"> -<?dbhtml filename="StrutsForm.html"?> -<title>StrutsForm</title> -<figure> -<title>StrutsForm</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/StrutsForm.png"/> - </imageobject> -</mediaobject> -</figure> -</section> -</section> -</section> -</section> -</section> -<section id="UsingTheFileSystemToCreateATemplate"> -<?dbhtml filename="UsingTheFileSystemToCreateATemplate.html"?> -<title>Using the File System to Create a Template</title> - -<para>Alternatively, you can create the template outside of Eclipse. Just open this folder:</para> - -<para><emphasis>&lt;redhat&gt;\eclipse\plugins\org.jboss.tools.common.projecttemplates_X.X.X\templates</emphasis></para> - -<para>Create a text file with the coding you want for the template. Name the file exactly as you want the - template name to appear. Then, place the file inside the appropriate folder for the project type (jsf or - struts). Or, place the file at the same level as the Blank file for the template to be available to either - project type.</para> - -<para>After you restart Eclipse, your template will be available.</para> - -</section> -<section id="AddingYourOwnProjectTemplates"> -<?dbhtml filename="AddingYourOwnProjectTemplates.html"?> -<title>Adding Your Own Project Templates</title> -<para>JBoss Developer Studio has a powerful templating <property>capability</property> for creating new and importing existing Struts and JSF projects. This templating facility has a variety of aspects to consider. But, let&apos;s start -with the most straightforward case.</para> - -<para>Let&apos;s say you have a project that you want to use as the basis for a new template. Follow these steps to make a template out of it:</para> - -<orderedlist> -<listitem><para>In the Project Explorer, right-click the project and select <emphasis>JBoss Developer Studio/Save as Template</emphasis>.</para></listitem> -<listitem><para>In the first dialog box, you can choose a name for the template (defaults to the project name) and confirm what run-time implementation of the project&apos;s technology will be used.</para></listitem> -<listitem><para>Select Next and you will be sent to a dialog box with your project structure displayed with check boxes. Here you can check only those parts and files in your project directory that should be part of the template.</para></listitem> -<listitem><para>At this point, unless you want to designate some extra files as having Velocity template coding inside them, you should select Finish.</para></listitem> -</orderedlist> - -<para>That&apos;s it. Now, you can use this template with any new or imported project that uses the same -run-time implementation as the project you turned into a template.</para> -</section> - -<section id="Adding Your Own Project JSF and Struts Environments"> -<?dbhtml filename="AddingYourOwnProjectJSFandStrutsEnvironments.html"?> - -<title>Adding a Custom Project Environment</title> - -<para>Any environment simply consists of a collection of Jar files. You can create any number of custom -environments which consists of any number of Jar files.</para> - -<para>Here is how you can do it for JSF.</para> - -<orderedlist> -<listitem><para>Select <emphasis>Window/Preferences/Red Hat/JSF/JSF Environment</emphasis>. You will see all existing environments for creating JSF projects.</para></listitem> - -<listitem><para>Click Add to add a new environment.</para></listitem> -</orderedlist> -<figure> -<title>JSF Environment</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/JSFEnvironment.png"/> - </imageobject> -</mediaobject> -</figure> -<orderedlist continuation="continues"> -<listitem><para>When you click Add, enter the following information:</para> -<itemizedlist> -<listitem><para>Name - enter the name of the new environment</para></listitem> -<listitem><para>Template Location - leave the default value. This environment will be saved under your workspace. If you upgrade JBoss Developer Studio plug-in, you will keep all custom settings</para></listitem> -<listitem><para>Core Library - Select one core library (See <link linkend="CreatingandUsingWithLibrarySets">Library Sets</link> for more information)</para></listitem> -</itemizedlist></listitem> -</orderedlist> -<figure> -<title>Adding JSF Project Version</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/AddJSFProjectVersion.png"/> - </imageobject> -</mediaobject> -</figure> - -<orderedlist continuation="continues"> -<listitem><para>Once you have that in place, just add as many library sets to this project as you need. When - you create a project based on this environment, all Jar files from the library sets will be copied to project - <emphasis>WEB-INF\lib</emphasis> directory.</para></listitem> -</orderedlist> -<figure> -<title>Adding Library Reference</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/AddLibraryReference.png"/> - </imageobject> -</mediaobject> -</figure> -<orderedlist continuation="continues"> -<listitem><para>Switch to Project Templates tab and click <emphasis>Add</emphasis> Before you can use the new environment, you need to add at least one project template to it. You can use any existing project as a template or create a new one.</para></listitem> -</orderedlist> -<figure> -<title>Defining Common Template Properties</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/AddJSFProjectTempl.png"/> - </imageobject> -</mediaobject> -</figure> -<orderedlist continuation="continues"> -<listitem><para>You can click Next to configure the template further or just Finish. In this step, you can - select what directories to include in the template</para></listitem> -</orderedlist> -<figure> -<title>Selecting Folders and Files</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/SelectFolders.png"/> - </imageobject> -</mediaobject> -</figure> -<orderedlist continuation="continues"> -<listitem><para>Go back to create a new JSF project. When you select the new environment, you will also be - able to select the template.</para></listitem> -</orderedlist> -<figure> -<title>Selecting New Enviroment</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/AddCustomCapab/CreateJSFProjectWithTempl.png"/> - </imageobject> -</mediaobject> -</figure> -</section> -</chapter> \ No newline at end of file Deleted: trunk/jsf/docs/userguide/en/modules/DatabaseTools.xml =================================================================== --- trunk/jsf/docs/userguide/en/modules/DatabaseTools.xml 2008-03-11 15:24:45 UTC (rev 6848) +++ trunk/jsf/docs/userguide/en/modules/DatabaseTools.xml 2008-03-11 15:27:28 UTC (rev 6849) @@ -1,101 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<chapter id="DatabaseTools" xreflabel="DatabaseTools"> - <?dbhtml filename="DatabaseTools.html"?> -<title>Database Tools</title> - -<section id="DatabaseExplorer"> -<?dbhtml filename="DatabaseExplorer.html"?> -<title>Database Explorer</title> -<para>Database Explorer</para> - -<para>The Data Tools plug-in provides two special views: the Database Explorer view and the DB Output view. The Database Explorer view is where you will create connections, view your database objects, and launch actions from those objects. The DB Output view is where query results and messages are displayed.</para> - -<para>You can open either one by selecting <emphasis>Window/Show View/Other...</emphasis> from the menu bar and then choosing the appropriate view under the Data node.</para> - -<para>DatabaseExplorerShowViewDatabaseExplorerShowView</para> - -<para>The Database Explorer view shows all available connections. To create a new connection right-click anywhere in the window and select <emphasis>New Connection...</emphasis> from the context menu.</para> -<para>Then, follow these steps:</para> - -<para> 1.</para> - -<para> Specify a name for this connection.</para> - -<para> DatabaseExplorerNewConnectionStep1DatabaseExplorerNewConnectionStep1</para> -<para> 2.</para> - -<para> Select a Database Manager from the tree on the left and specify connection parameters on the right. You can test the connection by selecting the Test Connection button.</para> - -<para> DatabaseExplorerNewConnectionStep2DatabaseExplorerNewConnectionStep2</para> -<para> 3.</para> - -<para> On this page you can filter the database objects that are retrieved. If you are connecting to a database with a large number of database objects, it is important to filter appropriately to reduce the number of tables returned.</para> - -<para> DatabaseExplorerNewConnectionStep3DatabaseExplorerNewConnectionStep3</para> -<para> 4.</para> - -<para> The summary page gives you a chance to review the parameters for this connection.</para> - -<para> DatabaseExplorerNewConnectionStepLastDatabaseExplorerNewConnectionStepLast</para> - -<para>In the Database Explorer, you will see a tree structure representing your connection and the database objects retrieved.</para> - -<para>DatabaseExplorerConnectionTreeDatabaseExplorerConnectionTree</para> - -<para>To sample the data from a table, select the table in the Database Explorer and select Sample Contents from the context menu.</para> - -<para>DatabaseExplorerSampleDataDatabaseExplorerSampleData</para> - -<para>This displays the table's sample data in the DB Output view.</para> - -<para>DatabaseExplorerSampleDataResult</para> - -</section> - -<section id="SQLScrapbook"> -<?dbhtml filename="SQLScrapbook.html"?> -<title>SQL Scrapbook</title> -<para>SQL Scrapbook</para> - -<para>ORM Studio comes with a database query tool called SQL Scrapbook. You can write any SQL statements against the database for which you have created a connection.</para> - -<para>To open the SQL Scrapbook, right-click a connection and select Open SQL Scrapbook from the context menu.</para> - -<para>SQLScrapBook</para> - -<para>You will be prompted for a file name for saving the contents of the Scrapbook. Then the SQL Scrapbook editor will appear above the Database Explorer view. You can type in a SQL statement like this:</para> - -<para>SQLScrapStatement</para> - -<para>To execute the statement, select the Execute the SQL Statement icon in the toolbar.</para> - -<para>SQLScrapExecuteIcon</para> - -<para>The result is shown in the DB Output view that appears below the SQL Scrapbook.</para> - -<para>SQLScrapResult</para> -</section> - -<section id="QuantumDB plug-in "> -<?dbhtml filename="QuantumDB plug-in .html"?> -<title>QuantumDB plug-in </title> -<para>QuantumDB Plug-In</para> - -<para>We recommend to use QuantumDB free plug-in for database access. It works very well with JBDS. Please visit QuantumDB home page.</para> - -<para>QuantumDB supports the following databases:</para> - -<para> * Adabas</para> -<para> * DB2</para> -<para> * DB2 on AS400</para> -<para> * HSQLDB</para> -<para> * Informix</para> -<para> * MySQL</para> -<para> * Oracle</para> -<para> * Pointbase</para> -<para> * PostgreSQL</para> -<para> * Sybase</para> - -</section> - -</chapter> \ No newline at end of file Deleted: trunk/jsf/docs/userguide/en/modules/DeploymentandRunning.xml =================================================================== --- trunk/jsf/docs/userguide/en/modules/DeploymentandRunning.xml 2008-03-11 15:24:45 UTC (rev 6848) +++ trunk/jsf/docs/userguide/en/modules/DeploymentandRunning.xml 2008-03-11 15:27:28 UTC (rev 6849) @@ -1,303 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<chapter id="DeploymentAndRunning" xreflabel="DeploymentAndRunning"> - <?dbhtml filename="DeploymentAndRunning.html"?> -<title>Deployment and Running</title> -<section id="DeployingAnApplicationToAServer"> -<?dbhtml filename="DeployingAnApplicationToAServer.html"?> -<title>Deploying an Application to a Server</title> - -<para>You can deploy your application to any server, but there are certain types of servers that -JBoss Developer Studio supports directly (through the bundled Eclipse Web Tools Project, WTP, plug-ins). -To deploy to this type of directly supported server you need to follow these steps:</para> - -<itemizedlist> -<listitem><para>If the server you want to use is not already defined, you need to define it</para></listitem> -<listitem><para>Register your application with the defined server</para></listitem> -</itemizedlist> -</section> -<section id="DefiningTheServer"> -<?dbhtml filename="DefiningTheServer.html"?> -<title>Defining the Server</title> -<para>To use a server for direct support in JBoss Developer Studio, it needs to be defined. A special Servers view -(usually at the bottom of the screen) lists all currently defined servers. If you can&apos;t see this view, you -can open it by selecting Window/Show View.../Other/Server/Server from the menu bar. Expanding the server -will show any deployed applications for that server.</para> -<figure> -<title></title> -<mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> -</mediaobject> -</figure> - -<para>If you followed the default installation, you will already have a Tomcat 5.5 server defined. To add -a new server to this view, right-click anywhere in the Servers view, select New/Server, and follow the -wizard&apos;s steps.</para> -<figure> -<title></title> -<mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> -</mediaobject> -</figure> -<note> - <title>Note:</title> - <para>When adding a new server you will need to specify what JRE to use. It is important to set -this value to a full JDK, not JRE. Again, you need a full JDK to run Web applications, JRE will not be -enough.</para> -</note> -</section> -<section id="DeployingToTheDefinedServer"> -<?dbhtml filename="DeployingtotheDefinedServer.html"?> -<title>Deploying to the Defined Server</title> - -<para>There are two times to deploy your application:</para> - -<itemizedlist> -<listitem><para>While creating it</para></listitem> -<listitem><para>After it already exists</para></listitem> -</itemizedlist> -<section id="NewApplication"> -<?dbhtml filename="NewApplication.html"?> -<title>New Application</title> - -<para>When you create a new JSF or Struts project with the New Project or Import Project wizards, the second -screen called Web has a Target Server section. You can deploy the application through the appropriate -selection in this section.</para> -<figure> -<title></title> -<mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> -</mediaobject> -</figure> -<note> - <title>Note:</title> - <para>The default installation defines a Tomcat 5.5 server that by default will be selected as the target - server.</para> - </note> -</section> -<section id="Existingpplication"> -<?dbhtml filename="ExistingApplication.html"?> -<title>Existing Application</title> - -<para>You can deploy an existing application to a server by right-clicking the target defined server in the - Servers view and then selecting <emphasis>Add and Remove Projects...</emphasis> from the context menu.</para> -<figure> -<title></title> -<mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> -</mediaobject> -</figure> - -<para>If this application is not assigned to a server, it will be in the left-hand available projects list. - Clicking on the &quot;Add&quot; button will add it to the right-hand configured projects list and deploy the - application to this server.</para> -<figure> -<title></title> -<mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> -</mediaobject> -</figure> -</section> -</section> - -<section id="ServletContainerToolbar"> -<?dbhtml filename="ServletContainerToolbar.html"?> -<title>Servlet Container Toolbar</title> - -<para>JBoss Developer Studio allows you to control its directly supported servlet containers from within Eclipse - through a special toolbar. You can select a servlet container (Tomcat is the default on installation), - start it in regular or debug mode, stop it, or restart it. For the current application, you can touch the - web.xml file. Also, you can launch the current application in the servlet container.</para> -<note> - <title>Note:</title> - <para>Note: You also can run your application in any other server that is not listed here. Simply -deploy and start the server manually.</para> - </note> - -<para>The servlet toolbar is shown below:</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>You can select which server to use for running the application:</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>Select the green colored icon to launch the server:</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -<para> </para> - -<tip><title>Tip:</title><para>Server output will be written to the Console view.</para></tip> - -<para>Select the Run icon to launch the application. The URL that will be launched will be in a form -like http://localhost:8080/applicationName:</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -<note> - <title>Note:</title> - <para>You might need to create an index.html file for your application to start.</para> - </note> - -<note> - <title>Note:</title> - <para>You have to have deployed the application before running it.</para> - </note> - -<para>To see what URL will be launched, select the down pointing arrow. JBoss Developer Studio will also remember - the last few URLs that were used.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<tip><title>Tip:</title><para>To enter a URL by hand, select <emphasis>Run...</emphasis> from the menu.</para></tip> -<section id="ServerContainerPreferences"> -<?dbhtml filename="ServerContainerPreferences.html"?> -<title>Server Container Preferences</title> - -<para>In Preferences, you can control how JBoss Developer Studio Studio interacts with servlet containers. By selecting -the appropriate switch, you can control which browser is used to run the application and settings for each -type of supported servlet container:</para> -<para>SerlvetToolbarSettings</para> - -</section> -<section id="JavaDebuggingOfApplicationsInSupportedServers"> -<?dbhtml filename="JavaDebuggingOfApplicationsInSupportedServers.html"?> -<title>Java Debugging of Applications in Supported Servers</title> - -<para>With JBoss Developer Studio you can launch your application in debug mode with the types of servers -supported by Red Hat Studio. These are currently:</para> -<itemizedlist> -<listitem><para>Apache Geronimo 1.0</para></listitem> -<listitem><para>Apache Tomcat (3.2, 4.0, 4.1, 5.0, 5.5)</para></listitem> -<listitem><para>JBoss (3.2.3, 4.0.x)</para></listitem> -<listitem><para>BEA WebLogic Server (8.1, 9.0)</para></listitem> -<listitem><para>IBM WebSphere 6.0.x</para></listitem> -<listitem><para>JOnAS 4.x</para></listitem> -</itemizedlist> - -<para>Simply click on the start-in-debug-mode icon and start debugging your application:</para> -<figure> -<title></title> -<mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> -</mediaobject> -</figure> -</section> - -<section id="LaunchApplicationsInTheWebBrowserOfYourChoice"> -<?dbhtml filename="LaunchApplicationsInTheWebBrowserOfYourChoice.html"?> -<title>Launch Applications in the Web Browser of Your Choice</title> - - -<para>JBoss Developer Studio lets you easily launch your application in a Web browser of your choice to -run it or to test it. To launch your application with the currently selected browser, simply click the Run -button as shown.</para> - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> -</figure> - -<para>You can choose a new browser for running applications inside JBoss Developer Studio by selecting -Window/Preferences from the menu bar and then selecting General/Web Browser in the dialog box. You can -always add a new Web browser to the list here by clicking New....</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -</section> - -<section id="DeployToAnyServer"> -<?dbhtml filename="DeployToAnyServer.html"?> -<title>Deploy to Any Server (Including WebLogic, WebSphere and Resin)</title> - -<para>JBoss Developer Studio works closely with a specific group of servlet containers provided by the bundled WTP - (Eclipse Web Tools Project) plug-ins, but JBoss Developer Studio doesn&apos;t ultimately tie you to any particular server - for deployment. You are free to deploy your application to any server of your choice. For the servers that - are not supported explicitly by JBoss Developer Studio, you simply need to create an Ant script that will create - a .war file and copy it to the deployment directory under your server.</para> - -<para>Any new or imported JBoss Developer Studio project should have an ant folder containing an -Ant build.xml script. In this script, there are two commented-out &quot;targets&quot; war and deploy:</para> - - <programlisting role="XML"><![CDATA[ - ... - <!-- Create binary distribution -> - <target name="war" depends="build"> - <mkdir dir="${build.dir}"/> - <war - basedir="${webroot.dir}" - warfile="${build.dir}/${project.distname}.war" - webxml="${webinf.dir}/web.xml"> - <exclude name="WEB-INF/${build.dir}/**"/> - <exclude name="WEB-INF/src/**"/> - - <exclude name="WEB-INF/*exadel*"/> - <exclude name="WEB-INF/web.xml"/> - </war> - </target> - <target name="deploy" depends="war"> - <delete file="${deploy.dir}/${project.distname}.war"/> - - <delete dir="${deploy.dir}/${project.distname}"/> - <copy file="${build.dir}/${project.distname}.war" todir="${deploy.dir}"/> - </target> -]]></programlisting> - -<para>Once you uncomment these targets, you can customize the script to deploy your final application.</para> -</section> -</section> -</chapter> \ No newline at end of file Deleted: trunk/jsf/docs/userguide/en/modules/HibernateTools.xml =================================================================== --- trunk/jsf/docs/userguide/en/modules/HibernateTools.xml 2008-03-11 15:24:45 UTC (rev 6848) +++ trunk/jsf/docs/userguide/en/modules/HibernateTools.xml 2008-03-11 15:27:28 UTC (rev 6849) @@ -1,1394 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<chapter id="HibernateTools" xreflabel="HibernateTools"> - <?dbhtml filename="HibernateTools.html"?> -<title>Hibernate Tools</title> - -<section id="AddingHibernateCapabilitiesToAProject"> -<?dbhtml filename="AddingHibernateCapabilitiesToAProject.html"?> -<title>Adding Hibernate Capabilities to a Project</title> -<para>Making a project Hibernate-enabled is very straight-forward in JBoss Developer Studio. Adding Hibernate - capability to a project will add all the required libraries to the project.</para> - -<para> -1. If you want to add a new Hibernate nature to a project, right-click the project and select -<emphasis>JBoss Developer Studio/Add Hibernate Capabilities...</emphasis> from the context menu</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - <para>2. On the next screen, you can select a name for the appropriate Hibernate dialect</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - <para>3. Next, you can select a connection type</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>If you select the &quot;Configure Hibernate to run in non-managed environments&quot; option, you will need -to fill in connection URL details and user information.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>Then, you will need to select the properties for JDBC connection pooling.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>If you select the &quot;Configure Hibernate to run in managed environments&quot; option, you can -then select properties.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>If you select the &quot;Specify a custom connection provider&quot; option, you can then specify a - custom connection provider class.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>4. After clicking the Finish button, you can select a mapping approach (Schema To Object or Object -To Schema) that you want to use.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>After that, you can should see the ORM Explorer view. The ORM Explorer view lists all -Hibernate-enabled projects. Most Hibernate features are available by right-clicking various nodes in the - project tree in this view.</para> - -</section> - -<section id="AutoMappingsGeneration"> -<?dbhtml filename="AutoMappingsGeneration.html"?> -<title>Auto Mappings Generation</title> -<section id="AutoMappingsForForwardReverseAndMeet-at-the-MiddleEngineeringApproaches"> -<title>Auto Mappings for Forward, Reverse, and Meet-at-the-Middle Engineering Approaches</title> - -<para>JBoss Developer Studio allows you to automatically generate Hibernate mappings using the following - approaches:</para> - -<itemizedlist> -<listitem><para>Forward Engineering (Object-to-Schema)</para></listitem> -<listitem><para>Reverse Engineering (Schema-to-Object)</para></listitem> -<listitem><para>Meet-at-the-Middle</para></listitem> -</itemizedlist> -<para>We will show you how to use each of the approaches.</para> -</section> -<section id="ForwardEngineering(Object-to-Schema)"> -<?dbhtml filename="ForwardEngineering(Object-to-Schema).html"?> -<title>Forward Engineering (Object-to-Schema)</title> -<para>In this approach, we are basing the database side on the application side's object model.</para> - -<para>1. To start mapping using a forward engineering approach, right-click the Hibernate configuration -file and select <emphasis>Add Persistent Classes...</emphasis> from the context menu.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - - -<para>2. In the Add Persistent Classes Wizard, click on the Select classes... button and select the - classes you want to make persistent.</para> - - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -<para>After selecting the classes, click OK and then Next.</para> - -<para>3. In the last screen, you can click on the <emphasis>Auto Mapping Settings...</emphasis> button to change any -Auto Mapping settings for the given project. (These settings are explained in a separate Auto Mapping -Settings Reference.)</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>4. In this same last screen, you can choose to generate mappings for class attributes by checking -the Generate Mapping check box. You can also provide an optional database schema name for tables.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>5. To create mappings, click the Finish button. Once generation is finished, you can see the mappings - for your classes in the ORM Explorer view.</para> - -<para>If the Generate Mapping option was selected, then JBoss Developer Studio will mark the selected classes as - persistent and will generate mappings for the selected class fields.</para> - -<para>For collections, the type of elements will be determined via a search. Then, either a collection of - components or a one-to-many association will be created depending on whether the elements are persistent - or not. The search begins within the current package, then the whole project is searched if necessary.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>If &quot;Generate Mapping&quot; was not selected, then no field mappings will be generated, but the -selected classes will be marked as persistent and will be visible in the ORM Explorer view.</para> - -<para>To generate mappings later, on a class-by-class basis, right-click the class name in the ORM Explorer - view and select Auto Mapping from the context menu. Mappings will be generated for all relevant class - fields (static and transient fields cannot be saved into a database and will be ignored).</para> - -<para>It is also possible to generate mappings for a particular field only. Right-click the field in the -ORM Explorer view and select <emphasis>Edit Mapping...</emphasis> from the context menu.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -</section> -<section id="ReverseEngineering(Schema-to-Object)"> -<?dbhtml filename="ReverseEngineering(Schema-to-Object).html"?> -<title>Reverse Engineering (Schema-to-Object)</title> - -<para>In this approach, we are deriving the application side's object model based on an existing database.</para> - - -<para>1. To start Reverse Engineering, right-click the Hibernate configuration file and select <emphasis>Reverse - Engineer Database Schema...</emphasis> . Set all values for your specific database connection.</para> - -<para>You can test the connection by entering a user name and a password and then clicking the Test - Connection button.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>2. In the second screen, click on the <emphasis>Select tables...</emphasis> button to select which tables or views to - reverse engineer:</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -<para>After selecting the tables, click OK and then Next.</para> - -<para>3. In the next screen, you must provide a package name for where Java classes as well as Hibernate -configuration files will be generated. Also on this screen, you can invoke the Auto Mapping Settings wizard. -Finally, you can specify if mappings should be generated by checking the Generate Mapping check box.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>4. To create mappings, click the Finish button. If Generate Mapping is checked, then, inside the - package selected, new Java classes will be generated. If the package doesn&apos;t exist, it will - be created.</para> - -<para>The reverse engineering does not create persistent classes for the following categories of tables:</para> -<itemizedlist> -<listitem><para>link tables in many-to-many relationships</para></listitem> -</itemizedlist> -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>The generated Java classes fields are determined by the type of mapping with consideration to - Java reserved words. The following table summarizes the naming convention used:</para> -<table> - <title>Mapping Types and Names</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Mapping Type</entry> - <entry>Field Name</entry> - </row> - </thead> - <tbody> - <row> - <entry>property/identifier</entry> - <entry>column name</entry> - </row> - <row> - <entry>composite identifier</entry> - <entry>compositeId</entry> - </row> - <row> - <entry>many-to-one</entry> - <entry>If the referenced class has a: - - simple id, then the column name is used - - composite id, then the referenced class name is used - </entry> - </row> - <row> - <entry>many-to-many</entry> - <entry>referenced class name + "Many"</entry> - </row> - <row> - <entry>one-to-many</entry> - <entry>referenced class name</entry> - </row> - </tbody> - </tgroup> - </table> - </section> - <section id="Meet-at-the-Middle"> - <?dbhtml filename="Meet-at-the-Middle.html"?> -<title>Meet-at-the-Middle</title> - -<para>This approach can be applied if you already have your objects and schema and just want to create - mappings. To start the Meet-at-the-Middle engineering approach, you first need to complete the Reverse - Engineering steps described above. When entering a package name, just provide a package that already - contains object model Java classes and run the auto mapping generation.</para> - -<para>During mapping generation, a search will be done to locate an existing Java class with the same name - as the database table in the package specified. If such a Java class is found, then, if possible, its - existing fields will be used for mapping (no new fields will be created in such a case). Fields will be -matched according to the table above that describes the naming convention.</para> -</section> - -<section id="AutoMappingSettingsReference"> -<?dbhtml filename="AutoMappingSettingsReference.html"?> -<title>Auto Mapping Settings Reference</title> -<table> - <title>Auto Mapping Settings Reference</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Group</entry> - <entry>Property</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Associations</entry> - <entry></entry> - </row> - <row> - <entry>Cascade on collections</entry> - <entry>Set a value for cascade attribute on collection mappings (map, set, bag, idbag, - list, array)</entry> - </row> - <row> - <entry>Cascade on references</entry> - <entry>Set a value for cascade attribute on reference mappings (many-to-one, one-to-one)</entry> - </row> - <row> - <entry>Delete cascading</entry> - <entry>Set a value for on-delete attribute on a collection keys</entry> - </row> - <row> - <entry>Lazy collection initialization</entry> - <entry>Set a value for the lazy attribute on collection mappings</entry> - </row> - <row> - <entry>Lazy reference initialization</entry> - <entry>Set a value for the lazy attribute on reference mappings (many-to-one, one-to-one)</entry> - </row> - </tbody> - </tgroup> - </table> - </section> - </section> - - -<section id="VisualMapping"> -<?dbhtml filename="VisualMapping.html"?> -<title>Visual Mapping</title> - -<para>1. To edit the Hibernate class mapping file, right-click any class and select Open Visual Mapping - from the context menu.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>2. On the next screen, you can see your Mapping:</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -<para>3. You can change location of figures:</para> -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -<para>Before:</para> -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - <para>After:</para> - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -<para>4. If you select any object, the objects which are connected with this object are also selected.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>5. If you double click on the title of a figure, the figure is minimized.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>6. If you double click on any object, the connected object is shown:</para> - -<para>Before:</para> -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - <para>After:</para> - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>7. When close Visual Mapping window, objects arrangement is saved:</para> - -<para>8. On changing mapping, to edit the content of Visual Mapping window press Refresh button on toolbar.</para> - -</section> - -<section id="EditingClassMappings"> -<?dbhtml filename="EditingClassMappings.html"?> -<title>Editing Class Mappings</title> - -<para>1. To edit the Hibernate class mapping file, right-click any class and select<emphasis> Edit Mapping...</emphasis> from -the context menu.</para> - - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>2. On the next screen, select the inheritance tree mapping for the class. The user can set how the - class will be mapped in a database. This step will be displayed only for those classes that have a - persistent super class. For the topmost class this step will be skipped.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>3. After clicking Next, this screen will be displayed to allow the editing of mapping properties.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>4. After clicking Next, this screen will be displayed to allow editing the primary keys for the -database table and setup a generator. You can add an existing column as a primary key, create a new a column - in the table as a primary key, or remove a column as a primary key.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>Clicking on the <emphasis>Generator...</emphasis> button while a column is selected brings up a dialog box for specifying -the generator based on that column. You can choose to use the built-in generator or another generator. In -this dialog box, you can also establish parameters for the generator.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>5. After clicking Next on the primary key page, you can edit identification properties on the next page.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para><emphasis>Pressing the Map PK...</emphasis> button, allows you to modify or remove identification.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>6. After clicking Next on the identification properties page, you can create or remove discriminator - column mappings on the next page.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>7. After clicking Next on the discriminator column mappings page, you can create or remove version -property mapping on the next page.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -<para>8. Finally, after clicking Next again, on the next page, you can set custom SQL queries to insert, - update and delete what the class is mapped to.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>9. Click Finish to save all of your changes.</para> -</section> -<section id="EditingTheFieldMappingsOfAPersistentClass"> -<?dbhtml filename="EditingTheFieldMappingsOfAPersistentClass.html"?> -<title>Editing the Field Mappings of a Persistent Class</title> - - -<para>1. If you want to edit mapping of a field of a persistent class, right-click any field and select -<emphasis> Edit Mapping...</emphasis> from the context menu.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - <para>2. Here you can select the mapping type for the field.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>3. This next page helps you to choose the necessary properties for mapping.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>You will see several tabs if you have collection mapping.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>4. Click Finish to save changes.</para> -</section> -<section id="SynchronizingMappingsWithTableSchemas"> -<?dbhtml filename="SynchronizingMappingsWithTableSchemas.html"?> -<title>Synchronizing Mappings with Table Schemas</title> -<para>JBoss Developer Studio includes features that help you to keep your mappings synchronized with - changes made outside the JBoss Developer Studio environment (for example, in database tables). Our synchronization - component will reanalyze database table structure changes you've made and update or create the appropriate - Hibernate mappings.</para> - -<para>If you want to synchronize your mappings with changes in a database, follow these steps:</para> - -<para>1. In the Relational Schema view, right-click on a configuration file, a schema name and select -<emphasis>Synchronize Schema Mapping...</emphasis> from the context menu. If you right-click a configuration file, it will -synchronize the Hibernate configuration with all schemas in the database.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>If you right-click a schema name, it will synchronize the Hibernate configuration with the selected -schema.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>If you right-click a specific table name, it will synchronize with that selected table.</para> - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>2. Next, you should enter the connection URL, details, and user information and then click Finish.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>If there is no such table in the schema then the given table will not be refreshed.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -</section> -<section id="SynchronizingMappingWithTheSourceCode"> -<?dbhtml filename="SynchronizingMappingWithTheSourceCode.html"?> -<title>Synchronizing Mapping with the Source Code</title> - -<para>Synchronization with changes in the source code is an easy-to-use feature of -JBoss Developer Studio&apos;s ORM functionality. When invoked, this kind of synchronization cleans stale mappings that - don&apos;t exist in the source code but do exist in the mapping files. Also, it will run an automapping process - that will create default mappings for your classes.</para> - -<para>If you want to synchronize your mappings with the source code, follow these steps:</para> - - -<para>1. In ORM Explorer, right-click on the configuration file and select <emphasis>Synchronize Mapping...</emphasis> from -the context menu.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>2. If you press the OK button, you will automatically synchronize the mapping with the source code.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -</section> -<section id="TheHibernateCacheWizard"> -<?dbhtml filename="TheHibernateCacheWizard.html"?> -<title>The Hibernate Cache Wizard</title> -<section id="TheHibernateCacheWizard2"> -<?dbhtml filename="TheHibernateCacheWizard2.html"?> -<title>The Hibernate Cache Wizard</title> - -<para>The Hibernate Cache Wizard simplifies the task of specifying cacheing options for persistent items -within your application. To start the Hibernate Cache Wizard, right-click a Hibernate configuration file -and select<emphasis> Hibernate Cache Wizard..</emphasis>. .</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>The Hibernate Cache Wizard consists of a sequence of 3 screens:</para> - -<itemizedlist> -<listitem><para>1. Persistent Classes Caching</para></listitem> -<listitem><para>2. Collections Caching</para></listitem> -<listitem><para>3. Regions Caching.</para></listitem> -</itemizedlist> -</section> -<section id="PersistentClassesCaching"> -<?dbhtml filename="PersistentClassesCaching.html"?> -<para>Persistent Classes Caching</para> - -<para>The first screen allows you to designate persistent classes for caching. The screen displays two lists. - The left-hand list shows persistent classes from the selected configuration file that have not yet been - designated for caching. The right-hand list shows the persistent classes you have already designated for - caching. Use the control buttons in the middle to designate classes for caching (select on the left to - move to the right) or to undesignate classes for caching (select on the right to move to the left).</para> - -<para>In the right-hand list, the designated classes are displayed with the cacheing strategy for the class - at the end of its name. This can be changed by right-clicking the class in the right-hand list and - selecting a different strategy from the context menu.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="CollectionsCaching"> - <?dbhtml filename="CollectionsCaching.html"?> -<title>Collections Caching</title> - -<para>The second screen works just like the first screen except that it deals with collections from the - selected configuration.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="RegionsCaching"> - -<para>Regions Caching</para> -<?dbhtml filename="CollectionsCaching.html"?> -<title>Regions Caching</title> - -<para>The final screen allows you to group together classes and collections, designated for caching in -the previous screens, into caching regions. The screen displays two lists. The left-hand list shows the -classes and collections designated for caching. The right-hand list shows the same objects as a tree.</para> - -<para>At first the right-hand tree consists of the objects to cache with themselves as the only child - node to themselves. To group some objects together as a region, select the first-level node for one of - the objects in the right-hand list, select, in the left-hand list, the other objects you want to group - with this object, and then click the Move to region button. You can then add more objects to the region, - if you want.</para> -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>Here are two other points about this screen in the wizard. The region name can be changed by - directly editing the node name in the right-hand list. Also, to remove an object from a caching region, - select it in the left-hand list, select another region or a node with no children in the right-hand list, - and then click the Move to region button.</para> - -<para>Once your done, click on the Finish button to save or click on the Cancel button to discard the - settings.</para> - -</section> -</section> -<section id="FetchStrategyWizard"> -<?dbhtml filename="FetchStrategyWizard.html"?> -<title>Fetch Strategy Wizard</title> - -<para>In this Wizard, you can specify the fetching associations strategy.</para> - -<para>1. In ORM Explorer, right-click on a Hibernate configuration file and select <emphasis>Fetch Strategy - Wizard...</emphasis> from the context menu.</para> - <figure> - <title>t</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - - -<para>2. On the next screen, you can select fetching associations and set a strategy using the buttons -to the right.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>3. On the screen after this, you can select &quot;Lazy&quot; fetching associations and set a strategy using -the buttons to the right.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>4. On the final screen, you can select &quot;Batch&quot;fetching associations and set a batch size using -the button to the right.</para> - - <figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -</section> - -<section id="TheHibernateConfigurationFileWizard"> -<?dbhtml filename="TheHibernateConfigurationFileWizard.html"?> -<title>The Hibernate Configuration File Wizard</title> - - -<para>1. If you want to edit the Hibernate configuration, right-click the configuration file node under -the project node in the ORM Explorer (typically, src/hibernate.cfg.xml) and select <emphasis>Edit Hibernate -Configuration...</emphasis> from the context menu.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -<para>2. On the next screen you can select the Hibernate dialect and some other properties.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>3. Click "Next". Here you can select the connection type.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -<para>4. If you have selected &quot;Configure Hibernate to run in non-managed environments&quot;, on this screen you - can set parameters JDBC connection which will be kept in a file of a configuration.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>And select properties of JDBC connection pooling:</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>If you have selected &quot;Configure Hibernate to run in managed environment&quot;, you can on -this screen select properties:</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>If you have selected &quot;Specify a custom connection provider&quot;, you can on this screen - specify connection provider class:</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>5. Click &quot;Finish&quot; to save changes.</para> - -</section> - -<section id="DDLGenerationForAllDatabasesSupportedByHibernate"> -<?dbhtml filename="DDLGenerationForAllDatabasesSupportedByHibernate.html"?> -<title>DDL Generation for All Databases Supported by Hibernate</title> -<para>JBoss Developer Studio comes with a DDL (Data Definition Language) generation feature. It allows - you to easily generate table creation scripts based on your Hibernate mappings.</para> - -<para>You can take advantage of this facility in the Diagram viewer of the mappings file editor by following these steps:</para> - - -<para>1. In ORM Explorer right-click on the cfg.xml- files and select <emphasis>Generate DDL Wizard... </emphasis>from the - context menu.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>2. On the next screen, you can select your database Dialect, specify a delimiter .</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>Here is the pop-up menu for selecting dialects.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>After selecting Finish, a script will automatically be generated.</para> -</section> -<section id="DAOClassGeneration"> - <?dbhtml filename="DAOClassGeneration.html"?> -<title>DAO Class Generation</title> - - -<para>1. In ORM Explorer right-click on the cfg.xml- files and select <emphasis>Generate DAO Classes...</emphasis> from the - context menu.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>2. On the next screen, you can select persistent classes.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>3. On the next screen, you can select DAO generation options.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>After selecting Finish, DAO classes will automatically be generated (in a source folder of the - current project).</para> - -</section> -<section id="NamedQueriesWizard"> -<?dbhtml filename="NamedQueriesWizard.html"?> -<title>Named Queries Wizard</title> - - -<para>1. In ORM Explorer&apos;s toolbar, press the suitcase icon (Group by storage):</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - <para>This will produce a list of (hbm.xml) mapping files for that configuration. Then, right-click on - an hbm.xml file and select <emphasis>Add Named Query...</emphasis> from the context menu.</para> -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -<para>2. In the next screen, set all values for your specific database connection. Then, use the Hibernate - Query Language to define a new query in the Query field.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -<para>Press the Run Query button to see the result of your query:</para> -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -</section> - -<section id="QueryTestWizard"> -<?dbhtml filename="QueryTestWizard.html"?> -<title>Query Test Wizard</title> - - -<para>This wizard is intended for fast testing named queries. The query is generated automatically, but - you can modify and execute it.</para> - -<para>For more detailed information address to <ulink url="index.html">Named Queries Wizard</ulink>.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -</section> -<section id="SettingUpACustomPOJORenderer"> -<?dbhtml filename="SettingUpACustomPOJORenderer.html"?> -<title>Setting Up a Custom POJO Renderer</title> - -<para>In order to set up a custom POJO renderer, we first need to create an extension point. An extension -point is the mechanism by which one plug-in can add to the functionality of another.</para> - -<para>1. First you have to create a plug-in project.Open the plugin.xml manifest file and switch to the -Dependencies page. Here you have to add the dependencies next:</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>2. Switch to the Extensions page. The page lists all extension points used by this plug-in.</para> -<para>Press the &quot;Add&quot; button and select the extension &quot;com.exadel.orm2.core.codeRenderers&quot;</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>3. You should now see the com.exadel.orm2.core.codeRenderers extension point listed in your Extensions - page.</para> -<para>Right-click on it and select New>code_renderer</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -<para>Doing so creates an object under the extension with a default name like -com.exadel.orm2.sample.code_renderer2</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>Set the name and change the id in the properties for this object.</para> - -<para>4. Select the class property and click the Selection button to bring up the Java Class Selection - dialog. Click Finish, and then press Ctrl-S to save.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - - -<para>5. Switch to the Extensions page. You then need to select the package that contains this class.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>6. After that you have to deploy this plug-in. Select File> Export, and then select the -&quot;Deployable plug-ins and fragments&quot; item in the Export dialog. You can deploy plug-ins as either .jar or - .zip files. Here, we&apos;ll deploy both plug-ins in a .zip file. Enter the fully qualified name of the .zip - file and unzip that file in the Eclipse distribution directory.</para> - -<para>7. You don&apos;t have to implement all interface methods. You can use the default implementation -and override only certain methods. To do this just make the generated class a descendant of -com.exadel.orm2.core.CodeRendererService and change the generated import:</para> -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -<para>Now you can safely delete all methods, that you are not going to override, in fact, you must. -Imagine that you want to generate persistent classes to be instances of the Comparable interface. -No problem! Here is the code that&apos;ll do that task for you:</para> -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -<para>The createType method is overridden here to add Comparable to the array of interfaces to implement - (only for primary types, but not for inner ones), then the default implementation is invoked by - super.createType call. JBoss Developer Studio automatically generates all the necessary method stubs for - implemented interfaces.</para> - -<para>8. After that you can use this created extension point for a custom POJO renderer. If you create a -new Java project and after that you add &quot;Hibernate Capabilities&quot;, you can then select your created class.</para> -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -</section> -<section id="HibernateFileContentAssist"> -<?dbhtml filename="HibernateFileContentAssist.html"?> -<title>Hibernate File Content Assist</title> - -<para>With JBoss Developer Studio, Code Assist is available in the editor for any XML file. The first - screen shot shows Code Assist being invoked for the Hibernate mapping file.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>Here is Code Assist in the editor for the Hibernate configuration file.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>Any other XML files in your project will also have the Code Assist feature available as in the web.xml file below.</para> - -<figure> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> - </mediaobject> - </figure> -</section> -<section id="SupportedTechnologiesForORMHibernate"> - <?dbhtml filename="SupportedTechnologiesForORMHibernate.html"?> -<title>Supported Technologies for ORM Hibernate</title> - -<para>JBoss Developer Studio supports Hibernate 3.0.</para> - -<para>JBoss Developer Studio works with any database Hibernate supports. You can connect to these types - of databases:</para> -<itemizedlist> -<listitem><para>Cloudscape</para></listitem> -<listitem><para>DB2</para></listitem> -<listitem><para>Firebird</para></listitem> -<listitem><para>Frontbase</para></listitem> -<listitem><para>HSQL</para></listitem> -<listitem><para>Ingres</para></listitem> -<listitem><para>Informix</para></listitem> -<listitem><para>InstantDB</para></listitem> -<listitem><para>Interbase</para></listitem> -<listitem><para>Mckoi</para></listitem> -<listitem><para>MSSQL</para></listitem> -<listitem><para>MySQL</para></listitem> -<listitem><para>Oracle</para></listitem> -<listitem><para>Pointbase</para></listitem> -<listitem><para>Progress</para></listitem> -<listitem><para>SAPDB</para></listitem> -<listitem><para>Sybase</para></listitem> -<listitem><para>SybaseAnywhere</para></listitem> -</itemizedlist> - -</section> -<section id="ORMPreferences"> - <?dbhtml filename="ORMPreferences.html"?> -<title>ORM Preferences</title> - -<para>Here you can set default auto mapping settings values for new ORM projects:</para> - -<figure> -<title></title> -<mediaobject> - <imageobject> - <imagedata fileref="images/defaultImage.png"/> - </imageobject> -</mediaobject> -</figure> -</section> -</chapter> - - Deleted: trunk/jsf/docs/userguide/en/modules/faq.xml =================================================================== --- trunk/jsf/docs/userguide/en/modules/faq.xml 2008-03-11 15:24:45 UTC (rev 6848) +++ trunk/jsf/docs/userguide/en/modules/faq.xml 2008-03-11 15:27:28 UTC (rev 6849) @@ -1,16 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="faq"> - <?dbhtml filename="faq.html"?> - <title>FAQ</title> - <para>If something still remains unclear after studying this guide you can always post your question on our <ulink url="http://jboss.com/index.html?module=bb&amp;op=viewforum&... - <section id="faq_facelets"> - <title>Facelets</title> - <para>Q: Could you give me more information on templates for the MyFaces JSF implementation?</para> - <para>A: JBoss Developer Studio does not provide templates for MyFaces right out of the box, but you can easily do it - yourself with the &quot;Save As Template&quot; feature (available on the File submenu). Just create a small project - with MyFaces and Facelets and then save it as a template for future use.</para> - - <para>Q: How can I add Facelets support to an existing project?</para> - <para>A: Right-click on the folder of existing project and select <emphasis>JBoss Tools &gt; Add Custom Capabilities.. &gt; Facelets</emphasis>. </para> - </section> - </chapter>