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

Chapter 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

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.

2.1. Download Smooks Java-to-Java Example

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.

2.2. Smooks Configuration File Wizard

updated

Select the Smooks Java-to-Java example project that you created and right-click, select the menu New > Other, then find Smooks > Smooks Configuration File. Click the Next button.

Selecting Smooks Configuration File Wizard

Figure 2.1. Selecting Smooks Configuration File Wizard


The first wizard page is a file path creation page. Select the src folder to be the files container, and input the name smooks-config.xml. Click Next.

Choosing the configuration file container and the file name

Figure 2.2. Choosing the configuration file container and the file name


The second wizard page is a Smooks configuration file version choose page.Select appropriate one and click Finish.

2.3. Smooks Editor

updated

When all the wizard steps are passed, a new Smooks Configuration file is created and the Smooks Configuration Editor will be opened automatically:

Smooks Editor

Figure 2.3. Smooks Editor


2.4. Choosing the transform data

updated

To choose the transform data you should click Add button in the Input Data section.

After clicking the button the Data Type Selection wizard is opened, and there are two data types in the list: Java and XML.

Note

There will become more and more data types on the list as the development goes on.

Data Type Wizard

Figure 2.4. Data Type Wizard


Select the Java data type and click Next, you will see the JavaBean class selection page:

JavaBean Data Selection

Figure 2.5. JavaBean Data Selection


Let's select the Order class from the example project as the source JavaBean class and the ListOrder class as the target JavaBean class.When you selected the necessary java classes, click Finish and you should see all added java classes displayed in the Input Data Section .

Displaying the Structure of the Transformed Data

Figure 2.6. Displaying the Structure of the Transformed Data


2.5. Mapping

updated

How to map the java class just added?

First, you should know what to transform:

  1. Bind the "customerName" property of the Order#header to the "customerName" property of LineOrder.

  2. Bind the "customerNumber" property of the Order#header to the "customerId" property of LineOrder.

  3. Bind the "price" property of the OrderItem to the "unitPrice" property of LineItem.

  4. Bind the "productId" property of the OrderItem to the "productCode" property of LineItem.

  5. Bind the "quantity" property of the OrderItem to the "unitQuantity" property of LineItem.

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.

Mapping

Figure 2.7. Mapping


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:

Mapping

Figure 2.8. Mapping


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 .

Mapping Editor

Figure 2.9.  Mapping Editor


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:

Creating Wiring Item

Figure 2.10.  Creating Wiring Item


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!