org.smooks.cartridges.javabean

Class Value

java.lang.Object

org.smooks.cartridges.javabean.BindingAppender

org.smooks.cartridges.javabean.Value

All Implemented Interfaces:

org.smooks.api.delivery.VisitorAppender

public class Value
extends BindingAppender

Programmatic Value Configurator.

This class can be used to programmatically configure a Smooks instance for creating value objects using the Smooks DataDecoders.

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

Example

Taking the "classic" Order message as an example and getting the order number and name as Value Objects in the form of an Integer and String.

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-items>
 </order>
 

The Binding Configuration and Execution Code

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

 Smooks smooks = new Smooks();

 Value customerNumberValue = new Value( "customerNumber", "customer/@number")
                                   .setDecoder("Integer");
 Value customerNameValue = new Value( "customerName", "customer")
                                   .setDefault("Unknown");

 smooks.addVisitors(customerNumberValue);
 smooks.addVisitors(customerNameValue);
 

And the execution code:

 JavaResult result = new JavaResult();

 smooks.filterSource(new StreamSource(orderMessageStream), result);
 Integer customerNumber = (Integer) result.getBean("customerNumber");
 String customerName = (String) result.getBean("customerName");
 

Author:

maurice.zeijen@smies.com

See Also:

Bean

Field Summary

Fields

Modifier and Type	Field and Description
protected String	dataSelector
protected String	defaultValue
protected org.smooks.api.Registry	registry
protected static Set<org.smooks.api.converter.TypeConverterFactory<?,?>>	TYPE_CONVERTER_FACTORIES
protected org.smooks.api.converter.TypeConverter<? super String,?>	typeConverter

Fields inherited from class org.smooks.cartridges.javabean.BindingAppender

beanId

Constructor Summary

Constructors

Constructor and Description
Value(String beanId, String data, Class<?> type, org.smooks.api.Registry registry) Create a Value binding configuration.
Value(String beanId, String data, org.smooks.api.Registry registry) Create a Value binding configuration.

Method Summary

Modifier and Type	Method and Description
List<org.smooks.api.delivery.ContentHandlerBinding<org.smooks.api.resource.visitor.Visitor>>	addVisitors() Used by Smooks to retrieve the visitor configuration of this Value Configuration
Value	setDefaultValue(String defaultValue) The default value for if the data is null or empty
Value	setType(Class<?> type) Set the binding value data type.
Value	setTypeConverter(org.smooks.api.converter.TypeConverter<String,?> typeConverter) The org.smooks.cartridges.javabean.DataDecoder to be used for decoding the data value.

Methods inherited from class org.smooks.cartridges.javabean.BindingAppender

getBeanId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_CONVERTER_FACTORIES

protected static volatile Set<org.smooks.api.converter.TypeConverterFactory<?,?>> TYPE_CONVERTER_FACTORIES

registry

protected final org.smooks.api.Registry registry

dataSelector

protected final String dataSelector

defaultValue

protected String defaultValue

typeConverter

protected org.smooks.api.converter.TypeConverter<? super String,?> typeConverter

Constructor Detail

Value

public Value(String beanId,
             String data,
             org.smooks.api.Registry registry)

Create a Value binding configuration.

Parameters:

beanId - The bean id under which the value will be stored.

data - The data selector for the data value to be bound.

Value

public Value(String beanId,
             String data,
             Class<?> type,
             org.smooks.api.Registry registry)

Create a Value binding configuration.

Parameters:

beanId - The bean id under which the value will be stored.

data - The data selector for the data value to be bound.

type - Data type.

Method Detail

setDefaultValue

public Value setDefaultValue(String defaultValue)

The default value for if the data is null or empty

Parameters:

defaultValue - The default value

Returns:

this Value configuration instance.

setType

public Value setType(Class<?> type)

Set the binding value data type.

Parameters:

type - The data type.

Returns:

this Value configuration instance.

setTypeConverter

public Value setTypeConverter(org.smooks.api.converter.TypeConverter<String,?> typeConverter)

The org.smooks.cartridges.javabean.DataDecoder to be used for decoding the data value.

Parameters:

targetNamespace - The org.smooks.cartridges.javabean.DataDecoder

Returns:

this Value configuration instance.

addVisitors

public List<org.smooks.api.delivery.ContentHandlerBinding<org.smooks.api.resource.visitor.Visitor>> addVisitors()

Used by Smooks to retrieve the visitor configuration of this Value Configuration