Create new JBoss Tools Documentation Jira issue

This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.

JBoss.orgCommunity Documentation

Smooks Dev Tools Reference Guide

Version: 1.1.0.M2

November 2008


1. Introduction
1.1. Key Features of Smooks Tools
1.2. What is Smooks?
1.3. What is Smooks Tools?
1.4. How to install Smooks dev tools?
2. Quick Start
2.1. Download Smooks Java-to-Java Example
2.2. Smooks Configuration File Wizard
2.3. Smooks Editor
2.4. Choosing the transform data
2.5. Mapping
3. Smooks Design Page
3.1. Selector generate dialog
3.2. Smooks Parse Type
3.3. Import Data
4. Smooks Source Editor Page
4.1. XML Source Editor
4.2. Error Messages GUI

This chapter gives you a short introduction to Smooks, Smooks tools and its installation.

First, have a look at the key features of Smooks tools:

The Smooks tools was included by the JBoss Tools since 3.0.0 Beta1 version. You can download the JBoss Tools from JBoss download site.

Smooks tools (JBoss Tools) run with the latest Eclipse and other required plug-ins (GEF, EMF, etc.).

You should download the latest IDE for Java EE developers from Eclipse site. It contains many plug-ins ( GEF, EMF, etc. ) required by Smooks dev tools.

Now let's progress to more advanced topics.

This "Quick Start" will show how to use the Smooks tools to create/edit the Smooks configuration file for Java2Java data transformation.

This chapter gives you a brief understanding of the Smooks tools.

Visit here to download the "java-to-java" example project.

Tip:

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.

How to map the java class just added?

First, you should know what to transform:

Make sense? You should right click Resource List , select Add Smooks Resource>Java Binding>Bindings.

First of all, you should bind Order to LineOrder. To do this one Bindings Item should be added to the Resource List.


Click on it and you should see Bindings Section to the right of Message Filtering Resources.Write lineOrder in the Bean id field.

Select example.trgmodel.LineOrder in the Class field and example.srcmodel.Order in the Name field.Your Smooks Configuration Editor should look like this:


Now you should bind two values "customerNumber" property of the Order#header to the "customerId" property of LineOrder.To do this right click your just created Bindings Item >Add Smooks Resource>Value .


Note:

Please, remember that the root nodes of the source data and target data *MUST* be connected.

This rule is not only for Java-to-Java, but also is relevant for XML-to-Java

Do the same operation with the other properties in this and other classes.

It's also necessary to bind orderItems property of the Order to lineItems property of LineOrder.The difference from the previous steps is that the orderItems is presented by the list of Order and lineItems is the massive of LineItem .To do the binding,you should use Wiring Item.First you should create a new Binding item. This is a configuration that allows you to construct an object graph .Select example.trgmodel.LineItem[] in the Class field and orderItems in the Name field,in bean Id write lineItems. Your Smooks Configuration Editor should look like this:


Then you should right click lineOrder binding item >Add Smooks Resource>Wiring.Select lineItem in Bean id Ref.

The final step is to add new Wiring item to lineOrder Binding.In the Bean id Ref select lineItems and in Property select lineItems.

Now, you should save the file and the Smooks tools generate the correct configuration file content.

OK, let run the test class: example.Main. (Please, make sure that the Smooks engine loads the correct configuration file).

Success!

In this section you will explore the details of Smooks Design Page usage.

Smooks Design Page is one tab of the Smooks Editor.


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.

You can bind classes using Bindings item on the Design page of the Smooks Editor.

Resource list item in Message Filtering Resources corresponds to the root element of the smooks-config.xml file.You can configurate the next four properties using corresponding fields:

  • default-selector:Defines the selector that will be applied to all resource-config elements in the smooks-config.xml, where a selector is not defined.

  • default-selector-namespace:Defines the default selector namespace.

  • default-target-profile: Defines the default target profile that will be applied to all resources in the smooks-config.xml.

  • default-condition-ref:The condition is applied to resources where an empty "condition" element (i.e. <condition/>)is defined.The condition element does not reference a globally defined condition.

The configuration editor also edits the Smooks parse type and manages the Import Files.

This section provides information about Smooks Source Editor Page.