org.milyn.javabean

Class BeanInstancePopulator

java.lang.Object

org.milyn.javabean.BeanInstancePopulator

All Implemented Interfaces:

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

public class BeanInstancePopulator
extends Object
implements DOMElementVisitor, SAXVisitBefore, SAXVisitAfter, Producer, Consumer

Bean instance populator visitor class.

Author:

tom.fennelly@gmail.com, maurice.zeijen@smies.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	NOTIFY_POPULATE
static String	VALUE_ATTRIBUTE_NAME
static String	VALUE_ATTRIBUTE_PREFIX

Constructor Summary

Constructors

Constructor and Description
BeanInstancePopulator()

Method Summary

Modifier and Type	Method and Description
boolean	consumes(Object object) Does this consumer consume the specified named object.
String	getBeanId()
SmooksResourceConfiguration	getConfig()
DataDecoder	getDecoder()
DataDecoder	getDecoder(ContentDeliveryConfig deliveryConfig)
Set<? extends Object>	getProducts() Get the set of products produced by this producer instance.
String	getProperty()
String	getWireBeanId()
void	initialize() Set the resource configuration on the bean populator.
boolean	isBeanWiring()
void	populateAndSetPropertyValue(Object bean, BeanContext beanContext, BeanId targetBeanId, ExecutionContext executionContext, Fragment source)
void	setBeanId(String beanId)
void	setDecoder(DataDecoder decoder)
void	setDefaultVal(String defaultVal)
void	setExpression(MVELExpressionEvaluator expression)
void	setProperty(String property)
void	setPropertyValue(String mapPropertyName, Object dataObject, ExecutionContext executionContext, Fragment source)
void	setSetterMethod(String setterMethod)
void	setTypeAlias(String typeAlias)
void	setValueAttributeName(String valueAttributeName)
void	setValueAttributePrefix(String valueAttributePrefix)
void	setWireBeanId(String wireBeanId)
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

Field Detail

VALUE_ATTRIBUTE_NAME

public static final String VALUE_ATTRIBUTE_NAME

See Also:

Constant Field Values

VALUE_ATTRIBUTE_PREFIX

public static final String VALUE_ATTRIBUTE_PREFIX

See Also:

Constant Field Values

NOTIFY_POPULATE

public static final String NOTIFY_POPULATE

See Also:

Constant Field Values

Constructor Detail

BeanInstancePopulator

public BeanInstancePopulator()

Method Detail

getConfig

public SmooksResourceConfiguration getConfig()

setBeanId

public void setBeanId(String beanId)

getBeanId

public String getBeanId()

setWireBeanId

public void setWireBeanId(String wireBeanId)

getWireBeanId

public String getWireBeanId()

setExpression

public void setExpression(MVELExpressionEvaluator expression)

setProperty

public void setProperty(String property)

getProperty

public String getProperty()

setSetterMethod

public void setSetterMethod(String setterMethod)

setValueAttributeName

public void setValueAttributeName(String valueAttributeName)

setValueAttributePrefix

public void setValueAttributePrefix(String valueAttributePrefix)

setTypeAlias

public void setTypeAlias(String typeAlias)

setDecoder

public void setDecoder(DataDecoder decoder)

getDecoder

public DataDecoder getDecoder()

setDefaultVal

public void setDefaultVal(String defaultVal)

isBeanWiring

public boolean isBeanWiring()

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.

populateAndSetPropertyValue

public void populateAndSetPropertyValue(Object bean,
                                        BeanContext beanContext,
                                        BeanId targetBeanId,
                                        ExecutionContext executionContext,
                                        Fragment source)

setPropertyValue

public void setPropertyValue(String mapPropertyName,
                             Object dataObject,
                             ExecutionContext executionContext,
                             Fragment source)

getDecoder

public DataDecoder getDecoder(ContentDeliveryConfig deliveryConfig)

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.

consumes

public boolean consumes(Object object)

Description copied from interface: Consumer

Does this consumer consume the specified named object.

The named object would be a product of a Producer that is executing on the same element. The consumer should only return false if it knows for certain that it doesn't consumer the specified named object. If uncertain, it should error on the side of saying that it does consume the object.

Specified by:

consumes in interface Consumer

Parameters:

object - The product representation

Returns:

True if the consumer consumes the specified product, otherwise false.