Author: irooskov(a)redhat.com Date: 2010-03-09 19:34:57 -0500 (Tue, 09 Mar 2010) New Revision: 20719 Added: trunk/smooks/docs/reference/en-US/ trunk/smooks/docs/reference/en-US/Author_Group.xml trunk/smooks/docs/reference/en-US/Book_Info.xml trunk/smooks/docs/reference/en-US/Preface.xml trunk/smooks/docs/reference/en-US/Revision_History.xml trunk/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent trunk/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml trunk/smooks/docs/reference/en-US/images/ trunk/smooks/docs/reference/en-US/images/config_page/ trunk/smooks/docs/reference/en-US/images/config_page/config_page1.png trunk/smooks/docs/reference/en-US/images/config_page/config_page2.png trunk/smooks/docs/reference/en-US/images/config_page/config_page2a.png trunk/smooks/docs/reference/en-US/images/config_page/config_page2b.png trunk/smooks/docs/reference/en-US/images/config_page/config_page3.png trunk/smooks/docs/reference/en-US/images/config_page/config_page3a.png trunk/smooks/docs/reference/en-US/images/config_page/config_page6.png trunk/smooks/docs/reference/en-US/images/config_page/config_page7.png trunk/smooks/docs/reference/en-US/images/config_page/config_page8.png trunk/smooks/docs/reference/en-US/images/config_page/config_page9.png trunk/smooks/docs/reference/en-US/images/favicon.ico trunk/smooks/docs/reference/en-US/images/graph_editor/ trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor1.png trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor1a.png trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor2.png trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor3.png trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor4.png trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor5.png trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor6.png trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor7.png trunk/smooks/docs/reference/en-US/images/introduction/ trunk/smooks/docs/reference/en-US/images/introduction/introduction1.png trunk/smooks/docs/reference/en-US/images/introduction/introduction2.png trunk/smooks/docs/reference/en-US/images/jbosstools_logo.png trunk/smooks/docs/reference/en-US/images/process_page/ trunk/smooks/docs/reference/en-US/images/process_page/process1.png trunk/smooks/docs/reference/en-US/images/process_page/process2.png trunk/smooks/docs/reference/en-US/images/process_page/process3.png trunk/smooks/docs/reference/en-US/images/process_page/process4.png trunk/smooks/docs/reference/en-US/images/process_page/process5.png trunk/smooks/docs/reference/en-US/images/process_page/process6.png trunk/smooks/docs/reference/en-US/images/process_page/process7.png trunk/smooks/docs/reference/en-US/images/process_page/process7a.png trunk/smooks/docs/reference/en-US/images/process_page/process7b.png trunk/smooks/docs/reference/en-US/images/process_page/process7c.png trunk/smooks/docs/reference/en-US/images/process_page/process8.png trunk/smooks/docs/reference/en-US/images/quick_start/ trunk/smooks/docs/reference/en-US/images/quick_start/quick_start1.png trunk/smooks/docs/reference/en-US/images/quick_start/quick_start10.png trunk/smooks/docs/reference/en-US/images/quick_start/quick_start11.png trunk/smooks/docs/reference/en-US/images/quick_start/quick_start12.png trunk/smooks/docs/reference/en-US/images/quick_start/quick_start13a.png trunk/smooks/docs/reference/en-US/images/quick_start/quick_start2.png trunk/smooks/docs/reference/en-US/images/quick_start/quick_start6.png trunk/smooks/docs/reference/en-US/images/quick_start/quick_start7.png trunk/smooks/docs/reference/en-US/images/quick_start/quick_start8.png trunk/smooks/docs/reference/en-US/images/quick_start/quick_start9.png trunk/smooks/docs/reference/en-US/images/quick_start/quick_start9a.png trunk/smooks/docs/reference/en-US/images/quick_start/quick_start9b.png trunk/smooks/docs/reference/en-US/images/quick_start/quick_start9c.png trunk/smooks/docs/reference/en-US/images/quick_start/quick_start_6a.png trunk/smooks/docs/reference/en-US/images/quick_start/sourcemodel_structured.jpg trunk/smooks/docs/reference/en-US/images/quick_start/targetmodel_structured.jpg trunk/smooks/docs/reference/en-US/images/reference/ trunk/smooks/docs/reference/en-US/images/reference/reference_1.png trunk/smooks/docs/reference/en-US/images/reference/reference_10.png trunk/smooks/docs/reference/en-US/images/reference/reference_11.png trunk/smooks/docs/reference/en-US/images/reference/reference_2.png trunk/smooks/docs/reference/en-US/images/reference/reference_3.png trunk/smooks/docs/reference/en-US/images/reference/reference_4.png trunk/smooks/docs/reference/en-US/images/reference/reference_5.png trunk/smooks/docs/reference/en-US/images/reference/reference_6.png trunk/smooks/docs/reference/en-US/images/reference/reference_7.png trunk/smooks/docs/reference/en-US/images/reference/reference_7a.png trunk/smooks/docs/reference/en-US/images/reference/reference_8.png trunk/smooks/docs/reference/en-US/images/reference/reference_9.png trunk/smooks/docs/reference/en-US/images/source_editor/ trunk/smooks/docs/reference/en-US/images/source_editor/smooks_conf_validator.png trunk/smooks/docs/reference/en-US/images/source_editor/smooks_conf_validator_settings.png trunk/smooks/docs/reference/en-US/images/source_editor/source_editor1.png trunk/smooks/docs/reference/en-US/images/source_editor/source_editor2.png trunk/smooks/docs/reference/en-US/introduction.xml trunk/smooks/docs/reference/en-US/master.xml trunk/smooks/docs/reference/en-US/master_output.xml 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/references.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 trunk/smooks/docs/reference/en-US/summary.xml trunk/smooks/docs/reference/en-US/tasks.xml trunk/smooks/docs/reference/publican.cfg Removed: trunk/smooks/docs/reference/en/ Modified: trunk/smooks/docs/reference/pom.xml Log: modified book to build with publican and maven Added: trunk/smooks/docs/reference/en-US/Author_Group.xml =================================================================== --- trunk/smooks/docs/reference/en-US/Author_Group.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/Author_Group.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,7 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<authorgroup><author> + <firstname>Xue(Dart)</firstname> + <surname>Peng</surname> + </author></authorgroup> Added: trunk/smooks/docs/reference/en-US/Book_Info.xml =================================================================== --- trunk/smooks/docs/reference/en-US/Book_Info.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/Book_Info.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<bookinfo><title>Smooks Developer Tools Reference Guide</title><subtitle>Provides information relating to the Smooks Tools module.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The Smooks Developer Tools Reference Guide explains how to use Smooks Tools to graphically edit Smooks configuration files.</para></abstract><corpauthor><inlinemediaobject><imageobject><imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"></imagedata></imageobject></inlinemediaobject></corpauthor><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... Added: trunk/smooks/docs/reference/en-US/Preface.xml =================================================================== --- trunk/smooks/docs/reference/en-US/Preface.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/Preface.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<preface><title>Preface</title><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... Added: trunk/smooks/docs/reference/en-US/Revision_History.xml =================================================================== --- trunk/smooks/docs/reference/en-US/Revision_History.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/Revision_History.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<appendix><title>Revision History</title><simpara><revhistory><revision><revnumber>0</revnumber><date>Fri Nov 20 2009</date><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov@redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: trunk/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent =================================================================== --- trunk/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent (rev 0) +++ trunk/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.ent 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "Smooks_Developer_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: trunk/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml =================================================================== --- trunk/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/Smooks_Developer_Tools_Reference_Guide.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,12 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<book> +<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="tasks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="references.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="summary.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +</book> Added: trunk/smooks/docs/reference/en-US/images/config_page/config_page1.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/config_page/config_page1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/config_page/config_page2.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/config_page/config_page2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/config_page/config_page2a.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/config_page/config_page2a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/config_page/config_page2b.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/config_page/config_page2b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/config_page/config_page3.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/config_page/config_page3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/config_page/config_page3a.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/config_page/config_page3a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/config_page/config_page6.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/config_page/config_page6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/config_page/config_page7.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/config_page/config_page7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/config_page/config_page8.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/config_page/config_page8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/config_page/config_page9.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/config_page/config_page9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor1.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor1a.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor1a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor2.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor3.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor4.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor5.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor6.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor7.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/graph_editor/graph_editor7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/introduction/introduction1.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/introduction/introduction1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/introduction/introduction2.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/introduction/introduction2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/process_page/process1.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/process_page/process1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/process_page/process2.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/process_page/process2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/process_page/process3.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/process_page/process3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/process_page/process4.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/process_page/process4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/process_page/process5.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/process_page/process5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/process_page/process6.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/process_page/process6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/process_page/process7.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/process_page/process7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/process_page/process7a.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/process_page/process7a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/process_page/process7b.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/process_page/process7b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/process_page/process7c.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/process_page/process7c.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/process_page/process8.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/process_page/process8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start1.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start10.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start11.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start11.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start12.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start12.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start13a.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start13a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start2.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start6.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start7.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start8.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start9.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start9a.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start9a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start9b.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start9b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start9c.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start9c.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start_6a.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/quick_start_6a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/sourcemodel_structured.jpg =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/sourcemodel_structured.jpg ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/quick_start/targetmodel_structured.jpg =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/quick_start/targetmodel_structured.jpg ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/reference/reference_1.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/reference/reference_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/reference/reference_10.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/reference/reference_10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/reference/reference_11.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/reference/reference_11.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/reference/reference_2.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/reference/reference_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/reference/reference_3.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/reference/reference_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/reference/reference_4.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/reference/reference_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/reference/reference_5.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/reference/reference_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/reference/reference_6.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/reference/reference_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/reference/reference_7.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/reference/reference_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/reference/reference_7a.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/reference/reference_7a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/reference/reference_8.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/reference/reference_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/reference/reference_9.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/reference/reference_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/source_editor/smooks_conf_validator.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/source_editor/smooks_conf_validator.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/source_editor/smooks_conf_validator_settings.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/source_editor/smooks_conf_validator_settings.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/source_editor/source_editor1.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/source_editor/source_editor1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/images/source_editor/source_editor2.png =================================================================== (Binary files differ) Property changes on: trunk/smooks/docs/reference/en-US/images/source_editor/source_editor2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/smooks/docs/reference/en-US/introduction.xml =================================================================== --- trunk/smooks/docs/reference/en-US/introduction.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/introduction.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,195 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="introduction"> + <?dbhtml filename="introduction.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Smooks</keyword> + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Introduction</title> + <para>This chapter gives you a short introduction to Smooks, Smooks tools and its installation.</para> + <para>First, have a look at the key features of Smooks tools:</para> + <section> + <title>Key Features of Smooks Tools</title> + <para>Here, we provide you with a key functionality which is integrated in Smooks tools.</para> + <table> + + <title>Key Functionality for Smooks Tools</title> + <tgroup cols="3"> + + <colspec colnum="1" align="left" colwidth="2*"/> + <colspec colnum="2" colwidth="4*"/> + <colspec colnum="3" align="left" colwidth="2*"/> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry><para>Smooks Configuration File Wizard</para></entry> + <entry><para>Smooks tools allows to create/edit the Smooks configuration file for Java2Java data transformation.</para></entry> + <entry> + <link linkend="config_file_wizzard">Smooks Configuration File Wizard</link> + </entry> + </row> + + <row> + <entry><para>Smooks Editor</para></entry> + <entry><para>Smooks Editor helps configure the created Smooks configuration file.</para></entry> + <entry> + <link linkend="process_tab">Smooks Editor</link> + </entry> + </row> + + </tbody> + + </tgroup> + </table> + + + + </section> + + + + <section> + <title>What is Smooks?</title> + + <para><property>Smooks</property> is a Java Framework/Engine for processing XML and non XML + data (CSV, EDI, Java, JSON etc).It provides: </para> + <para/> + <para> + <orderedlist numeration="upperroman" inheritnum="inherit"> + <listitem> + <para><emphasis role="bold">Transformation</emphasis>: Perform a wide range of + Data Transforms. Supports many different Source and Result types + -XML/CSV/EDI/Java/JSON to XML/CSV/EDI/Java/JSON.</para> + </listitem> + <listitem> + <para><emphasis role="bold">Java Binding</emphasis>: Bind into a Java Object + Model from any data source (CSV, EDI, XML, Java, JSON etc). </para> + </listitem> + + <listitem> + <para><emphasis role="bold">Huge Message Processing</emphasis>: Process huge + messages (GBs) - Split, Transform and Route message fragments to JMS, File, + Database etc destinations. Route multiple message formats to multiple + destinations in a single pass over a message. </para> + </listitem> + + <listitem> + <para><emphasis role="bold">Message Enrichment</emphasis>: Enrich a message with + data from a Database, or other Datasources. </para> + </listitem> + + <listitem> + <para><emphasis role="bold">Combine</emphasis>: Combine the above features in + different ways e.g. add Message Enrichment as part of a Splitting and + Routing process. </para> + </listitem> + </orderedlist> + </para> + <figure> + <title>Smooks</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/introduction/introduction1.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + <para> For more informations about <property>Smooks</property>, please visit <ulink + url="http://www.smooks.org">Smooks official site</ulink>.</para> + </section> + <section> + <title>What is Smooks Tools?</title> + + <para>Smooks tools is a set of graphical tools for editing Smooks configuration file + based on Eclipse.</para> + <figure> + <title>Smooks Form editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/introduction/introduction2.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + <!-- <para>The easiest way to use the Smooks Configuration Editor is to create a project + (Java project, an ESB project, etc.), right-click on it and select <property>New -> Other</property> + to open the New wizard. Drill into <property>Smooks -> Smooks Configuration File</property> + and continue through the wizard. + Once the file is created, it will open in the Smooks Configuration Editor.</para> --> + </section> + <section> + <title>Adding Smooks jars</title> + + <para>During your development, you probably will be faced with the + necessity to include some additional Smooks jars to your project. + This problem can be solved in such a way:</para> + <itemizedlist> + <listitem><para>Create the folder named "lib" inside your project,if it doesn't exist yet. + Copy all the Smooks jars you need to include into the <emphasis><property>lib</property></emphasis> directory. + </para></listitem> + <listitem><para>Right-click on the project and select Properties.</para></listitem> + <listitem><para>Select the "Java Build Path" item in the Properties list, then the Libraries tab, and click "Add JARs". + </para></listitem> + <listitem><para>In the Jar Selection dialog, select all the jars in the "lib" directory you want to include and click OK.</para></listitem> + <listitem><para> + Now you should see all the jars + included to your project hierarchy. </para></listitem> + </itemizedlist> + + <figure> + <title>Smooks Form editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/introduction/introduction2.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + <!-- <para>The easiest way to use the Smooks Configuration Editor is to create a project + (Java project, an ESB project, etc.), right-click on it and select <property>New -> Other</property> + to open the New wizard. Drill into <property>Smooks -> Smooks Configuration File</property> + and continue through the wizard. + Once the file is created, it will open in the Smooks Configuration Editor.</para> --> + </section> + <!-- <section> + <title>How to install Smooks dev tools?</title> + + <para> The Smooks tools was included by the <property>JBoss Tools</property> since 3.0.0 + Beta1 version. You can download the <property>JBoss Tools</property> from <ulink + url="http://jboss.org/tools/download.html">JBoss download site</ulink>.</para> + <para> Smooks tools (<property>JBoss Tools</property>) run with the latest Eclipse and + other required plug-ins (GEF, EMF, etc.).</para> + <para> You should download the latest IDE for Java EE developers from <ulink + url="http://www.eclipse.org/downloads/"> Eclipse site</ulink>. It contains many plug-ins ( + GEF, EMF, etc. ) required by Smooks dev tools. </para> + <para>The Smooks Configuration depends on having all of the appropriate Smooks runtime jars in the path of the Eclipse Plug-in or Java Project in the Eclipse workspace. + + The easiest solution is to do the following: + <itemizedlist> + <listitem><para>1) Download the Smooks distribution from here: http://www.smooks.org/mediawiki/index.php?title=Downloads . + Grab the latest "ALL" distribution (as of today, it is the Smooks v.1.2.2 "ALL" distribution) and it will include binaries, examples, etc.</para></listitem> + <listitem><para>2) Extract files from the archive somewhere on your machine.</para></listitem> + <listitem><para>3) In your Eclipse workspace, copy the Smooks jars into a directory of your Eclipse plug-in or Java project named "lib".</para></listitem> + <listitem><para>4) For your Eclipse Plug-in or Java Project, right-click on the project and select Properties.</para></listitem> + <listitem><para>5) Select the "Java Build Path" item in the Properties list, select the Libraries tab, and click "Add JARs" + </para></listitem> + <listitem><para>6) In the Jar Selection dialog, select all the jars in the "lib" directory mentioned in step 3 and click <property>OK</property>. + </para></listitem> + <listitem><para>7) Click <property>OK</property> to close the Properties dialog. Now you should see a "Referenced Libraries" node that appeared in your project hierarchy in Eclipse. + </para></listitem> + </itemizedlist> + + </para> + <para>Now let's progress to more advanced topics.</para> + </section> + --> +</chapter> Added: trunk/smooks/docs/reference/en-US/master.xml =================================================================== --- trunk/smooks/docs/reference/en-US/master.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/master.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[ +<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY tasks SYSTEM "tasks.xml"> +<!ENTITY references SYSTEM "references.xml"> +<!ENTITY summary SYSTEM "summary.xml"> +]> +<book> + + <bookinfo> + + <title>Smooks Developer Tools Reference Guide</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata format="PNG" fileref="images/jbosstools_logo.png" /> + </imageobject> + <imageobject role="html"> + <imagedata/> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author> + <firstname>Xue(Dart)</firstname> + <surname>Peng</surname> + </author> + <copyright> + <year>2009,2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 1.1.0.GA + </releaseinfo> + + <abstract> + <title/> + <para> + <ulink + url="http://download.jboss.org/jbosstools/nightly-docs/en/smooks/pdf... version</ulink> + </para> + </abstract> + + + </bookinfo> + <toc/> + &introduction; + &tasks; + &references; + &summary; +</book> Added: trunk/smooks/docs/reference/en-US/master_output.xml =================================================================== --- trunk/smooks/docs/reference/en-US/master_output.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/master_output.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,939 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[ +<!ENTITY introduction SYSTEM "modules/introduction.xml"> +<!ENTITY tasks SYSTEM "modules/tasks.xml"> +<!ENTITY references SYSTEM "modules/references.xml"> +<!ENTITY summary SYSTEM "modules/summary.xml"> +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + + <title>Smooks Dev Tools Reference Guide</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + </imageobject> + <imageobject role="html"> + <imagedata></imagedata> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author> + <firstname>Xue(Dart)</firstname> + <surname>Peng</surname> + </author> + <copyright> + <year>2009,2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo><diffmk:wrapper diffmk:change="changed"> + Version: 1.1.0.GA + </diffmk:wrapper></releaseinfo> + + <abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/smooks/pdf... version</ulink> + </para> + </abstract> + + + </bookinfo> + <toc></toc> + +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/smooks/docs/reference/en/modules/introduction.xml"> + <?dbhtml filename="introduction.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Smooks</keyword> + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Introduction</title> + <para>This chapter gives you a short introduction to Smooks, Smooks tools and its installation.</para> + <para>First, have a look at the key features of Smooks tools:</para> + <section> + <title>Key Features of Smooks Tools</title> + <para>Here, we provide you with a key functionality which is integrated in Smooks tools.</para> + <table> + + <title>Key Functionality for Smooks Tools</title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <colspec align="left" colnum="3" colwidth="2*"></colspec> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry><para>Smooks Configuration File Wizard</para></entry> + <entry><para>Smooks tools allows to create/edit the Smooks configuration file for Java2Java data transformation.</para></entry> + <entry> + <link linkend="config_file_wizzard">Smooks Configuration File Wizard</link> + </entry> + </row> + + <row> + <entry><para>Smooks Editor</para></entry> + <entry><para>Smooks Editor helps configure the created Smooks configuration file.</para></entry> + <entry> + <link linkend="process_tab">Smooks Editor</link> + </entry> + </row> + + </tbody> + + </tgroup> + </table> + + + + </section> + + + + <section> + <title>What is Smooks?</title> + + <para><property moreinfo="none">Smooks</property> is a Java Framework/Engine for processing XML and non XML + data (CSV, EDI, Java, JSON etc).</para> + <para></para> + <para> + <orderedlist continuation="restarts" inheritnum="inherit" numeration="upperroman"> + <listitem> + <para><emphasis role="bold">Transformation</emphasis>: Perform a wide range of + Data Transforms. Supports many different Source and Result types + -XML/CSV/EDI/Java/JSON to XML/CSV/EDI/Java/JSON.</para> + </listitem> + <listitem> + <para><emphasis role="bold">Java Binding</emphasis>: Bind into a Java Object + Model from any data source (CSV, EDI, XML, Java, JSON etc). </para> + </listitem> + + <listitem> + <para><emphasis role="bold">Huge Message Processing</emphasis>: Process huge + messages (GBs) - Split, Transform and Route message fragments to JMS, File, + Database etc destinations. Route multiple message formats to multiple + destinations in a single pass over a message. </para> + </listitem> + + <listitem> + <para><emphasis role="bold">Message Enrichment</emphasis>: Enrich a message with + data from a Database, or other Datasources. </para> + </listitem> + + <listitem> + <para><emphasis role="bold">Combine</emphasis>: Combine the above features in + different ways e.g. add Message Enrichment as part of a Splitting and + Routing process. </para> + </listitem> + </orderedlist> + </para> + <figure float="0"> + <title>Smooks</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/introduction/introduction1.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> For more informations about <property moreinfo="none">Smooks</property>, please visit <ulink url="http://www.smooks.org">Smooks official site</ulink>.</para> + </section> + <section> + <title>What is Smooks Tools?</title> + + <para>Smooks tools is a set of graphical tools for editing Smooks configuration file + based on Eclipse.</para> + <figure float="0"> + <title>Smooks Form editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/introduction/introduction2.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The easiest way to use the Smooks Configuration Editor is to create a project + (Java project, an ESB project, etc.), right-click on it and select <property moreinfo="none">New -&gt; Other</property> + to open the New wizard. Drill into <property moreinfo="none">Smooks -&gt; Smooks Configuration File</property> + and continue through the wizard. We recommend using a minimum Smooks level of 1.1 or 1.2, but if you're using it in a deployed service, it depends on what version your runtime supports. + Once the file is created, it will open in the Smooks Configuration Editor.</para> + </section> + <section> + <title>How to install Smooks dev tools?</title> + + <para> The Smooks tools was included by the <property moreinfo="none">JBoss Tools</property> since 3.0.0 + Beta1 version. You can download the <property moreinfo="none">JBoss Tools</property> from <ulink url="http://jboss.org/tools/download.html">JBoss download site</ulink>.</para> + <para> Smooks tools (<property moreinfo="none">JBoss Tools</property>) run with the latest Eclipse and + other required plug-ins (GEF, EMF, etc.).</para> + <para> You should download the latest IDE for Java EE developers from <ulink url="http://www.eclipse.org/downloads/"> Eclipse site</ulink>. It contains many plug-ins ( + GEF, EMF, etc. ) required by Smooks dev tools. </para> + <para>The Smooks Configuration depends on having all of the appropriate Smooks runtime jars in the path of the Eclipse Plug-in or Java Project in the Eclipse workspace. + + The easiest solution is to do the following: + <itemizedlist> + <listitem><para>1) Download the Smooks distribution from here: http://www.smooks.org/mediawiki/index.php?title=Downloads . + Grab the latest "ALL" distribution (as of today, it is the Smooks v.1.2.2 "ALL" distribution) and it will include binaries, examples, etc.</para></listitem> + <listitem><para>2) Extract files from the archive somewhere on your machine.</para></listitem> + <listitem><para>3) In your Eclipse workspace, copy the Smooks jars into a directory of your Eclipse plug-in or Java project named "lib".</para></listitem> + <listitem><para>4) For your Eclipse Plug-in or Java Project, right-click on the project and select Properties.</para></listitem> + <listitem><para>5) Select the "Java Build Path" item in the Properties list, select the Libraries tab, and click "Add JARs" + </para></listitem> + <listitem><para>6) In the Jar Selection dialog, select all the jars in the "lib" directory mentioned in step 3 and click <property moreinfo="none">OK</property>. + </para></listitem> + <listitem><para>7) Click <property moreinfo="none">OK</property> to close the Properties dialog. Now you should see a "Referenced Libraries" node that appeared in your project hierarchy in Eclipse. + </para></listitem> + </itemizedlist> + + </para> + <para>Now let's progress to more advanced topics.</para> + </section> + +</chapter> + + +<chapter id="process_page" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/smooks/docs/reference/en/modules/tasks.xml"> + <?dbhtml filename="tasks.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Smooks</keyword> + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Tasks</title> + <para>This chapter describes the main tasks a user can be faced during Smooks tools usage.</para> + <section id="config_file_wizzard"> + <title>New Smooks Configuration File Creation</title> + <para>Select the project where you want to create new Smooks Configuration File and right-click on it, + select in the menu <emphasis><property moreinfo="none">New &gt; Other</property>,</emphasis> then find + <emphasis><property moreinfo="none">Smooks &gt; Smooks Configuration File</property>.</emphasis> + Click the <emphasis> + <property moreinfo="none">Next</property> + </emphasis> button. </para> + <figure float="0"> + <title>Selecting Smooks Configuration File Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start1.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The first wizard page is a file path creation page. Select the <emphasis> + <property moreinfo="none">src</property> + </emphasis> folder to be the files container, and input the name + <emphasis><property moreinfo="none">smooks-config.xml</property>.</emphasis> Click + <emphasis><property moreinfo="none">Next</property>.</emphasis></para> + <figure float="0"> + <title>Choosing the configuration file container and the file name</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start2.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The second wizard page allow you to select Smooks configuration file version. Select the appropriate one and click <emphasis><property moreinfo="none">Finish</property></emphasis> to complete the wizard.</para> + </section> + <section> + <title>Input Task Configuring</title> + <para> + <property moreinfo="none">Input task configuring</property> is an obligatory step for your smooks project creation. + You can configure it on the Process page of the editor: look for the "Input Task" in the Process Map at the top of the page. + </para> + <figure float="0"> + <title>Input Task Configuring</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process1.png" scale="90"></imagedata> + </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 <emphasis>Input data</emphasis> 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 <emphasis>Input model</emphasis> section. + On the picture below you can see the correct configuration of some XML input task. + </para> + <figure float="0"> + <title>Input Task Configuring</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process2.png" scale="90"></imagedata> + </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, this version + of the Smooks Configuration Editor focuses only on these 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). + <note><title>Note</title> + <para>Now you can't transform your output directly, + using only Input and Template tasks. + You should use Mapping as an interagent between these tasks.</para> + </note> + </para> + </section> + <section id="mapping"> + <title>Java Mapping Task</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 <emphasis>Input Task</emphasis> in the Process tab and click the plus (+) sign to the right of the icon. + Select <emphasis>Java Mapping</emphasis> from the popup menu and it will appear to the right, connected to <emphasis>Input Task</emphasis>. Then select <emphasis>Java Mapping</emphasis> task. + </para> + <figure float="0"> + <title>Java Mapping configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Another method of adding <emphasis>Java Mapping</emphasis> element + to the canvas in the Processing Tasks section is to right click Input Task + element and select <emphasis>Java Mapping</emphasis> in the popup menu </para> + <figure float="0"> + <title>Java Mapping configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> + Right-click on the canvas in an empty space and select "Add -&gt;Java Class". + </para> + <figure float="0"> + <title>Java Mapping configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> + <emphasis>Java Bean Creation</emphasis> 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 <emphasis>Finish</emphasis> 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 float="0"> + <title>Final Mapping schema</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process6.png"></imagedata> + </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 <emphasis>Java Mapping</emphasis> 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 float="0"> + <title>Apply Template configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process7.png"></imagedata> + </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> + <section> + <title>Smooks Configuration testing using Smooks Run Configuration</title> + + <para>This option is intended to view the results of Smooks transforming procedure. + For more detailed information about this option please go <ulink url="http://community.jboss.org/wiki/UsingtheSmooksRunConfigurationt... + </section> +</chapter> + + + +<chapter id="reference" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/smooks/docs/reference/en/modules/references.xml"> + <?dbhtml filename="reference.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Smooks</keyword> + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Reference</title> + <para>This chapter includes detailed reference information about Smooks Tools.</para> + <section> + <title>Smooks Configuration Editor</title> + <para>This chapter describes the following tabs of the Smooks Configuration Editor:</para> + + <itemizedlist> + <listitem><para><link linkend="process_tab">Process tab</link></para></listitem> + <listitem><para><link linkend="options_tab">Options tab</link></para></listitem> + <listitem><para><link linkend="smooksformeditor_sourcetab">Source tab</link></para></listitem> + </itemizedlist> + <section id="process_tab"> + <title>Process tab</title> + <para>The Process tab of the Smooks Configuration Editor helps to configure different types of transformations. + By default smooks configuration file is opened in this editor.If you have another default settings for editor opening + you should left click smooks configuration file and select:<emphasis>Open With-&gt;Smooks Configuration Editor</emphasis>.</para> + <para>The Process tab has two sections:</para> + <itemizedlist> + <listitem><para><link linkend="processing_task_section">Processing Task section</link></para></listitem> + <listitem><para><link linkend="selected_task_details">Selected Task Details section</link></para></listitem> + </itemizedlist> + <para>You can see them on the picture below.</para> + <figure float="0"> + <title>Two Sections of the Process tab.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_1.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <section id="processing_task_section"> + <title>Processing Task section</title> + <para>Using the popup menu in the Processing Task section you + can select which types of technologies(templating or mapping ones) you will use for transofmation: </para> + <para>The descriptions of the popup menu options are in the following table.</para> + <table> + <title>Process Tab. Processing Task section.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Add Task</entry> + <entry>Select one of the following tasks according to the necessary type of Source and Result types of the files: + <itemizedlist> + <listitem><para><emphasis>Input</emphasis> -this task is required and + appears automatically when Smooks config file is created. + You should just configure it properly.</para></listitem> + <listitem><para><emphasis>Java Mapping</emphasis></para></listitem> + <listitem><para><emphasis>Apply Template</emphasis></para></listitem> + </itemizedlist> + </entry> + <entry></entry> + </row> + + <row> + <entry>Delete</entry> + <entry>Click this option if you want to delete some task from the section. + Note:you can't delete input task because it's required.</entry> + <entry></entry> + + </row> + + <row> + <entry>Input Methods</entry> + <entry>Choose one of the following methods: + <itemizedlist> + <listitem><para>System</para></listitem> + <listitem><para>Simple</para></listitem> + <listitem><para>Amharic(EZ+)</para></listitem> + <listitem><para>Cedilla</para></listitem> + <listitem><para>Cyrillic</para></listitem> + <listitem><para>Inuktitut</para></listitem> + <listitem><para>IPA</para></listitem> + <listitem><para>Multipress</para></listitem> + <listitem><para>SCIM Bridge Input Method</para></listitem> + <listitem><para>SCIM Input Method</para></listitem> + <listitem><para>Thai-Lio</para></listitem> + <listitem><para>Tigrigna-Eritrean(EZ+)</para></listitem> + <listitem><para>Tigrigna-Ethiopian(EZ+)</para></listitem> + <listitem><para>Vietnamese</para></listitem> + <listitem><para>X input Method</para></listitem> + </itemizedlist> + </entry> + <entry>System</entry> + </row> + </tbody> + </tgroup> + </table> + </section> + <section id="selected_task_details"> + <title>Selected Task Details Section</title> + <para>The options of this section depends on the selected task in the Processing Task section. + Because there are 3 types of tasks there are 3 different sets of its options in the Selected Task Details Section. + They will be described one by one. </para> + <section> + <title>Selected Task Details Section for Input Task.</title> + <para>On the picture below you can find an example of Selected Task Details Section view + if XML is selected as input type.</para> + + <figure float="0"> + <title>Selected Task Details Section for Input XML Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_2.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>As you can see on the picture above Input Configuration section is empty for XML input file. + But this section has special configuration options for CSV,EDI,JSON,Custom input files.</para> + + <para>Here are the screens of these configuration options:</para> + <itemizedlist> + <listitem><para>CSV:</para> + <figure float="0"> + <title>Selected Task Details Section for Input CSV Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>EDI:</para> + <figure float="0"> + <title>Selected Task Details Section for Input EDI Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>JSON:</para> + <figure float="0"> + <title>Selected Task Details Section for Input JSON Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>Custom:</para> + <figure float="0"> + <title>Selected Task Details Section for Input Custom Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>All the input task configuration positions can be found in the table below:</para> + <table> + <title>Selected Task Details Section. Options for Input Task.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Input type</entry> + <entry>Select your type of input file. + If don't find your type in the list,you should use Custom type: + <itemizedlist> + <listitem><para>No Input</para></listitem> + <listitem><para>XML</para></listitem> + <listitem><para>Java</para></listitem> + <listitem><para>XSD/WSDL</para></listitem> + <listitem><para>CSV</para></listitem> + <listitem><para>EDI</para></listitem> + <listitem><para>JSON</para></listitem> + <listitem><para>Custom</para></listitem> + </itemizedlist> + </entry> + <entry>XML</entry> + </row> + + <row> + <entry>Input configuration + + </entry> + <entry> + <itemizedlist> + <listitem><para><emphasis>No Input</emphasis> -no info required</para></listitem> + <listitem><para><emphasis>XML</emphasis> -no info required</para></listitem> + <listitem><para><emphasis>Java</emphasis> -no info required</para></listitem> + <listitem><para><emphasis>XSD/WSDL</emphasis> -no info required</para></listitem> + <listitem><para><emphasis>CSV</emphasis></para><itemizedlist> + <listitem><para><emphasis>Fields</emphasis> -Comma separated list of CSV record field names + </para></listitem> + <listitem><para><emphasis>Separator Character</emphasis> -Field separator character. Default of ','. + </para></listitem> + <listitem><para><emphasis>Quote Character</emphasis> -Quote character. Default of '"'. + </para></listitem> + <listitem><para><emphasis>Record Name</emphasis> -Name of csv record element.Default:csv-record</para></listitem> + <listitem><para><emphasis>Root Name</emphasis> -Name of csv root element.Default:csv-set</para></listitem> + <listitem><para><emphasis>indent</emphasis> -Add indentation character data to the generated event stream. This simply makes + the generated event stream easier to read in its serialized form. Useful for + testing etc.Default:true + </para></listitem> + <listitem><para><emphasis>Skip Lines</emphasis> -Number of lines to skip before processing starts. Default of 0. + + </para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>EDI</emphasis></para> + <itemizedlist> + <listitem><para><emphasis>Target Profile</emphasis> -Defines the target profile + </para></listitem> + <listitem><para><emphasis>Encoding</emphasis> -The character encoding. Default "UTF-8"</para></listitem> + <listitem><para><emphasis>Mapping Model</emphasis> -Defines the EDI Mapping Model configuration for processing the + EDI message stream to a stream of SAX events that can be processed by Smooks.</para></listitem> + <listitem><para><emphasis>Validate</emphasis> -This attribute turns on/off datatype validation in the EDI Parser. + Validation is on by default. + It makes sense to turn datatype validation off on the EDI Reader + if the EDI data is being bound into a Java Object model. + </para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>JSON</emphasis></para> + <itemizedlist> + <listitem><para><emphasis>Target Profile</emphasis> -Defines the target profile</para></listitem> + <listitem><para><emphasis>Array Element Name</emphasis> -The element name of a array element. Default of 'element'. + </para></listitem> + <listitem><para><emphasis>Encoding</emphasis> -encoding: The default encoding of any JSON message + InputStream processed by this Reader. Default of 'UTF-8'.</para></listitem> + <listitem><para><emphasis>Illegal Element Name Char Replacement</emphasis> -If illegal characters are encountered in a JSON element name then they are replaced with this value. + By default this is not defined, so that the reader doesn't doesn't search for illegal characters. + </para></listitem> + <listitem><para><emphasis>Indent</emphasis> -Add indentation character data to the generated event stream. This simply makes + the generated event stream easier to read in its serialized form. Useful for + testing etc.Default:false. + </para></listitem> + <listitem><para><emphasis>Key Prefix on Numeric</emphasis> -The prefix character to add if the JSON node name starts with a number. + By default this is not defined, so that the reader doesn't search for element names that start with a number. + </para></listitem> + <listitem><para><emphasis>Key Whitespace Replacement</emphasis> -The replacement character for whitespaces in a JSON map key. + By default this not defined, so that the reader doesn't search for whitespaces. + </para></listitem> + <listitem><para><emphasis>Null Value Replacement</emphasis> -The replacement string for JSON NULL values. Default is ""(an empty string). </para></listitem> + <listitem><para><emphasis>Root Name</emphasis> -The element name of the document root. Default of 'json'. + </para></listitem> + <listitem><para><emphasis>Key Maps</emphasis> -Defines a JSON element name mapping + The "from" key will be replaced with the "to" key or the contents of the element. + </para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>Custom</emphasis></para> + <itemizedlist> + <listitem><para><emphasis>Target Profile</emphasis> -</para></listitem> + <listitem><para><emphasis>Class</emphasis> -Custom reader class.</para></listitem> + <listitem><para><emphasis>Handlers</emphasis> -Set a handler on the reader instance e.g. an EntityResolver, ErrorHandler etc. + </para></listitem> + <listitem><para><emphasis>Features</emphasis> -Reader Features List</para></listitem> + <listitem><para><emphasis>Parametres</emphasis> -Resource Parameters</para></listitem> + + </itemizedlist> + </listitem> + </itemizedlist></entry> + <entry><itemizedlist> + <listitem><para><emphasis>CSV</emphasis></para><itemizedlist> + <listitem><para>not defined</para></listitem> + <listitem><para>','</para></listitem> + <listitem><para>'"'</para></listitem> + <listitem><para>csv-record</para></listitem> + <listitem><para>csv-set</para></listitem> + <listitem><para>true</para></listitem> + <listitem><para>0</para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>EDI</emphasis></para> + <itemizedlist> + <listitem><para>not defined</para></listitem> + <listitem><para>UTF-8</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>true</para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>JSON</emphasis></para> + <itemizedlist> + <listitem><para>not defined</para></listitem> + <listitem><para>element</para></listitem> + <listitem><para>UTF-8</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>false</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>""(an empty string)</para></listitem> + <listitem><para>'json'</para></listitem> + <listitem><para>not defined</para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>Custom</emphasis></para> + <itemizedlist> + <listitem><para>no defaults</para></listitem> + + </itemizedlist> + </listitem> + </itemizedlist></entry> + </row> + <row> + <entry>Input Data</entry> + <entry>You should select a data file using <emphasis>Add</emphasis> and <emphasis>Delete</emphasis> buttons</entry> + <entry></entry> + </row> + <row> + <entry>Input Model View</entry> + <entry>Using this view you can see the structure of your input file.If the file has been changed, to see the changes + click <emphasis>Refresh</emphasis>link.</entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + <section id="mapping_task"><title>Selected Task Details section for Java Mapping Task.</title> + <para>Selected Task Details section for this task is presented by the graf, + that lighten the process of java mapping. </para> + <figure float="0"> + <title>Selected Task Details Section for Mapping Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_7.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> This graphical editor allow you to perform drug/drop operations with the nodes of transform data to map the source data to target data. + When you save the changes in the graphical editor the correct Smooks configuration file content will be generated. </para> + + </section> + <section><title>Selected Task Details section for Template Task.</title> + <para>Selected Task Details section for this task is presented by the graf, + that is similar to the one in the <link linkend="mapping_task">previous section</link>. + </para> + <figure float="0"> + <title>Selected Task Details Section for Template Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_7a.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + + </section> + <section id="options_tab"> + <title>Options Tab</title> + <para>This section describes Options tab of the Smooks Configuration File editor, gives short recommendations how this tab can be used during the project configuring.</para> + <figure float="0"> + <title> Options tab of the Smooks Configuration File editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_8.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <section> + <title>Smooks Configuration section</title> + <para> + In the <property moreinfo="none">Smooks Configuration</property> section of <property moreinfo="none">Options Tab</property> + only one element is availible:Smooks Platform Version + </para> + <figure float="0"> + <title>Smooks Configuration section of Options tab</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_9.png" scale="90"></imagedata> + </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 float="0"> + <title>Filter Settings section of Options tab</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_10.png" scale="90"></imagedata> + </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 align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <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> + </section> + <section id="smooksformeditor_sourcetab" xreflabel="Smooks Source Tab"> + + <title>Source Tab</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 float="0"> + <title>Graphical Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/source_editor/source_editor1.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Error underlining in Graphical Editor</title> + <para>If the <property moreinfo="none">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 float="0"> + <title>Graphical Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_11.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </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 moreinfo="none">Validate</property> button. The validator can be enabled/disabled in <emphasis><property moreinfo="none">Window -&gt; Preferences -&gt; Validation</property></emphasis>:</para> + + <figure float="0"> + <title>Validation: Smooks Configuration File Validator</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/source_editor/smooks_conf_validator.png" scale="90"></imagedata> + </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 moreinfo="none">Settings</property> button and use the options provided:</para> + + <figure float="0"> + <title>Smooks Configuration File Validator Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/source_editor/smooks_conf_validator_settings.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + </section> + </section> + </section> +</chapter> + + +<chapter xml:base="file:///home/vchukhutsina/repos/ochik_jboss/smooks/docs/reference/en/modules/summary.xml"> + <?dbhtml filename="summary.html"?> + <title>Summary</title> + <para>In conclusion, with this document you know all the capabilities of Smooks Tools and could easily start with them. + The chapters above walked you through the steps on how to create and configure some XML to JAVA mapping project. + If you have questions or suggestions concerned both the documentation and tools behavior, + you are welcome to JBoss Tools Users forum. + Please, use Jira to report bugs and requests on documentation.</para> + + <section> + <title>Other relevant resources on the topic</title> + <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at + <ulink url="http://docs.jboss.org/tools">http://docs.jboss.org/tool... in the corresponding release directory. + </para> + <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs">http...;. </para> +<para>For more information about Smooks technology please visit + <ulink url="http://www.smooks.org/mediawiki/index.php?title=Main_Page"... + Smooks Technology Home Page</ulink></para> + + </section> +</chapter> + +</book> Added: trunk/smooks/docs/reference/en-US/options_page.xml =================================================================== --- trunk/smooks/docs/reference/en-US/options_page.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/options_page.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,97 @@ +<?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> + Property changes on: trunk/smooks/docs/reference/en-US/options_page.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/smooks/docs/reference/en-US/process_page.xml =================================================================== --- trunk/smooks/docs/reference/en-US/process_page.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/process_page.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,140 @@ +<?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> + Added: trunk/smooks/docs/reference/en-US/quick_start.xml =================================================================== --- trunk/smooks/docs/reference/en-US/quick_start.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/quick_start.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,590 @@ +<?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&apos;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&apos;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&apos;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>&quot;customerName&quot;</property> + </emphasis> property of the <property>Order#header</property> to the <emphasis> + <property>&quot;customerName&quot;</property> + </emphasis> property of <property>LineOrder</property>.</para> + </listitem> + <listitem> + <para>Bind the <emphasis> + <property>&quot;customerNumber&quot;</property> + </emphasis> property of the <property>Order#header</property> to the <emphasis> + <property>&quot;customerId&quot;</property> + </emphasis> property of <property>LineOrder</property>.</para> + </listitem> + <listitem> + <para>Bind the <emphasis> + <property>&quot;price&quot;</property> + </emphasis> property of the <property>OrderItem</property> to the <emphasis> + <property>&quot;unitPrice&quot;</property> + </emphasis> property of <property>LineItem</property>.</para> + </listitem> + <listitem> + <para>Bind the <emphasis> + <property>&quot;productId&quot;</property> + </emphasis> property of the <property>OrderItem</property> to the <emphasis> + <property>&quot;productCode&quot;</property> + </emphasis> property of <property>LineItem</property>.</para> + </listitem> + <listitem> + <para>Bind the <emphasis> + <property>&quot;quantity&quot;</property> + </emphasis> property of the <property>OrderItem</property> to the <emphasis> + <property>&quot;unitQuantity&quot;</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>&quot;customerNumber&quot;</property> + </emphasis> property of the <property>Order#header</property> to the <emphasis> + <property>&quot;customerId&quot;</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>&quot;price&quot;</property> + </emphasis> and drag it onto the <emphasis> + <property>&quot;unitPrice&quot;</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 &quot;OrderItem&quot; to the + &quot;LineItem&quot; '.</emphasis> As the result the <emphasis> + <property>&quot;OrderItem&quot;</property></emphasis> is connected with + the <emphasis> + <property>&quot;LineItem&quot;</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&apos;s deal with the fire error. Click the <emphasis> + <property>Fix it</property></emphasis> link and + select the first resolve method. The <emphasis> + <property>&quot;orderItems&quot;</property></emphasis> is connected with + the <emphasis> + <property>&quot;lineItems&quot;</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 &quot;connection error&quot; occurs.</para> + <para>The connection of the &quot;price-to-unitPrice&quot; is the + &quot;Binding Connection&quot;, but it needs an &quot;Instance Creation + Connection&quot; - the connection of the + &quot;OrderItem-to-LineItem&quot;.</para> + </tip> + <para> After that, connect <emphasis> + <property>&quot;quantity&quot;</property></emphasis> to the <emphasis> + <property>&quot;unitQuantity&quot;</property></emphasis> and <emphasis> + <property>&quot;productId&quot;</property></emphasis> to the + <emphasis> + <property>&quot;productCode&quot;</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> Added: trunk/smooks/docs/reference/en-US/references.xml =================================================================== --- trunk/smooks/docs/reference/en-US/references.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/references.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,515 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="reference"> + <?dbhtml filename="reference.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Smooks</keyword> + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Reference</title> + <para>This chapter includes detailed reference information about all tabs of the Smooks Configuration Editor.</para> + <section id="process_tab"> + <title>Process tab</title> + <para>The Process tab of the Smooks Configuration Editor helps to configure different types of transformations. + By default smooks configuration file is opened in this editor.If you have another default settings for editor opening + you should left click smooks configuration file and select:<emphasis>Open With->Smooks Configuration Editor</emphasis>.</para> + <para>The Process tab has two sections:</para> + <itemizedlist> + <listitem><para><link linkend="processing_task_section">Processing Task section</link></para></listitem> + <listitem><para><link linkend="selected_task_details">Selected Task Details section</link></para></listitem> + </itemizedlist> + <para>You can see them on the picture below.</para> + <figure> + <title>Two Sections of the Process tab.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_1.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + <section id="processing_task_section"> + <title>Processing Task section</title> + <para>Using the popup menu in the Processing Task section you + can select which types of technologies(templating or mapping ones) you will use for transofmation: </para> + <para>The descriptions of the popup menu options are in the following table.</para> + <table> + <title>Process Tab. Processing Task 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>Add Task</entry> + <entry>Select one of the following tasks according to the necessary type of Source and Result types of the files: + <itemizedlist> + <listitem><para><emphasis>Input</emphasis> - this task is required and + appears automatically when Smooks config file is created. + You should just configure it properly.</para></listitem> + <listitem><para><emphasis>Java Mapping</emphasis></para></listitem> + <listitem><para><emphasis>Apply Template</emphasis></para></listitem> + </itemizedlist> + </entry> + <entry></entry> + </row> + + <row> + <entry>Delete</entry> + <entry>Click this option if you want to delete some task from the section. + Note:you can't delete input task because it's required.</entry> + <entry></entry> + + </row> + + <row> + <entry>Input Methods</entry> + <entry>Choose one of the following methods: + <itemizedlist> + <listitem><para>System</para></listitem> + <listitem><para>Simple</para></listitem> + <listitem><para>Amharic(EZ+)</para></listitem> + <listitem><para>Cedilla</para></listitem> + <listitem><para>Cyrillic</para></listitem> + <listitem><para>Inuktitut</para></listitem> + <listitem><para>IPA</para></listitem> + <listitem><para>Multipress</para></listitem> + <listitem><para>SCIM Bridge Input Method</para></listitem> + <listitem><para>SCIM Input Method</para></listitem> + <listitem><para>Thai-Lio</para></listitem> + <listitem><para>Tigrigna-Eritrean(EZ+)</para></listitem> + <listitem><para>Tigrigna-Ethiopian(EZ+)</para></listitem> + <listitem><para>Vietnamese</para></listitem> + <listitem><para>X input Method</para></listitem> + </itemizedlist> + </entry> + <entry>System</entry> + </row> + </tbody> + </tgroup> + </table> + </section> + <section id="selected_task_details"> + <title>Selected Task Details Section</title> + <para>The options of this section depends on the selected task in the Processing Task section. + Because there are 3 types of tasks there are 3 different sets of its options in the Selected Task Details Section. + They will be described one by one. </para> + <section> + <title>Selected Task Details Section for Input Task.</title> + <para>On the picture below you can find an example of Selected Task Details Section view + if XML is selected as input type.</para> + + <figure> + <title>Selected Task Details Section for Input XML Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_2.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + <para>As you can see on the picture above Input Configuration section is empty for XML input file. + But this section has special configuration options for CSV,EDI,JSON,Custom input files.</para> + + <para>Here are the screens of these configuration options:</para> + <itemizedlist> + <listitem><para>CSV:</para> + <figure> + <title>Selected Task Details Section for Input CSV Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_3.png" /> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>EDI:</para> + <figure> + <title>Selected Task Details Section for Input EDI Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_4.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>JSON:</para> + <figure> + <title>Selected Task Details Section for Input JSON Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_5.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>Custom:</para> + <figure> + <title>Selected Task Details Section for Input Custom Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_6.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>All the input task configuration positions can be found in the table below:</para> + <table> + <title>Selected Task Details Section. Options for Input Task.</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>Input type</entry> + <entry>Select your type of input file. + If don't find your type in the list,you should use Custom type: + <itemizedlist> + <listitem><para>No Input</para></listitem> + <listitem><para>XML</para></listitem> + <listitem><para>Java</para></listitem> + <listitem><para>XSD/WSDL</para></listitem> + <listitem><para>CSV</para></listitem> + <listitem><para>EDI</para></listitem> + <listitem><para>JSON</para></listitem> + <listitem><para>Custom</para></listitem> + </itemizedlist> + </entry> + <entry>XML</entry> + </row> + + <row> + <entry>Input configuration + + </entry> + <entry> + <itemizedlist> + <listitem><para><emphasis>No Input</emphasis> - no info required</para></listitem> + <listitem><para><emphasis>XML</emphasis> - no info required</para></listitem> + <listitem><para><emphasis>Java</emphasis> - no info required</para></listitem> + <listitem><para><emphasis>XSD/WSDL</emphasis> - no info required</para></listitem> + <listitem><para><emphasis>CSV</emphasis></para><itemizedlist> + <listitem><para><emphasis>Fields</emphasis> - Comma separated list of CSV record field names + </para></listitem> + <listitem><para><emphasis>Separator Character</emphasis> - Field separator character. Default of ','. + </para></listitem> + <listitem><para><emphasis>Quote Character</emphasis> - Quote character. Default of '"'. + </para></listitem> + <listitem><para><emphasis>Record Name</emphasis> - Name of csv record element.Default:csv-record</para></listitem> + <listitem><para><emphasis>Root Name</emphasis> - Name of csv root element.Default:csv-set</para></listitem> + <listitem><para><emphasis>indent</emphasis> - Add indentation character data to the generated event stream. This simply makes + the generated event stream easier to read in its serialized form. Useful for + testing etc.Default:true + </para></listitem> + <listitem><para><emphasis>Skip Lines</emphasis> - Number of lines to skip before processing starts. Default of 0. + + </para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>EDI</emphasis></para> + <itemizedlist> + <listitem><para><emphasis>Target Profile</emphasis> - Defines the target profile + </para></listitem> + <listitem><para><emphasis>Encoding</emphasis> - The character encoding. Default "UTF-8"</para></listitem> + <listitem><para><emphasis>Mapping Model</emphasis> - Defines the EDI Mapping Model configuration for processing the + EDI message stream to a stream of SAX events that can be processed by Smooks.</para></listitem> + <listitem><para><emphasis>Validate</emphasis> - This attribute turns on/off datatype validation in the EDI Parser. + Validation is on by default. + It makes sense to turn datatype validation off on the EDI Reader + if the EDI data is being bound into a Java Object model. + </para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>JSON</emphasis></para> + <itemizedlist> + <listitem><para><emphasis>Target Profile</emphasis> - Defines the output transformation profile</para></listitem> + <listitem><para><emphasis>Array Element Name</emphasis> - The element name of a array element. Default of 'element'. + </para></listitem> + <listitem><para><emphasis>Encoding</emphasis> - encoding: The default encoding of any JSON message + InputStream processed by this Reader. Default of 'UTF-8'.</para></listitem> + <listitem><para><emphasis>Illegal Element Name Char Replacement</emphasis> - If illegal characters are encountered in a JSON element name then they are replaced with this value. + By default this is not defined, so that the reader doesn't doesn't search for illegal characters. + </para></listitem> + <listitem><para><emphasis>Indent</emphasis> - Add indentation character data to the generated event stream. This simply makes + the generated event stream easier to read in its serialized form. Useful for + testing etc.Default:false. + </para></listitem> + <listitem><para><emphasis>Key Prefix on Numeric</emphasis> - The prefix character to add if the JSON node name starts with a number. + By default this is not defined, so that the reader doesn't search for element names that start with a number. + </para></listitem> + <listitem><para><emphasis>Key Whitespace Replacement</emphasis> - The replacement character for whitespaces in a JSON map key. + By default this not defined, so that the reader doesn't search for whitespaces. + </para></listitem> + <listitem><para><emphasis>Null Value Replacement</emphasis> - The replacement string for JSON NULL values. Default is ""(an empty string). </para></listitem> + <listitem><para><emphasis>Root Name</emphasis> - The element name of the document root. Default of 'json'. + </para></listitem> + <listitem><para><emphasis>Key Maps</emphasis> - Defines a JSON element name mapping + The "from" key will be replaced with the "to" key or the contents of the element. + </para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>Custom</emphasis></para> + <itemizedlist> + <listitem><para><emphasis>Target Profile</emphasis> - Defines the output transformation profile</para></listitem> + <listitem><para><emphasis>Class</emphasis> - Custom reader class.</para></listitem> + <listitem><para><emphasis>Handlers</emphasis> - Set a handler on the reader instance e.g. an EntityResolver, ErrorHandler etc. + </para></listitem> + <listitem><para><emphasis>Features</emphasis> - Reader Features List</para></listitem> + <listitem><para><emphasis>Parametres</emphasis> - Resource Parameters</para></listitem> + + </itemizedlist> + </listitem> + </itemizedlist></entry> + <entry><itemizedlist> + <listitem><para><emphasis>CSV</emphasis></para><itemizedlist> + <listitem><para>not defined</para></listitem> + <listitem><para>','</para></listitem> + <listitem><para>'"'</para></listitem> + <listitem><para>csv-record</para></listitem> + <listitem><para>csv-set</para></listitem> + <listitem><para>true</para></listitem> + <listitem><para>0</para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>EDI</emphasis></para> + <itemizedlist> + <listitem><para>not defined</para></listitem> + <listitem><para>UTF-8</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>true</para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>JSON</emphasis></para> + <itemizedlist> + <listitem><para>not defined</para></listitem> + <listitem><para>element</para></listitem> + <listitem><para>UTF-8</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>false</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>not defined</para></listitem> + <listitem><para>""(an empty string)</para></listitem> + <listitem><para>'json'</para></listitem> + <listitem><para>not defined</para></listitem> + </itemizedlist> + </listitem> + <listitem><para><emphasis>Custom</emphasis></para> + <itemizedlist> + <listitem><para>no defaults</para></listitem> + + </itemizedlist> + </listitem> + </itemizedlist></entry> + </row> + <row> + <entry>Input Data</entry> + <entry>You should select a data file using <emphasis>Add</emphasis> and <emphasis>Delete</emphasis> buttons</entry> + <entry></entry> + </row> + <row> + <entry>Input Model View</entry> + <entry>Using this view you can see the structure of your input file.If the file has been changed, to see the changes + click <emphasis>Refresh</emphasis>link.</entry> + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + <section id="mapping_task"><title>Selected Task Details section for Java Mapping Task.</title> + <para>Selected Task Details section for this task is presented by the graf, + that lighten the process of java mapping. </para> + <figure> + <title>Selected Task Details Section for Mapping Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_7.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + <para>This graphical editor allows you to perform drag&amp;drop operation with the nodes of transformed data to map the source data to target data. + When you save the changes in the graphical editor the correct Smooks configuration file content will be generated. </para> + + </section> + <section><title>Selected Task Details section for Template Task.</title> + <para>Selected Task Details section for this task is presented by the graf, + that is similar to the one in the <link linkend="mapping_task">previous section</link>. + </para> + <figure> + <title>Selected Task Details Section for Template Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_7a.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + + </section> + <section id="options_tab"> + <title>Options Tab</title> + <para>This section 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_8.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_10.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>SAX</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>false</entry> + + </row> + </tbody> + </tgroup> + </table> + </section> + </section> + <section id="smooksformeditor_sourcetab" xreflabel="Smooks Source Tab"> + + <title>Source Tab</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&apos;t understand the configuration + file or the configuration file is illegal (XML structure isn&apos;t right for Smooks + Configuration file, etc.), the error is underlined.</para> + <figure> + <title>Graphical Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_11.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + </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> + + + </section> + </section> + +</chapter> Property changes on: trunk/smooks/docs/reference/en-US/references.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/smooks/docs/reference/en-US/smooksformeditor_configurationpage.xml =================================================================== --- trunk/smooks/docs/reference/en-US/smooksformeditor_configurationpage.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/smooksformeditor_configurationpage.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,270 @@ +<?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>&lt;condition/&gt;</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>&lt;import&gt;</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 &quot;Date&quot; 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 &quot;Java type&quot;.</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> Added: trunk/smooks/docs/reference/en-US/smooksformeditor_graphicalpage.xml =================================================================== --- trunk/smooks/docs/reference/en-US/smooksformeditor_graphicalpage.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/smooksformeditor_graphicalpage.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,172 @@ +<?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 &gt; Show View &gt; Other &gt; General &gt; 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 &quot;Date&quot; 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 + &quot;XML&quot;, 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 + &quot;Java&quot;, the XML Properties section GUI isn&apos;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> Added: trunk/smooks/docs/reference/en-US/smooksformeditor_sourcepage.xml =================================================================== --- trunk/smooks/docs/reference/en-US/smooksformeditor_sourcepage.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/smooksformeditor_sourcepage.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,83 @@ +<?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&apos;t understand the configuration + file or the configuration file is illegal (XML structure isn&apos;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&amp;op=viewforum&... forum</ulink>.</para> + + </section> + + + + +</chapter> Added: trunk/smooks/docs/reference/en-US/summary.xml =================================================================== --- trunk/smooks/docs/reference/en-US/summary.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/summary.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter> + <?dbhtml filename="summary.html"?> + <title>Summary</title> + <para>In conclusion, with this document you know all the capabilities of Smooks Tools and could easily start with them. + The chapters above walked you through the steps on how to create and configure some XML to JAVA mapping project. + If you have questions or suggestions concerned both the documentation and tools behavior, + you are welcome to JBoss Tools Users forum. + Please, use Jira to report bugs and requests on documentation.</para> + + <section> + <title>Other relevant resources on the topic</title> + <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at + <ulink url="http://docs.jboss.org/tools">http://docs.jboss.org/tool... in the corresponding release directory. + </para> + <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs">http...;. </para> +<para>For more information about Smooks technology please visit + <ulink url="http://www.smooks.org/mediawiki/index.php?title=Main_Page"... + Smooks Technology Home Page</ulink></para> + + </section> +</chapter> Added: trunk/smooks/docs/reference/en-US/tasks.xml =================================================================== --- trunk/smooks/docs/reference/en-US/tasks.xml (rev 0) +++ trunk/smooks/docs/reference/en-US/tasks.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,262 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="process_page"> + <?dbhtml filename="tasks.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Smooks</keyword> + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Tasks</title> + <para>This chapter describes the main tasks a user can be faced during Smooks tools usage. + Here we use the example that can be downloaded from <ulink url="http://sourceforge.net/projects/smooks/files/Smooks%20v1.2/Smoo... </para> + <section id="config_file_wizzard"> + <title>New Smooks Configuration File Creation</title> + <para>Select the project where you want to create new Smooks Configuration File and right-click on it, + select in 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 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> + + </section> + <section> + <title>Input Task Configuring</title> + <para> + <property>Input task configuring</property> is an obligatory step for your smooks project creation. + You can configure it 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 <emphasis>Input data</emphasis> 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 <emphasis>Input model</emphasis> section. + On the picture below you can see the correct configuration of some XML input task where <emphasis><property>input-message.xml</property></emphasis> is set as an input data file. + </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, this version + of the Smooks Configuration Editor focuses only on these 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). + <note><title>Note</title> + <para>Now you can't transform your output directly, + using only Input and Template tasks. + You should use Mapping as an interagent between these tasks.</para> + </note> + </para> + </section> + <section id="mapping"> + <title>Java Mapping Task</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 <emphasis>Input Task</emphasis> in the Process tab and click the plus (+) sign to the right of the icon. + Select <emphasis>Java Mapping</emphasis> from the popup menu and it will appear to the right, connected to <emphasis>Input Task</emphasis>. Then select <emphasis>Java Mapping</emphasis> 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 <emphasis>Java Mapping</emphasis> element + to the canvas in the Processing Tasks section is to right click Input Task + element and select <emphasis>Java Mapping</emphasis> 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> + <emphasis>Java Bean Creation</emphasis> wizard appears. + Specify a unique identifier for the new class, the class path. + If the Java class is specified, you'll see a list of the properties in the box below. + Click <emphasis>Finish</emphasis> 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 <emphasis>Java Mapping</emphasis> 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 configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process7.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + The <property>Message Type Selection</property> wizard will appear. + In our example we will transfer our data to csv output format,so you should select <emphasis><property>CSV</property></emphasis> and click <property>Next</property>.</para> + <figure> + <title>Message Type Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process7a.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + On the next wizard page put the following string into the Fields,select Output fields Names and click <property>Finish</property>.</para> + <figure> + <title>CSV output message configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process7b.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + After these steps "Apply Template" task will appear to the right, connected to the task you created it from. + To continue the process of configuration you should click on it and find <emphasis>CSV Template</emphasis> + item with entered fields on the canvas.Now you can click and drag from various input elements to corresponding output elements + in the template. Make sure to connect collection elements to corresponding <emphasis>csv-record</emphasis> + In our example we transfer into CSV output only the elements of orderItems collection(see picture below) + </para> + <figure> + <title>Relations between input and output models</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process7c.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Smooks Configuration testing using Smooks Run Configuration</title> + + <para>This option is intended to view the results of Smooks transforming procedure. + To do the testing you should select your <emphasis>Smooks Configuration file</emphasis> you want to transfer in the Project Navigator or open it in + the Smooks Configuration Editor and then select "Run As..." from the <emphasis><property>Run</property></emphasis> + toolbar button + or <emphasis><property>Run->Smooks Run Configuration</property></emphasis> option in the top menu bar. And Smooks Configuration file will be run automatically. + </para> + <figure> + <title>Smooks Configuration testing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/process_page/process8.png"/> + </imageobject> + </mediaobject> + </figure> + <para>If any errors or warnings appear, they will pop up in a dialog. + The output of the test will appear in the Console view. + In our case the following streaming output will appear:</para> + <programlisting role="JAVA"><![CDATA[[Stream Templating Result ...] + |-- + |"productId","quantity","price" + |"111","2","8.9" + |"222","7","5.2" + |-- + +[Java Mapping Results...] + |-- + |> order (beanId = "order") + | > header (beanId = "header") + | > date = "2006-11-15 20:45:28.0 EET" + | > customerNumber = 123123L + | > customerName = "Joe" + | > orderItems (beanId = "orderItems") + | > example.model.OrderItem (beanId = "orderItem") + | > productId = 111L + | > quantity = 2I + | > price = 8.9D + | > example.model.OrderItem (beanId = "orderItem") + | > productId = 222L + | > quantity = 7I + | > price = 5.2D + |-- +]]></programlisting> + <para>If the test runs but doesn't generate any streaming output the Console output will be the following: + </para> + <programlisting role="JAVA"><![CDATA[ Nothing to Display: + - No Java Mappings. + - No Templates Applied.]]> + </programlisting> + + </section> +</chapter> + Modified: trunk/smooks/docs/reference/pom.xml =================================================================== --- trunk/smooks/docs/reference/pom.xml 2010-03-09 23:47:35 UTC (rev 20718) +++ trunk/smooks/docs/reference/pom.xml 2010-03-10 00:34:57 UTC (rev 20719) @@ -95,9 +95,9 @@ <configuration> <sourceDocumentName>${master}</sourceDocumentName> - <sourceDirectory>${pom.basedir}/en</sourceDirectory> + <sourceDirectory>${pom.basedir}/en-US</sourceDirectory> <imageResource> - <directory>${pom.basedir}/en</directory> + <directory>${pom.basedir}/en-US</directory> <includes> <include>images/**/*</include> </includes> Added: trunk/smooks/docs/reference/publican.cfg =================================================================== --- trunk/smooks/docs/reference/publican.cfg (rev 0) +++ trunk/smooks/docs/reference/publican.cfg 2010-03-10 00:34:57 UTC (rev 20719) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +