org.milyn.javabean

Class ValueBinder

java.lang.Object

org.milyn.javabean.ValueBinder

All Implemented Interfaces:

ContentHandler, DOMElementVisitor, DOMVisitAfter, DOMVisitBefore, DOMVisitor, Producer, SAXVisitAfter, SAXVisitBefore, SAXVisitor, Visitor

public class ValueBinder
extends Object
implements DOMElementVisitor, SAXVisitBefore, SAXVisitAfter, 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:

http://www.milyn.org/xsd/smooks/javabean-1.3.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="http://www.milyn.org/xsd/smooks-1.1.xsd" xmlns:jb="http://www.milyn.org/xsd/smooks/javabean-1.3.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

Constructor Summary

Constructors

Constructor and Description
ValueBinder()
ValueBinder(String beanId)

Method Summary

Modifier and Type	Method and Description
String	getBeanIdName()
DataDecoder	getDecoder()
String	getDefaultValue()
Set<? extends Object>	getProducts() Get the set of products produced by this producer instance.
String	getTypeAlias()
String	getValueAttributeName()
void	initialize() Set the resource configuration on the bean populator.
void	setBeanIdName(String beanIdName)
void	setDecoder(DataDecoder decoder)
void	setDefaultValue(String defaultValue)
void	setTypeAlias(String typeAlias)
void	setValueAttributeName(String valueAttributeName)
void	visitAfter(Element element, ExecutionContext executionContext) Visit the supplied element after visiting its child elements.
void	visitAfter(SAXElement element, ExecutionContext executionContext) Visit the supplied element after visiting its child elements.
void	visitBefore(Element element, ExecutionContext executionContext) Visit the supplied element before visiting its child elements.
void	visitBefore(SAXElement element, ExecutionContext executionContext) Visit the supplied element before visiting its child elements.

Methods inherited from class java.lang.Object

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

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

getDecoder

public DataDecoder getDecoder()

Returns:

the decoder

setDecoder

public void setDecoder(DataDecoder decoder)

Parameters:

decoder - the decoder to set

initialize

@Initialize
public void initialize()
                            throws SmooksConfigurationException

Set the resource configuration on the bean populator.

Throws:

SmooksConfigurationException - Incorrectly configured resource.

visitBefore

public void visitBefore(Element element,
                        ExecutionContext executionContext)
                 throws SmooksException

Description copied from interface: DOMVisitBefore

Visit the supplied element before visiting its child elements.

Specified by:

visitBefore in interface DOMVisitBefore

Parameters:

element - The DOM element being visited.

executionContext - Request relative instance.

Throws:

SmooksException - Element processing failure.

visitAfter

public void visitAfter(Element element,
                       ExecutionContext executionContext)
                throws SmooksException

Description copied from interface: DOMVisitAfter

Visit the supplied element after visiting its child elements.

Specified by:

visitAfter in interface DOMVisitAfter

Parameters:

element - The DOM element being visited.

executionContext - Request relative instance.

Throws:

SmooksException - Element processing failure.

visitBefore

public void visitBefore(SAXElement element,
                        ExecutionContext executionContext)
                 throws SmooksException,
                        IOException

Description copied from interface: SAXVisitBefore

Visit the supplied element before visiting its child elements.

Specified by:

visitBefore in interface SAXVisitBefore

Parameters:

element - The SAX element being visited.

executionContext - Execution context.

Throws:

SmooksException - Event processing failure.

IOException - Error writing event to output writer.

visitAfter

public void visitAfter(SAXElement element,
                       ExecutionContext executionContext)
                throws SmooksException,
                       IOException

Description copied from interface: SAXVisitAfter

Visit the supplied element after visiting its child elements.

Specified by:

visitAfter in interface SAXVisitAfter

Parameters:

element - The SAX element being visited.

executionContext - Execution context.

Throws:

SmooksException - Event processing failure.

IOException - Error writing event to output writer.

getProducts

public Set<? extends Object> getProducts()

Description copied from interface: Producer

Get the set of products produced by this producer instance.

Specified by:

getProducts in interface Producer

Returns:

The set the set of products produced by this producer instance.