Bean (Milyn :: Smooks Cartridge :: Javabean 1.7.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.milyn.javabean
Class Bean

java.lang.Object
  org.milyn.javabean.BindingAppender
      org.milyn.javabean.Bean

All Implemented Interfaces:: org.milyn.delivery.VisitorAppender

public class Bean
extends BindingAppender
extends BindingAppender

Programmatic Bean Configurator.

This class can be used to programmatically configure a Smooks instance for performing a Java Bindings on a specific class. To populate a graph, you simply create a graph of Bean instances by binding Beans onto Beans.

This class uses a Fluent API (all methods return the Bean instance), making it easy to string configurations together to build up a graph of Bean configuration.

Example

Taking the "classic" Order message as an example and binding it into a corresponding Java Object model.

The Message

 <order xmlns="http://x">
     <header>
         <y:date xmlns:y="http://y">Wed Nov 15 13:45:28 EST 2006</y:date>
         <customer number="123123">Joe</customer>
         <privatePerson></privatePerson>
     </header>
     <order-items>
         <order-item>
             <product>111</product>
             <quantity>2</quantity>
             <price>8.90</price>
         </order-item>
         <order-item>
             <product>222</product>
             <quantity>7</quantity>
             <price>5.20</price>
         </order-item>
     </order-items>
 </order>

The Java Model

(Not including getters and setters):

 public class Order {
     private Header header;
     private List<OrderItem> orderItems;
 }
 public class Header {
     private Long customerNumber;
     private String customerName;
 }
 public class OrderItem {
     private long productId;
     private Integer quantity;
     private double price;
 }

The Binding Configuration and Execution Code

The configuration code (Note: Smooks instance defined and instantiated globally):

 Smooks smooks = new Smooks();

 Bean orderBean = new Bean(Order.class, "order", "/order");
 orderBean.bindTo("header",
     orderBean.newBean(Header.class, "/order")
         .bindTo("customerNumber", "header/customer/@number")
         .bindTo("customerName", "header/customer")
     ).bindTo("orderItems",
     orderBean.newBean(ArrayList.class, "/order")
         .bindTo(orderBean.newBean(OrderItem.class, "order-item")
             .bindTo("productId", "order-item/product")
             .bindTo("quantity", "order-item/quantity")
             .bindTo("price", "order-item/price"))
     );

 smooks.addVisitors(orderBean);

And the execution code:

 JavaResult result = new JavaResult();

 smooks.filterSource(new StreamSource(orderMessageStream), result);
 Order order = (Order) result.getBean("order");

Author:: tom.fennelly@jboss.com
See Also:: Value

Constructor Summary
`Bean(Class<?> beanClass, String beanId)` Create a Bean binding configuration.
`Bean(Class<?> beanClass, String beanId, String createOnElement)` Create a Bean binding configuration.
`Bean(Class<?> beanClass, String beanId, String createOnElement, String createOnElementNS)` Create a Bean binding configuration.
`Bean(Class<T> beanClass, String beanId, Factory<? extends T> factory)` Create a Bean binding configuration.
`Bean(Class<T> beanClass, String beanId, String createOnElement, Factory<? extends T> factory)` Create a Bean binding configuration.
`Bean(Class<T> beanClass, String beanId, String createOnElement, String createOnElementNS, Factory<? extends T> factory)` Create a Bean binding configuration.

Method Summary

void addVisitors(org.milyn.delivery.VisitorConfigMap visitorMap)
Add the visitors, associated with this Bean instance, to the visitor map.

Bean bindTo(Bean bean)
Add a bean binding configuration to this Collection/array bean binding config.

Bean bindTo(String dataSelector)
Create a binding configuration to bind the data, selected from the message by the dataSelector, to the target Collection/array Bean beanclass instance.

Bean bindTo(String bindingMember, Bean bean)
Add a bean binding configuration for the specified bindingMember (field/method) to this bean binding config.

Bean bindTo(String dataSelector, org.milyn.javabean.DataDecoder dataDecoder)
Create a binding configuration to bind the data, selected from the message by the dataSelector, to the target Collection/array Bean beanclass instance.

Bean bindTo(String bindingMember, String dataSelector)
Create a binding configuration to bind the data, selected from the message by the dataSelector, to the specified bindingMember (field/method).

Bean bindTo(String bindingMember, String dataSelector, org.milyn.javabean.DataDecoder dataDecoder)
Create a binding configuration to bind the data, selected from the message by the dataSelector, to the target Bean member specified by the bindingMember param.

static Method getBindingMethod(String bindingMember, Class<?> beanClass)
Get the bean binding class Member (field/method).

Bean newBean(Class<?> beanClass, String createOnElement)
Create a Bean binding configuration.

Bean newBean(Class<?> beanClass, String beanId, String createOnElement)
Create a Bean binding configuration.

static Bean newBean(Class<?> beanClass, String beanId, String createOnElement, String createOnElementNS)
Create a Bean binding configuration.





<T> Bean

newBean(Class<T> beanClass,
        String createOnElement,
        Factory<T> factory)