org.milyn.persistence

Class EntityLocator

java.lang.Object

org.milyn.persistence.EntityLocator

All Implemented Interfaces:

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

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

DAO Locator

This DAO locator uses lookup methods or methods that accept a query to lookup entities from a data source. In case of a query it depends on the DAO or the Scribe adapter what the query language is.

Configuration

Namespace: http://www.milyn.org/xsd/smooks/persistence-1.2.xsd
Element: locator
Attributes: Take a look at the schema for all the information on the configurations parameters.

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:locator beanId="entity" lookup="something" lookupOnElement="b">
      <dao:params>
         <dao:value name="arg1" decoder="Integer" data="c" />
         <dao:expression name="arg2">dAnde.d + dAnde.e</dao:expression>
         <dao:wiring name="arg3" beanIdRef="dAnde" wireOnElement="e" />
         <dao:value name="arg4" data="f/@name" />
         <dao:value name="arg5" decoder="Date" data="g" >
            <dao:decodeParam name="format">yyyy-MM-dd HH:mm:ss</dao:decodeParam>
         </dao:value>
      </dao:params>
  </dao:locator>

  <dao:locator beanId="customer" lookupOnElement="b">
     <dao:query>from Customer c where c.id = :arg1</dao:query>
     <dao:params>
        <dao:value name="arg1" decoder="Integer" data="c" />
     </dao:params>
  </dao:locator>
 </smooks-resource-list>
 

Author:

maurice.zeijen@smies.com

Constructor Summary

Constructors

Constructor and Description
EntityLocator()

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	initParameterContainer(ExecutionContext executionContext)
void	lookup(ExecutionContext executionContext, Fragment source)
Object	lookup(Object dao, ExecutionContext executionContext)
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

EntityLocator

public EntityLocator()

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.

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(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.

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.

initParameterContainer

public void initParameterContainer(ExecutionContext executionContext)

lookup

public void lookup(ExecutionContext executionContext,
                   Fragment source)

lookup

public Object lookup(Object dao,
                     ExecutionContext executionContext)