Author: ochikvina
Date: 2010-03-12 13:34:26 -0500 (Fri, 12 Mar 2010)
New Revision: 20810
Removed:
trunk/smooks/docs/reference/en-US/options_page.xml
trunk/smooks/docs/reference/en-US/process_page.xml
trunk/smooks/docs/reference/en-US/quick_start.xml
trunk/smooks/docs/reference/en-US/smooksformeditor_configurationpage.xml
trunk/smooks/docs/reference/en-US/smooksformeditor_graphicalpage.xml
trunk/smooks/docs/reference/en-US/smooksformeditor_sourcepage.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-821 -Reviewed the content of Smooks doc
sources,deleted all the old out-of date screens and .xml s that were included into them
but were no longer useful.</p>
</body></html>
Deleted: trunk/smooks/docs/reference/en-US/options_page.xml
===================================================================
--- trunk/smooks/docs/reference/en-US/options_page.xml 2010-03-12 18:24:29 UTC (rev
20809)
+++ trunk/smooks/docs/reference/en-US/options_page.xml 2010-03-12 18:34:26 UTC (rev
20810)
@@ -1,97 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="options_page">
- <?dbhtml filename="options_page.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Smooks</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
- <title>Options Tab</title>
- <para>This chapter describes Options tab of the Smooks Configuration File
editor, gives short recommendations how this tab can be used during the project
configuring.</para>
- <figure>
- <title> Options tab of the Smooks Configuration File editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_10.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <section>
- <title>Smooks Configuration section</title>
- <para>
- In the <property>Smooks Configuration</property> section of
<property>Options Tab</property>
- only one element is availible:Smooks Platform Version
- </para>
- <figure>
- <title>Smooks Configuration section of Options tab</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/reference/reference_9.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>This parameter is not rechangable,
- and is set according to the vesion of the Smooks libraries that are added to
the project.
- </para>
- </section>
- <section>
- <title>Filter Settings Filter section</title>
- <para>
- In Filter Settings section you can set
- the following global options responsible for Smooks filtering
configuring:</para>
- <figure>
- <title>Filter Settings section of Options tab</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/reference/reference_1.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>This behavior can be turned off using this global configuration
parameter and can be overriden on a per fragment basis by targetting a Visitor
implementation at that fragment that takes ownership of the Result writer (in the case of
SAX filtering), or simply modifies the DOM (in the case of DOM filtering). As an example
of this, see the FreeMarkerTemplateProcessor.
- </para>
- <table>
- <title>Options Tab. Filter Settings section.</title>
- <tgroup cols="3">
- <colspec colnum="1" align="left"
colwidth="1*"/>
- <colspec colnum="2" align="left"
colwidth="3*"/>
- <colspec colnum="3" align="left"
colwidth="1*"/>
-
- <thead>
- <row>
- <entry>Option</entry>
- <entry>Description</entry>
- <entry>Default</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Stream Filter Type</entry>
- <entry>Determines the type of processing model that will be
used.
- Please refer to <ulink
url="http://www.smooks.org/mediawiki/index.php?title=V1.2:Smooks_v1....
- Filtering Process Selection section</ulink>
- of the official Smooks User Guide for more information about
these models:
- <itemizedlist>
-
<listitem><para><emphasis>SAX</emphasis></para></listitem>
-
<listitem><para><emphasis>DOM</emphasis></para></listitem>
- </itemizedlist>
- </entry>
- <entry>DOM</entry>
- </row>
-
- <row>
- <entry>Default Serialization is On</entry>
- <entry>Defines whether default serialization should be
switched on.
- Default serialization being turned on leads to locating
StreamResult/DOMResult
- to the Result objects provided to the Smooks.filterSource
method and to
- serialization all the events to that Result.</entry>
- <entry>true</entry>
-
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
-</chapter>
-
Deleted: trunk/smooks/docs/reference/en-US/process_page.xml
===================================================================
--- trunk/smooks/docs/reference/en-US/process_page.xml 2010-03-12 18:24:29 UTC (rev
20809)
+++ trunk/smooks/docs/reference/en-US/process_page.xml 2010-03-12 18:34:26 UTC (rev
20810)
@@ -1,140 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="process_page">
- <?dbhtml filename="process_page.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Smooks</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
- <title>Process Page</title>
- <para>This chapter describes Process tab of the Smooks Configuration File
editor, gives short recommendations how this tab can be used during the project
configuring.</para>
-
- <section>
- <title>Input Task Configuring</title>
- <para>
- <property>Input task configuring</property> is an obligatory step
for your smooks project creation.
- You can do this on the Process page of the editor: look for the "Input
Task" in the Process Map at the top of the page.
- </para>
- <figure>
- <title>Input Task Configuring</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/process_page/process1.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Select it and you will see all the properties to set for the Input
reader of your Smooks configuration.
- "Input type" corresponds to the type of data that you will be
working with.
- For example, to work with incoming CSV (Comma-separated Values) data, you
would specify "CSV" in the drop-down list.
- Each reader type has slightly different configuration details that must be set
in the "Input configuration" area.
- For instance, the CSV reader requires you to specify details such as the
encoding, quote character, separator character, and the list of incoming fields.
- The EDI reader requires the encoding and the path to the Mapping Model
describing the incoming data.
- In the "Input data" section, you specify some sample data that
conforms to your reader configuration.
- </para>
-
- <para>
- Once you've specified your reader configuration and sample data, you can
see the input model rendered in a tree form in the "Input model" section.
- On the picture below you can see the correct configuration of some XML input
task.
- </para>
- <figure>
- <title>Input Task Configuring</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/process_page/process2.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
-
-
- <section>
- <title>"Java Mapping" or "Apply
Template"?</title>
-
- <para>Though there are many options in Smooks as far as what you can do
with input
- data such as transformation, routing, and persistence, the first release
- of the Smooks Configuration Editor focuses on just a couple of areas:
- mapping to java and applying templates to create different output formats.
- If you have a set of Java classes you want to use the incoming data for,
- you can use the "Java Mapping" task to specify those classes and
use drag and
- drop to map between the input model generated by the reader and elements in
the output model.
- Or if you simply want to transform your output to one or more formats, you
can use the "Apply Template"
- task to map it to a CSV file, XML or XSD file (and other formats in the
future).
- </para>
- </section>
- <section id="mapping">
- <title>Java Mapping</title>
-
- <para>
- If you decide to do Java Mapping, you need to make sure that your Input
reader has been set up and you have some sample data specified.
- Then you should select the "Input Task" in the Process tab and
click the plus (+) sign to the right of the icon.
- Select "Java Mapping" from the popup menu and it will appear to the
right, connected to the "Input Task". Then select the "Java Mapping"
task.
- </para>
- <figure>
- <title>Java Mapping configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/process_page/process3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Another method of adding "Java Mapping" element to the
canvas in the Processing Tasks section is to right click Input Task element and select in
the popup menu </para>
- <figure>
- <title>Java Mapping configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/process_page/process4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>
- Right-click on the canvas in an empty space and select "Add ->Java
Class".
- </para>
- <figure>
- <title>Java Mapping configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/process_page/process5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>
- The "Java Bean Creation" wizard appears.
- Specify a unique identifier for the new class, the class path, whether
it's an array or not, and if it is a collection, also specify the collection class.
- If the Java class is specified, you'll see a list of the properties in
the box below.
- Click Finish when you're done.
- Now with the input and output models on the canvas, you can click and drag
from the various input elements to corresponding output elements. Make sure to connect
collection elements to corresponding collection elements.
- Finally your mapping should look nearly like the one on the picture below.
- </para>
- <figure>
- <title>Final Mapping schema</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/process_page/process6.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section>
- <title>"Apply Template" task</title>
-
- <para>The "Apply Template" task works very similarly to the
<link linkend="mapping">"Java Mapping" task</link>, where
you map between an input model and an output model.
- Select the "Input Task" or "Java Mapping" task you want
to use as the input model in the Process Map pane and click the plus (+) sign to the right
of the icon.
- </para>
- <figure>
- <title>"Apply Template" task opening</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/process_page/process7.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>
- Select "Apply Template" from the popup menu and it will appear to
the right, connected to the task you created it from. Then select the "Apply
Template" task.
- Once you've defined your template model, you can click and drag from the
various input elements to corresponding output elements in the template. Make sure to
connect collection elements to corresponding collection elements
- </para>
- </section>
-</chapter>
-
Deleted: trunk/smooks/docs/reference/en-US/quick_start.xml
===================================================================
--- trunk/smooks/docs/reference/en-US/quick_start.xml 2010-03-12 18:24:29 UTC (rev 20809)
+++ trunk/smooks/docs/reference/en-US/quick_start.xml 2010-03-12 18:34:26 UTC (rev 20810)
@@ -1,590 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="quickstart" xreflabel="Quick Start"
role="updated">
- <?dbhtml filename="quick_start.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Smooks</keyword>
- <keyword>JBDS</keyword>
- <keyword>java</keyword>
- </keywordset>
- </chapterinfo>
- <title>Quick Start</title>
- <para> This "Quick Start" will show how to use the
<property>Smooks tools</property> to create/edit the Smooks
- configuration file for Java2Java data transformation.</para>
- <para> This chapter gives you a brief understanding of the <property>Smooks
tools</property>.</para>
- <section>
- <title>Download Smooks Java-to-Java Example</title>
- <para> Visit <ulink
-
url="http://www.blogjava.net/Files/reloadcn/smooks_java_java.zip"
- >smooks examples page</ulink> to download the "java-to-java"
example project. </para>
- <tip>
- <title>Tip:</title>
-
- <para> The example project is based on Maven, we suggest you to create a new
eclipse
- Java project, copy the example code and .jar files from the example project and
paste
- them into the eclipse Java project. </para>
- </tip>
- </section>
- <section>
- <title>Mapping rules</title>
- <para>At the begining of working with Smooks tools,
- we need to understand the Java-to-Java mapping rules of this example.
- The transform input Java class is
<emphasis><property>example.sourcemodel.Order</property></emphasis>
, its structure looks like this :
- </para>
- <figure>
- <title>Order class</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/sourcemodel_structured.jpg"
/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Let's describe the structure of
<emphasis><property>example.sourcemodel.Order</property></emphasis>
in short:</para>
- <itemizedlist>
- <listitem><para>Order class contains a
<property>Header</property> class and a <property>List</property>
class.</para></listitem>
- <listitem><para>The <property>Header</property> class has
<property>customerName</property>,<property>customerNumber</property>,<property>priority</property>
as properties.</para></listitem>
- <listitem><para>In Order class the objects of the OrderItem class are
stored in the List.</para></listitem>
- <listitem><para>OrderItem has
<property>price</property>,<property>productId</property>,<property>quantity</property>
as its properties.</para></listitem>
- </itemizedlist>
- <para>Let's look at the transform target Java class :
<emphasis><property>LineOrder</property></emphasis>.</para>
- <para>On the screen below you can see its structure:</para>
- <figure>
- <title>LineOrder class</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/targetmodel_structured.jpg"
/>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem><para><property>LineOrder</property> class contains
3
properties:<property>customerId</property>,<property>customerName</property>,<property>priority</property>
and an array of lineItems.</para></listitem>
- <listitem><para>The <property>Header</property> class has
<property>customerName</property>,<property>customerNumber</property>,<property>priority</property>
as its properties.</para></listitem>
- <listitem><para>OrderItem objects are stored in a
List.</para></listitem>
- </itemizedlist>
- <para>Now it's the time to define the mapping rules to transform the input
source java class to the target java class:</para>
- <itemizedlist>
- <listitem><para>Each instance of the Order class should be mapped with an
instance of the LineOrder class.</para></listitem>
- <listitem><para>The value of <property>customerName</property>
of the Header class should be assigned to the
<property>customerName</property> property of a LineOrder
instance.</para></listitem>
- <listitem><para>The value of
<property>customerNumber</property> of the Header class should be assigned to
the <property>customerId</property> property of a LineOrder
instance.</para></listitem>
- <listitem><para>The value of <property>priority</property> of
the Header class should be assigned to the <property>priority</property>
property of LineOrder instance.</para></listitem>
- <listitem><para>For the <property>orderitems</property> List
of the Order instance, it's necessary to map a new lineItems array instance of
LineOrder ,
- and each OrderItem instance in the orderItems List should be transformed to a LineItem
instance,
- those instances will be put into the lineItems array.</para></listitem>
- <listitem><para>The value of <property>productId</property> of
the OrderItem instance should be assigned to the 'productCode' of
LineItem.</para></listitem>
- <listitem><para>The value of <property>price</property> of
OrderItem should be assigned to the <property>unitPrice</property> of
LineItem.</para></listitem>
-
- </itemizedlist>
- </section>
-
- <section id="config_file_wizzard">
- <title>Smooks Configuration File Wizard</title>
- <para>Select the Smooks Java-to-Java example project that you created and
right-click,
- select the menu <emphasis><property>New >
Other</property>,</emphasis> then find
- <emphasis><property>Smooks > Smooks Configuration
File</property>.</emphasis>
- Click the <emphasis>
- <property>Next</property>
- </emphasis> button. </para>
- <figure>
- <title>Selecting Smooks Configuration File Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start1.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The first wizard page is a file path creation page. Select the
<emphasis>
- <property>src</property>
- </emphasis> folder to be the files container, and input the name
- <emphasis><property>smooks-config.xml</property>.</emphasis>
Click
- <emphasis><property>Next</property>.</emphasis></para>
- <figure>
- <title>Choosing the configuration file container and the file
name</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start2.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The second wizard page is allows you to select Smooks configuration file
version. Select the appropriate one and click
<emphasis><property>Finish</property></emphasis> to complete the
wizard.</para>
-
-
-
- <!--<para> As the quick start introduces how to create/edit the Java-to-Java
Smooks
- configuration file, let's select the<emphasis>
- <property>Java-to-Java</property>
- </emphasis> type as the source/target transform data type. </para>
-
- <figure>
- <title>Selecting Data Type</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start3.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the next page you are prompted to choose the source data for
transformation.
- Let's select the <property>Order</property> class from the
example project as
- the source JavaBean class.</para>
-
- <figure>
- <title>Selecting the Source Data</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start4.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Then the wizard page asks you to choose the target data for transformation.
We select
- the <property>ListOrder</property> class as the target JavaBean
class.</para>
- <figure>
- <title>Selecting the Target Data</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start5.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para/>
-
- <tip>
- <title>Tip:</title>
- <para>You can omit two these steps and just press
- <emphasis><property>Finish</property>.</emphasis> This will
open the empty
- Smooks Configuration file. It's possible to <link
- linkend="graphicaleditor_datalink">select source/target
data</link> afterwards
- in the Smooks Graph editor.</para>
- </tip>-->
- </section>
- <section id="quickstart_formeditor">
- <title>Smooks Editor</title>
-
- <para>When all the wizard steps are passed, a new Smooks Configuration file is
created and
- the <property>Smooks Configuration Editor</property> will be opened
automatically:</para>
- <figure>
- <title>Smooks Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start6.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>On the bottom of this editor there are 5 tabs, they are :
-
- Overview, Reader, Message Filter, Graph, Source.</para>
- <section id="graphicaleditor_datalink">
- <title>Adding the input data</title>
- <para>At first, we need to add the Order class as the input data.
- To do this, click the Reader tab, swich to the Reader/Input editor page</para>
-
- <!--<para> This editor contains several parts: <table>
- <title>The Smooks Editor Parts</title>
- <tgroup cols="2">
-
- <colspec colnum="1" align="left"
colwidth="1*"/>
- <colspec colnum="2" colwidth="5*"/>
-
- <thead>
- <row>
- <entry>Editor feature</entry>
- <entry>Functionality</entry>
- </row>
- </thead>
-
- <tbody>
-
- <row>
- <entry>
- <para>Problems area</para>
- </entry>
- <entry>
- <para>If there are any errors when you are editing the file, the
- Problems area displays them</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Source data tree</para>
- </entry>
- <entry>
- <para>The tree displays a structure of the transformed source
- data</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Target data tree</para>
- </entry>
- <entry>
- <para>The tree displays a structure of the transformed target
- data</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Mapping graphical area</para>
- </entry>
- <entry>
- <para>Show the data mapping connection lines</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Source/Target data selection links</para>
- </entry>
- <entry>
- <para>Click the link, and <link
linkend="graphicaleditor_datalink"
- >Data Selection wizard</link> is opened helping you to
- choose the source/target data</para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>-->
-
-
- <para>To choose the transform data you should open <emphasis>
- <property>Reader</property></emphasis> tab and click
<emphasis>
- <property>Add</property></emphasis> button in the Input Data
section.</para>
- <figure>
- <title>Input Data section</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start_6a.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>After clicking the button the <property>Data Type Selection
wizard</property> is
- opened, and there are many data types in the list: Java, XML etc.</para>
- <note>
- <title>Note</title>
- <para> There will become more and more data types on the list as the development
goes on.
- </para>
- </note>
-
- <figure>
- <title>Data Type Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start7.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Select the <emphasis>
- <property>Java</property>
- </emphasis> data type and click
<emphasis><property>Next</property>,</emphasis> you will
- see the JavaBean class selection page:</para>
-
- <figure>
- <title>JavaBean Data Selection</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start8.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Let's select the Order class from the example project as the source
JavaBean class.After that click <emphasis>
- <property>Finish</property>
- </emphasis> and you should see the just added java class, being displayed in
the Input Data Section.
- </para>
- <figure>
- <title>Displaying the Structure of the Transformed Data</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start9.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section>
- <title>Adding the target Bean</title>
- <para>After adding the input data, let's switch to the Message Filter
page:</para>
- <figure>
- <title>Displaying the Structure of the Transformed Data</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start9a.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click the <property>Add</property> button, the
<property>Add Child</property> wizard page will be shown, let's select the
<property>Java Binding v1.2 -> Bean v1.2</property> and click
<emphasis><property>OK</property></emphasis> to add the Bean :
- </para>
- <figure>
- <title>Add Child wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start9b.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Then we can find on the Message Filter page the <property>Bean
v1.2</property> item added, click on it ,a Bean v1.2 section should appear to the
right of the page.
- The section represents a GUI for editing <property>Bean v1.2</property>
properties:</para>
- <figure>
- <title>Bean v1.2 section</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start9c.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>You should input <property>
- lineOrder</property> as the Bean's id in the "Bean Id" field.Then
you should click <property>Browse</property> button
- near the <property>Class</property> textfield and select LineOrder as the
Bean's class.</para>
- <note>
- <para>
- When you enter a value for the <property>Class</property> text field,
- you can type 'Alt + /' and the content assist pop dialog will be shown,
- so it's will increase the efficiency. If 'Alt + /' doesn't work,
- try to use the 'Ctrl + space'('Key Assist' of Eclipse).
- </para>
- </note>
- <para>Let's click the <property>Add Binding</property> link at
the bottom of this page,
- it will show a dialog to ask the binding of what Bean properties you will prefer to
add.
- Select all and click OK, you will see a list of Binding elements added under the Bean
item.</para>
- <para>Then you should add an array of beans called
<property>lineItems</property> and a Bean LineItem.These two classes and Id
values are:</para>
- <para>Array Bean:</para>
- <itemizedlist>
- <listitem><para>BeanId : lineItems;</para></listitem>
- <listitem><para>Class :
example.trgmodel.LineItem[]</para></listitem>
- </itemizedlist>
- <para>LineItem Bean :</para>
- <itemizedlist>
- <listitem><para>BeanId : lineItem;</para></listitem>
- <listitem><para>Class :
example.trgmodel.LineItem</para></listitem>
- </itemizedlist>
- <note>
- <para>
- In Smooks , to be an array of Beans , the class value should end with '[]'.
This means that this bean is an array type.
-
- </para>
- </note>
- <para>To finish this work, use the <property>Add Binding</property>
link to add all the bindings for the Bean.</para>
- </section>
-
-
- </section>
- <section id="quickstart_mapping">
- <title>Mapping</title>
-
-
- <para>How to map the java class just added?</para>
-
- <para>First, you should know what to transform:</para>
-
- <orderedlist numeration="loweralpha" inheritnum="inherit">
- <listitem>
- <para>Bind the <emphasis>
- <property>"customerName"</property>
- </emphasis> property of the <property>Order#header</property> to
the <emphasis>
- <property>"customerName"</property>
- </emphasis> property of
<property>LineOrder</property>.</para>
- </listitem>
- <listitem>
- <para>Bind the <emphasis>
- <property>"customerNumber"</property>
- </emphasis> property of the <property>Order#header</property> to
the <emphasis>
- <property>"customerId"</property>
- </emphasis> property of
<property>LineOrder</property>.</para>
- </listitem>
- <listitem>
- <para>Bind the <emphasis>
- <property>"price"</property>
- </emphasis> property of the <property>OrderItem</property> to the
<emphasis>
- <property>"unitPrice"</property>
- </emphasis> property of
<property>LineItem</property>.</para>
- </listitem>
- <listitem>
- <para>Bind the <emphasis>
- <property>"productId"</property>
- </emphasis> property of the <property>OrderItem</property> to the
<emphasis>
- <property>"productCode"</property>
- </emphasis> property of
<property>LineItem</property>.</para>
- </listitem>
- <listitem>
- <para>Bind the <emphasis>
- <property>"quantity"</property>
- </emphasis> property of the <property>OrderItem</property> to the
<emphasis>
- <property>"unitQuantity"</property>
- </emphasis> property of
<property>LineItem</property>.</para>
- </listitem>
- </orderedlist>
-
- <para> Make sense?
- You should open Design tab and click Add button. In opened Add Child Wizard,please,
select <emphasis>
- <property>Add Smooks Resource>Java
Binding>Bindings</property></emphasis>.
- </para>
- <para>First of all, you should bind <emphasis>
- <property>Order</property></emphasis> to <emphasis>
- <property>LineOrder</property></emphasis>. To do this one
<emphasis>
- <property>Bindings</property></emphasis> Item should be added to
the Resource List.</para>
- <figure>
- <title>Mapping</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start10.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure><para>Click on it and you should see <emphasis>
- <property>Bindings</property></emphasis> Section to the right of
<emphasis>
- <property>Message Filtering Resources</property></emphasis>.Write
<emphasis> <property>lineOrder</property></emphasis> in the
<emphasis>
- <property>Bean id</property></emphasis> field.</para>
- <para>Select <emphasis>
- <property>example.trgmodel.LineOrder</property></emphasis> in the
<emphasis>
- <property>Class</property></emphasis> field and <emphasis>
- <property>example.srcmodel.Order</property></emphasis> in the
<emphasis>
- <property>Name</property></emphasis> field.Your <emphasis>
<property>Smooks Configuration Editor</property></emphasis> should look
like this: </para>
- <figure>
- <title>Mapping</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start11.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Now you should bind two values <emphasis>
<property>"customerNumber"</property>
- </emphasis> property of the <property>Order#header</property> to the
<emphasis>
- <property>"customerId"</property>
- </emphasis> property of <property>LineOrder</property>.To do this
right click your just created <emphasis>
- <property>Bindings Item >Add Smooks
Resource>Value</property></emphasis>
- .</para>
-
- <figure>
- <title> Mapping Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start12.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure><note>
- <title>Note:</title>
- <para>Please, remember that the root nodes of the source data and target data
*MUST* be
- connected.</para>
- <para>This rule is not only for Java-to-Java, but also is relevant for
- XML-to-Java </para>
- </note>
- <para> Do the same operation with the
- other properties in this and other classes.</para>
- <para>It's also necessary to bind <emphasis>
- <property>orderItems</property></emphasis> property of the
<emphasis>
- <property>Order</property></emphasis> to <emphasis>
- <property>lineItems</property></emphasis> property of
<emphasis>
- <property>LineOrder</property></emphasis>.The difference from the
previous steps is that the <emphasis>
- <property>orderItems</property></emphasis> is presented by the
list of <emphasis>
- <property>Order</property></emphasis> and <emphasis>
- <property>lineItems</property></emphasis> is the massive of
<emphasis>
- <property>LineItem</property></emphasis> .To do the
binding,you should use <emphasis>
- <property>Wiring Item</property></emphasis>.First you should
create a new Binding item. This is a configuration that allows you to construct an
object graph .Select <emphasis>
- <property>example.trgmodel.LineItem[]</property></emphasis>
in the Class field and orderItems in the Name field,in bean Id write lineItems.
- Your Smooks Configuration Editor should look like this:
- </para>
- <figure>
- <title> Creating Wiring Item</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start13a.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para> Then you should right click <emphasis>
- <property>lineOrder</property></emphasis> binding
item<emphasis>
- <property>>Add Smooks
Resource>Wiring</property></emphasis>.Select <emphasis>
- <property>lineItem</property></emphasis> in <emphasis>
- <property>Bean id Ref</property></emphasis>.
- </para>
- <para>The final step is to add new Wiring item to lineOrder
<property>Binding</property>.In the <property>Bean id
Ref</property> select <emphasis>
- <property>lineItems</property></emphasis> and in <emphasis>
- <property>Property</property></emphasis> select <emphasis>
- <property>lineItems</property></emphasis>.</para>
-<!--
- <para>Next, you are going to bind the properties of the
<property>OrderItem</property> to
- the properties of the <property>LineItem</property>.</paa>
- <para>Select the <emphasis>
- <property>"price"</property>
- </emphasis> and drag it onto the <emphasis>
- <property>"unitPrice"</property>
- </emphasis> of the other side tree viewer. The Problems area shows an
- error:</para>
- <figure>
- <title>Connection Error 1</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start12.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>How to deal with the error?</para>
- <para>Please click the <emphasis>
- <property>Fix it</property></emphasis> link, a menu is popped-up
with several
- resolve methods on it.</para>
- <figure>
- <title>Fixing the Connection Error</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start13.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para> Select the first resolve method: <emphasis>
- 'Connect the "OrderItem" to the
- "LineItem" '.</emphasis> As the result the
<emphasis>
- <property>"OrderItem"</property></emphasis> is
connected with
- the <emphasis>
- <property>"LineItem"</property>.</emphasis></para>
- <para>But the notify message area still shows some other errors:</para>
- <figure>
- <title>Connection Error 2</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start14.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>OK, let's deal with the fire error. Click the <emphasis>
- <property>Fix it</property></emphasis> link and
- select the first resolve method. The <emphasis>
- <property>"orderItems"</property></emphasis> is
connected with
- the <emphasis>
- <property>"lineItems"</property>.</emphasis></para>
-
- <tip>
- <title>Tip:</title>
- <para> Why does the error occur?</para>
- <para> You will find that, if you only connect the property node without
connecting the
- parent node of the property, the "connection error"
occurs.</para>
- <para>The connection of the "price-to-unitPrice" is the
- "Binding Connection", but it needs an "Instance Creation
- Connection" - the connection of the
- "OrderItem-to-LineItem".</para>
- </tip>
- <para> After that, connect <emphasis>
- <property>"quantity"</property></emphasis> to the
<emphasis>
- <property>"unitQuantity"</property></emphasis>
and <emphasis>
- <property>"productId"</property></emphasis> to
the
- <emphasis>
- <property>"productCode"</property>:</emphasis></para>
- <figure>
- <title>Complete Mapping</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start15.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>-->
- <para>Now, you should save the file and the <property>Smooks
tools</property> generate the correct
- configuration file content.</para>
- <para>OK, let run the test class: <property>example.Main</property>.
(Please, make sure that the Smooks engine
- loads the correct configuration file).</para>
- <para>Success!</para>
- </section>
-</chapter>
Deleted: trunk/smooks/docs/reference/en-US/smooksformeditor_configurationpage.xml
===================================================================
--- trunk/smooks/docs/reference/en-US/smooksformeditor_configurationpage.xml 2010-03-12
18:24:29 UTC (rev 20809)
+++ trunk/smooks/docs/reference/en-US/smooksformeditor_configurationpage.xml 2010-03-12
18:34:26 UTC (rev 20810)
@@ -1,270 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="smooksformeditor_configurationtab" xreflabel="Smooks
Configuration Editor Page">
- <?dbhtml filename="smooks_form_editor_configurationtab.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Smooks</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
- <title>Smooks Design Page</title>
- <para>In this section you will explore the details of Smooks Design Page
usage.</para>
- <para><property>Smooks Design Page</property> is one tab of the
<property>Smooks Editor</property>. </para>
- <figure>
- <title>Design Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page1.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>This page consists of 3 sections: Message Filtering Resources, Input Data
and the section devoted to the configurations of a selected in a Message Filtering
Resources section Item.</para>
- <para> You can bind classes <link
linkend="quickstart_mapping">using Bindings item
- </link> on the Design page of the <property>Smooks
Editor</property>. </para>
- <para><emphasis>
- <property>Resource list</property></emphasis> item in
<emphasis>
- <property>Message Filtering Resources</property></emphasis>
corresponds to the root element of the <emphasis>
- <property>smooks-config.xml</property></emphasis> file.You can
configurate the next four properties using corresponding fields:</para>
- <itemizedlist>
- <listitem><para><emphasis>
- <property>default-selector</property></emphasis>:Defines the
selector that will be applied to all resource-config elements in the <emphasis>
- <property>smooks-config.xml</property></emphasis>, where a
selector is not defined. </para></listitem>
- <listitem><para><emphasis>
- <property>default-selector-namespace</property></emphasis>:Defines
the default selector namespace. </para></listitem>
- <listitem><para><emphasis>
- <property>default-target-profile</property></emphasis>: Defines the
default target profile that will be applied to all resources in the smooks-config.xml.
</para></listitem>
- <listitem><para><emphasis>
- <property>default-condition-ref</property></emphasis>:The condition
is applied to resources where an empty "condition" element (i.e.
<code><condition/></code>)is defined.The condition element does
not reference a globally defined condition. </para></listitem>
- </itemizedlist>
- <para> The configuration editor also edits the <link
linkend="configurationpage_parsetype">Smooks parse
- type</link> and manages the <link
linkend="configurationpage_importfile">Import
- Files</link>.</para>
- <section id="selector-dialog">
- <title>Selector generate dialog</title>
- <para>Using <emphasis>
- <property>Selector generate dialog</property></emphasis> you can
allow the user to select a node for generation
<property>"selector"</property> for smooks-config file.
- To open the dialog you should left click <property>Browse</property>
button in <emphasis>
- <property>Default Selector</property></emphasis> section.
- </para>
- <figure>
- <title>Selector generate dialog</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page2a.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para> When the dialog is opened you should click <property>"Click to
add input data"</property>to set the selector.
- In the opened <emphasis>
- <property>Data Type Selection</property></emphasis> Wizard you
should choose the type of the file and the file itself you want to load to the
<emphasis>
- <property>Selector generate dialog</property></emphasis>.After
that your dialog should look nearly like that:</para>
- <figure>
- <title>Selector generate dialog after adding Input Data</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page2b.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The final step is to choose the node you want to make a selector for
<emphasis>
- <property>smooks-config.xml</property></emphasis>.</para>
- </section>
- <section id="configurationpage_parsetype">
-
- <title>Smooks Parse Type</title>
- <para>If your config file doesn't contain <emphasis>
- <property>Global Parametres</property></emphasis> item yet, you
should add it by right click <emphasis>
- <property>Resource List>Add Smooks Resource>Global
Parametres</property></emphasis>.After this step you should add
<emphasis>
- <property>Param</property></emphasis> to just created
<emphasis>
- <property>Global Parametres</property></emphasis>. </para>
- <figure>
- <title>Adding Param to created Global Parametres</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page2.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Then left click <emphasis>
- <property>Param</property>
- </emphasis>and in the Param section, you will see a set of text fields:
<emphasis>
- <property>Name</property></emphasis>,<emphasis>
- <property>Type</property></emphasis> and <emphasis>
- <property>Text</property></emphasis>.<emphasis>
- <property>Name</property></emphasis> value is required. To set a
parse type you should write SAX/DOM to the
- <emphasis>
- <property>Text</property></emphasis> field.</para>
-
- <figure>
- <title>Filling Param section field Name and Text Value for set a Parse
Type</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page3.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>To apply changes to the <emphasis>
- <property>smooks-config.xml</property></emphasis> click
<emphasis>
- <property>Save</property></emphasis> button (<emphasis>
- <property>Ctrl+S</property></emphasis>). </para>
- </section>
- <section id="configurationpage_importfile">
-
- <title>Import Smooks Configuration page</title>
- <para> Right click <emphasis>
- <property>Resource List>Add Smooks Resource>Import Smooks
Configuration</property>
- </emphasis>, then you should see a new <emphasis>
- <property>Import Smooks Configuration</property>
- </emphasis>item in the list (see the figure below).</para>
-
- <figure>
- <title>Import Data</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page3a.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Left click the added item and to the left of <emphasis>
- <property>Message Filtering Resources Import Smooks Configuration
</property></emphasis> section should appear. Click the <emphasis>
- <property>Browse</property>
- </emphasis> button and select the file you want to import(see <link
linkend="file_selection">File selection</link> section). </para>
- <para>Click <emphasis>
- <property>Save</property></emphasis> and the
<code><import></code> tag with the corresponding file path as a
<emphasis>
- <property>file</property></emphasis> property will be added to the
<emphasis>
- <property>smooks-config.xml</property></emphasis>.</para>
- </section >
- <section id="file_selection">
- <title>File selection</title>
- <para>Some attributes in Smooks elements should store path to a file as a value
- (e.g. attribute
<emphasis><property>"mappingModel"</property></emphasis>
of the element
<emphasis><property>"edi:reader"</property></emphasis>).
- You can see a Browse button near the fields, that set such a value to the attribute
- (e.g. <emphasis><property>"Mapping
Model"</property></emphasis> field set a value to the
<emphasis><property>"mappingModel"</property></emphasis>
attribute).
- </para>
- <figure>
- <title>EDI:Reader element</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page6.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>
- When you click
<emphasis><property>Browse</property></emphasis>, the dialog
prompts you click one of two buttons:
- <emphasis><property>Browse File System</property></emphasis>
and <emphasis><property>Browse WorkSpace</property></emphasis>.
- </para>
- <figure>
- <title>Browse dialog</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page7.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Using the buttons you can locate the file you need. If you click
<emphasis>
- <property>Browse File System</property></emphasis> button you
specify the path of, or browse to, a file system directory.
- </para>
- <figure>
- <title>Browse file system</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page8.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>
- If you click <emphasis><property>Browse
WorkSpace</property></emphasis> button, you specify the path of, or browse to,
a workspace relative working directory.
- </para>
- <figure>
- <title>Browse Workspace</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page9.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <!--<section id="configurationpage_datedecoder">
- <title>Date Decoder Detail Page</title>
-
- <para>Date Decoder is a resourceConfig element in the Smooks configuration file.
It
- describes how to transform the "Date" type.</para>
- <para> Click the <emphasis>
- <property>New</property>
- </emphasis> button to open the <property>New Resource Type
wizard</property>
- dialog.</para>
- <figure>
- <title>Resource Type Selection Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page4.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>There are several resource type on the list. Select the <emphasis>
- <property>Date Decoder</property>
- </emphasis> and click the <emphasis>
- <property>Finish</property>
- </emphasis> button, a new <emphasis>
- <property>Date Decoder</property>
- </emphasis> item was added and shown on the resource type list.</para>
- <para> There are several parameters in the <emphasis>
- <property>Date Decoder</property>
- </emphasis> resourceConfig element:</para>
-
- <para>
-
- <itemizedlist>
- <listitem>
- <para>Format</para>
- </listitem>
-
- <listitem>
- <para>Locale-Language</para>
-
- </listitem>
-
- <listitem>
- <para>Locale-Country</para>
-
- </listitem>
- </itemizedlist>
- </para>
-
- <para> You can modify the parameters of the <emphasis>
- <property>Date Decoder</property></emphasis> item with the left
detail page.</para>
-
- <figure>
- <title>Date Decoder Detail Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page1.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> When you defined a new <emphasis>
- <property>Date Decoder</property></emphasis>, then you can use the
<link
- linkend="graphicalpage_propertiesview">JavaBean Properties</link>
GUI to set
- it to be the "Java type".</para>
- <para>Now when we've learnt Smooks Configuration Editor Page, let's have
a look at one more Smooks Editor Page - Smooks Source Editor Page and investigate its
functionality</para>
-
-
- <para> The XML fragment generated by Smooks tools for the "Date
- Decoder": </para> <para> <programlisting>
<![CDATA[<resource-config
- selector="decoder:DateLong">
- <resource>org.milyn.javabean.decoders.DateDecoder</resource> <param
- name="locale-language">en</param> <param
name="format">yyy-MM-dd
- HH:mm:ss</param> <param name="locale-country">IE</param>
- </resource-config>]]> </programlisting> </para>
-
- </section>
-
- <section id="configurationpage_documenttype"> <title>Document
Type
- Detail Page</title> <para> </para> </section> <section
- id="configurationpage_unhandleresourceconfig"> <title>Unhandle
- ResourceConfig</title> </section>
- -->
-</chapter>
Deleted: trunk/smooks/docs/reference/en-US/smooksformeditor_graphicalpage.xml
===================================================================
--- trunk/smooks/docs/reference/en-US/smooksformeditor_graphicalpage.xml 2010-03-12
18:24:29 UTC (rev 20809)
+++ trunk/smooks/docs/reference/en-US/smooksformeditor_graphicalpage.xml 2010-03-12
18:34:26 UTC (rev 20810)
@@ -1,172 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="smooksformeditor_graphicaltab" xreflabel="Smooks Graphical
Editor Page" role="updated">
- <?dbhtml filename="smooks_form_editor_graphicaltab.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Smooks</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
- <title>Smooks Graphical Editor Page</title>
- <para>This chapter is packed with useful information about Smooks Graphical Editor
Page usage</para>
- <para>Smooks Graphical Editor page is one tab of the <property>Smooks
Editor</property>.</para>
- <figure>
- <title>Graphical Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/graph_editor/graph_editor1.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> This <property>Graphical editor</property> allows you to
perform drug/drop operations
- with the nodes of transform data to map the source data to target data. </para>
- <para> When you save the changes in the <property>Graphical
editor</property> the correct Smooks
- Configuration file content is generated. </para>
-
- <para>To adjust the properties of the connection lines in the editor, you should
use the <link
- linkend="graphicalpage_propertiesview">Properties view</link>
(activate it by following
- to <emphasis>
- <property>Window > Show View > Other > General >
Properties</property>).</emphasis></para>
-
- <para>For example, if you defined a date decoder in the <link
- linkend="configurationpage_datedecoder">Smooks Configuration
Editor</link>, in the <property>Properties view</property> you can
- select it as a Mapping type for the "Date" type
element.</para>
-
- <figure>
- <title>Browsing Custom Type for the Date Type Element</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/graph_editor/graph_editor1a.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <section>
-
- <title>Introducing the areas of graphical editor</title>
- <para>Information on the topic could be found in the <link
linkend="quickstart_formeditor"
- >Quick Start/Smooks Editor</link> section.</para>
- </section>
- <section>
-
- <title>Load Source/Target Data</title>
- <para> Click the links under the data view, the <property>Data Type
Selection
- wizard</property> page will be shown.</para>
- <figure>
- <title>Data Type Selection Wizard Page</title>
- <mediaobject>
- <imageobject>
-
- <imagedata fileref="images/graph_editor/graph_editor2.png"
scale="90"/>
-
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> There are sets of transform data type on the wizard page, select one type
and click
- <emphasis><property>Next</property>,</emphasis> the data
source selection wizard
- page will be shown.</para>
-
- <tip>
- <title>Note:</title>
- <para>For different data type, the Data source selection wizard are different
too.
- </para>
- </tip>
- <figure>
- <title>Java Data Source Selection Wizard Page</title>
- <mediaobject>
- <imageobject>
-
- <imagedata fileref="images/graph_editor/graph_editor3.png"
scale="90"/>
-
- </imageobject>
- </mediaobject>
- </figure>
-
- <figure>
- <title>XML File Path Selection Wizard Page</title>
- <mediaobject>
- <imageobject>
-
- <imagedata fileref="images/graph_editor/graph_editor4.png"
scale="90"/>
-
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> When you finish the data selection (file path selection), click
- <emphasis><property>Finish</property>,</emphasis> the data
view displays the
- selected data structure.</para>
- </section>
- <section>
-
- <title>Using Graphical Editor for Mapping</title>
- <para>To get information on the topic please, read the <link
linkend="quickstart_mapping"
- >Quick Start/Mapping</link> section. </para>
- </section>
- <section>
-
- <title>Error Messages</title>
- <para>When you do any mapping operations, the <property>Smooks
tools</property> validate the
- file content with "Mapping Logic". If there are any errors of the
configuration file
- content, error messages are shown in the <link
linkend="quickstart_formeditor">Problems
- area</link>.</para>
- <para> Please, read the <link linkend="quickstart_mapping">Quick
Start/Mapping</link>
- section to find how to fix the errors.</para>
- </section>
- <section id="graphicalpage_propertiesview">
- <title>Properties View</title>
-
- <para> You can edit the properties of the connection lines with the
<property>Properties
- view</property>.</para>
- <para>Navigate to <emphasis><property>Window > Show View >
Other >
- Properties</property>,</emphasis> to open the <property>Properties
- view</property>.</para>
- <para> When you select the connection line, the <property>Properties
view</property> will
- show a set of section GUI for editing its properties.</para>
- <tip>
-
- <title>Tip:</title>
- <para>This GUI on the <property>Properties view</property> is
displayed when the Smooks
- Graphical editor is active, if not, the <property>Properties
view</property>
- displays empty GUI.</para>
- <para>If the source data type of the selected connection line is
- "XML", the <property>Properties view</property> shows
an XML
- Properties section GUI.</para>
- <para>But if the source data type of the selected connection line is
- "Java", the XML Properties section GUI isn't
- displayed.</para>
- <para>It means that if the source/target data type of the selected connection
line is
- different, the <property>Properties view</property> shows a different
GUI.</para>
- </tip>
- <figure>
- <title>JavaBean Properties Section</title>
- <mediaobject>
- <imageobject>
-
- <imagedata fileref="images/graph_editor/graph_editor5.png"
scale="90"/>
-
- </imageobject>
- </mediaobject>
- </figure>
- <figure>
- <title>XML Properties Section</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/graph_editor/graph_editor6.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <figure>
- <title>Mapping Properties Section</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/graph_editor/graph_editor7.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>To discover about other Editor pages, read the next chapters</para>
- </section>
-</chapter>
Deleted: trunk/smooks/docs/reference/en-US/smooksformeditor_sourcepage.xml
===================================================================
--- trunk/smooks/docs/reference/en-US/smooksformeditor_sourcepage.xml 2010-03-12 18:24:29
UTC (rev 20809)
+++ trunk/smooks/docs/reference/en-US/smooksformeditor_sourcepage.xml 2010-03-12 18:34:26
UTC (rev 20810)
@@ -1,83 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="smooksformeditor_sourcetab" xreflabel="Smooks Source
Editor Page">
- <?dbhtml filename="smooks_form_editor_sourcetab.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Smooks</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
- <title>Smooks Source Editor Page</title>
- <para>This section provides information about Smooks Source Editor
Page.</para>
- <section>
- <title>XML Source Editor</title>
- <para>You can use this editor to edit the Smooks Configuration file directly.
</para>
- <figure>
- <title>Graphical Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/source_editor/source_editor1.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section>
- <title>Error underlining in Graphical Editor</title>
- <para>If the <property>Smooks tools</property> can't
understand the configuration
- file or the configuration file is illegal (XML structure isn't right for
Smooks
- Configuration file, etc.), the error is underlined.</para>
- <figure>
- <title>Graphical Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/source_editor/source_editor2.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <!--note>
- <title>Tip:</title>
- <para> When the error message panel is displayed, other editors ( Graphical
Editor,
- Configuration Editor ) are disabled. </para>
- <para> You can't edit the configuration file with other editors until file
becomes
- valid. </para>
- </note-->
-
-
-
- </section>
-
- <section>
- <title>Smooks Configuration File Validator</title>
- <para>Smooks configuration file validator will validate your Smooks configuration
file. Just right-click on the file and then click on the
<property>Validate</property> button. The validator can be enabled/disabled in
<emphasis><property>Window -> Preferences ->
Validation</property></emphasis>:</para>
-
- <figure>
- <title>Validation: Smooks Configuration File Validator</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/source_editor/smooks_conf_validator.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You can set up your Smooks validator to include, exclude groups to validate
and specify rules for validation. Just click on the
<property>Settings</property> button and use the options
provided:</para>
-
- <figure>
- <title>Smooks Configuration File Validator Settings</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/source_editor/smooks_conf_validator_settings.png"
scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para>We hope, our guide will help you to get started with JBoss Smooks Tools.
Besides, for additional information you are welcome on <ulink
-
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
forum</ulink>.</para>
-
- </section>
-
-
-
-
-</chapter>