org.milyn.persistence

Class EntityInserter

java.lang.Object

org.milyn.persistence.EntityInserter

All Implemented Interfaces:

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

@VisitBeforeIf(condition="parameters.containsKey(\'insertBefore\') && parameters.insertBefore.value == \'true\'")
 @VisitAfterIf(condition="!parameters.containsKey(\'insertBefore\') || parameters.insertBefore.value != \'true\'")
public class EntityInserter
extends Object
implements DOMElementVisitor, SAXVisitBefore, SAXVisitAfter, Consumer, Producer

DAO Inserter

This DAO inserter calls the insert method of a DAO, using a entity bean from the bean context as parameter.

Configuration

Namespace: http://www.milyn.org/xsd/smooks/persistence-1.2.xsd
Element: inserter
Attributes:

• beanId : The id under which the entity bean is bound in the bean context. (required)
• insertOnElement : The element selector to select the element when the inserter should execute. (required)
• dao : The name of the DAO that will be used. If it is not set then the default DAO is used. (optional)
• name* : The name of the insert method. Depending of the adapter this can mean different things. For instance when using annotated DAO's you can name the methods and target them with this property, but when using the Ibatis adapter you set the id of the Ibatis statement in this attribute. (optional)
• insertedBeanId : The bean id under which the inserted bean will be stored. If not set then the object returned by the insert method will not be stored in bean context. (optional)
• insertBefore : If the inserter should execute on the 'before' event. (default: false)

* This attribute is not supported by all scribe adapters.

Configuration Example

 <?xml version="1.0"?>
 <smooks-resource-list xmlns="http://www.milyn.org/xsd/smooks-1.1.xsd"
   xmlns:dao="http://www.milyn.org/xsd/smooks/persistence-1.2.xsd">

      <dao:inserter dao="dao" name="insertIt" beanId="toInsert" insertOnElement="root" insertBeanId="inserted" insertBefore="false" />

 </smooks-resource-list>
 

Author:

maurice.zeijen@smies.com

Constructor Summary

Constructors

Constructor and Description
EntityInserter()

Method Summary

Modifier and Type	Method and Description
boolean	consumes(Object object) Does this consumer consume the specified named object.
Set<? extends Object>	getProducts() Get the set of products produced by this producer instance.
void	initialize()
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

EntityInserter

public EntityInserter()

Method Detail

initialize

@Initialize
public void initialize()
                            throws SmooksConfigurationException

Throws:

SmooksConfigurationException

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.

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.