Create new JBoss Tools Documentation Jira issue
This will launch the Jboss Tools Jira page - to complete your feedback please login if needed, and submit the Jira.
JBoss.orgCommunity Documentation
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 smooks examples page to download the "java-to-java" example project.
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.
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 example.sourcemodel.Order , its structure looks like this :
Let's describe the structure of example.sourcemodel.Order in short:
Order class contains a Header class and a List class.
The Header class has customerName,customerNumber,priority as properties.
In Order class the objects of the OrderItem class are stored in the List.
OrderItem has price,productId,quantity as its properties.
Let's look at the transform target Java class : LineOrder.
On the screen below you can see its structure:
LineOrder class contains 3 properties:customerId,customerName,priority and an array of lineItems.
The Header class has customerName,customerNumber,priority as its properties.
OrderItem objects are stored in a List.
Now it's the time to define the mapping rules to transform the input source java class to the target java class:
Each instance of the Order class should be mapped with an instance of the LineOrder class.
The value of customerName of the Header class should be assigned to the customerName property of a LineOrder instance.
The value of customerNumber of the Header class should be assigned to the customerId property of a LineOrder instance.
The value of priority of the Header class should be assigned to the priority property of LineOrder instance.
For the orderitems 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.
The value of productId of the OrderItem instance should be assigned to the 'productCode' of LineItem.
The value of price of OrderItem should be assigned to the unitPrice of LineItem.
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.
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.
The second wizard page is allows you to select Smooks configuration file version. Select the appropriate one and click Finish to complete the wizard.
When all the wizard steps are passed, a new Smooks Configuration file is created and the Smooks Configuration Editor will be opened automatically:
On the bottom of this editor there are 5 tabs, they are : Overview, Reader, Message Filter, Graph, Source.
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
To choose the transform data you should open Reader tab and click Add button in the Input Data section.
After clicking the button the Data Type Selection wizard is opened, and there are many data types in the list: Java, XML etc.
There will become more and more data types on the list as the development goes on.
Select the Java data type and click Next, you will see the JavaBean class selection page:
Let's select the Order class from the example project as the source JavaBean class.After that click Finish and you should see the just added java class, being displayed in the Input Data Section.
After adding the input data, let's switch to the Message Filter page:
Click the Add button, the Add Child wizard page will be shown, let's select the Java Binding v1.2 -> Bean v1.2 and click OK to add the Bean :
Then we can find on the Message Filter page the Bean v1.2 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 Bean v1.2 properties:
You should input lineOrder as the Bean's id in the "Bean Id" field.Then you should click Browse button near the Class textfield and select LineOrder as the Bean's class.
When you enter a value for the Class 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).
Let's click the Add Binding 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.
Then you should add an array of beans called lineItems and a Bean LineItem.These two classes and Id values are:
Array Bean:
BeanId : lineItems;
Class : example.trgmodel.LineItem[]
LineItem Bean :
BeanId : lineItem;
Class : example.trgmodel.LineItem
In Smooks , to be an array of Beans , the class value should end with '[]'. This means that this bean is an array type.
To finish this work, use the Add Binding link to add all the bindings for the Bean.
How to map the java class just added?
First, you should know what to transform:
Bind the "customerName" property of the Order#header to the "customerName" property of LineOrder.
Bind the "customerNumber" property of the Order#header to the "customerId" property of LineOrder.
Bind the "price" property of the OrderItem to the "unitPrice" property of LineItem.
Bind the "productId" property of the OrderItem to the "productCode" property of LineItem.
Bind the "quantity" property of the OrderItem to the "unitQuantity" property of LineItem.
Make sense? You should open Design tab and click Add button. In opened Add Child Wizard,please, 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 .
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!
