org.smooks.cartridges.javabean

Class ValueBinder

java.lang.Object

org.smooks.cartridges.javabean.ValueBinder

All Implemented Interfaces:

org.smooks.api.delivery.ContentHandler, org.smooks.api.delivery.ordering.Producer, org.smooks.api.resource.visitor.sax.ng.AfterVisitor, org.smooks.api.resource.visitor.sax.ng.BeforeVisitor, org.smooks.api.resource.visitor.sax.ng.ChildrenVisitor, org.smooks.api.resource.visitor.sax.ng.SaxNgVisitor, org.smooks.api.resource.visitor.Visitor

public class ValueBinder
extends Object
implements org.smooks.api.resource.visitor.sax.ng.BeforeVisitor, org.smooks.api.resource.visitor.sax.ng.AfterVisitor, org.smooks.api.resource.visitor.sax.ng.ChildrenVisitor, org.smooks.api.delivery.ordering.Producer

Value Binder.

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

XML Schema & Namespace

The Value Binder XML configuration schema is in the following XML Schema Namespace:

https://www.smooks.org/xsd/smooks/javabean-1.6.xsd

The value binder element is '<value>'. Take a look in the schema for all the configuration attributes.

Programmatic configuration

The value binder can be programmatic configured using the Value Object.

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

 <?xml version="1.0"?>
 <smooks-resource-list xmlns="https://www.smooks.org/xsd/smooks-1.2.xsd" xmlns:jb="https://www.smooks.org/xsd/smooks/javabean-1.6.xsd">

    <jb:value
       beanId="customerName"
       data="customer"
       default="unknown"
    />

    <jb:value
       beanId="customerNumber"
       data="customer/@number"
             decoder="Integer"
    />

 </smooks-resource-list>
 

Author:

maurice.zeijen@smies.com

Field Summary

Fields

Modifier and Type	Field and Description
protected org.smooks.api.ApplicationContext	applicationContext
protected org.smooks.api.bean.repository.BeanId	beanId
protected String	beanIdName
protected Optional<String>	defaultValue
protected boolean	isAttribute
protected static org.slf4j.Logger	LOGGER
protected String	typeAlias
protected org.smooks.api.converter.TypeConverter<? super String,?>	typeConverter
protected Optional<String>	valueAttributeName

Constructor Summary

Constructors

Constructor and Description
ValueBinder()
ValueBinder(String beanId)

Method Summary

Modifier and Type	Method and Description
protected void	bindValue(String dataString, org.smooks.api.ExecutionContext executionContext, org.smooks.api.delivery.fragment.Fragment<?> source)
protected Object	decodeDataString(String dataString, org.smooks.api.ExecutionContext executionContext)
String	getBeanIdName()
String	getDefaultValue()
Set<?>	getProducts()
String	getTypeAlias()
org.smooks.api.converter.TypeConverter<? super String,?>	getTypeConverter()
protected org.smooks.api.converter.TypeConverter<? super String,?>	getTypeConverter(org.smooks.api.ExecutionContext executionContext)
String	getValueAttributeName()
void	postConstruct() Set the resource configuration on the bean populator.
void	setBeanIdName(String beanIdName)
void	setDefaultValue(String defaultValue)
void	setTypeAlias(String typeAlias)
void	setTypeConverter(org.smooks.api.converter.TypeConverter<? super String,?> typeConverter)
void	setValueAttributeName(String valueAttributeName)
void	visitAfter(Element element, org.smooks.api.ExecutionContext executionContext)
void	visitBefore(Element element, org.smooks.api.ExecutionContext executionContext)
void	visitChildElement(Element childElement, org.smooks.api.ExecutionContext executionContext)
void	visitChildText(CharacterData characterData, org.smooks.api.ExecutionContext executionContext)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

beanIdName

@Inject
 @Named(value="beanId")
protected String beanIdName

valueAttributeName

@Inject
protected Optional<String> valueAttributeName

defaultValue

@Inject
 @Named(value="default")
protected Optional<String> defaultValue

typeAlias

@Inject
 @Named(value="type")
protected String typeAlias

beanId

protected org.smooks.api.bean.repository.BeanId beanId

applicationContext

@Inject
protected org.smooks.api.ApplicationContext applicationContext

isAttribute

protected boolean isAttribute

typeConverter

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

Constructor Detail

ValueBinder

public ValueBinder()

ValueBinder

public ValueBinder(String beanId)

Parameters:

beanId -

Method Detail

getBeanIdName

public String getBeanIdName()

Returns:

the beanIdName

setBeanIdName

public void setBeanIdName(String beanIdName)

Parameters:

beanIdName - the beanIdName to set

getValueAttributeName

public String getValueAttributeName()

Returns:

the valueAttributeName

setValueAttributeName

public void setValueAttributeName(String valueAttributeName)

Parameters:

valueAttributeName - the valueAttributeName to set

getDefaultValue

public String getDefaultValue()

Returns:

the defaultValue

setDefaultValue

public void setDefaultValue(String defaultValue)

Parameters:

defaultValue - the defaultValue to set

getTypeAlias

public String getTypeAlias()

Returns:

the typeAlias

setTypeAlias

public void setTypeAlias(String typeAlias)

Parameters:

typeAlias - the typeAlias to set

getTypeConverter

public org.smooks.api.converter.TypeConverter<? super String,?> getTypeConverter()

Returns:

the decoder

setTypeConverter

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

Parameters:

typeConverter - the decoder to set

postConstruct

@PostConstruct
public void postConstruct()
                                  throws org.smooks.api.SmooksConfigException

Set the resource configuration on the bean populator.

Throws:

org.smooks.api.SmooksConfigException - Incorrectly configured resource.

visitBefore

public void visitBefore(Element element,
                        org.smooks.api.ExecutionContext executionContext)
                 throws org.smooks.api.SmooksException

Specified by:

visitBefore in interface org.smooks.api.resource.visitor.sax.ng.BeforeVisitor

Throws:

org.smooks.api.SmooksException

visitAfter

public void visitAfter(Element element,
                       org.smooks.api.ExecutionContext executionContext)
                throws org.smooks.api.SmooksException

Specified by:

visitAfter in interface org.smooks.api.resource.visitor.sax.ng.AfterVisitor

Throws:

org.smooks.api.SmooksException

bindValue

protected void bindValue(String dataString,
                         org.smooks.api.ExecutionContext executionContext,
                         org.smooks.api.delivery.fragment.Fragment<?> source)

getProducts

public Set<?> getProducts()

Specified by:

getProducts in interface org.smooks.api.delivery.ordering.Producer

decodeDataString

protected Object decodeDataString(String dataString,
                                  org.smooks.api.ExecutionContext executionContext)
                           throws org.smooks.api.converter.TypeConverterException

Throws:

org.smooks.api.converter.TypeConverterException

getTypeConverter

protected org.smooks.api.converter.TypeConverter<? super String,?> getTypeConverter(org.smooks.api.ExecutionContext executionContext)
                                                                             throws org.smooks.api.converter.TypeConverterException

Throws:

org.smooks.api.converter.TypeConverterException

visitChildText

public void visitChildText(CharacterData characterData,
                           org.smooks.api.ExecutionContext executionContext)
                    throws org.smooks.api.SmooksException

Specified by:

visitChildText in interface org.smooks.api.resource.visitor.sax.ng.ChildrenVisitor

Throws:

org.smooks.api.SmooksException

visitChildElement

public void visitChildElement(Element childElement,
                              org.smooks.api.ExecutionContext executionContext)
                       throws org.smooks.api.SmooksException

Specified by:

visitChildElement in interface org.smooks.api.resource.visitor.sax.ng.ChildrenVisitor

Throws:

org.smooks.api.SmooksException