com.adaptris.core.services.metadata.xpath

Class MultiItemMetadataXpathQuery

java.lang.Object

com.adaptris.core.services.metadata.xpath.XpathQueryImpl

com.adaptris.core.services.metadata.xpath.MetadataXpathQueryImpl

com.adaptris.core.services.metadata.xpath.MultiItemMetadataXpathQuery

All Implemented Interfaces:

XpathMetadataQuery, XpathObjectQuery, XpathQuery

public class MultiItemMetadataXpathQuery
extends MetadataXpathQueryImpl
implements XpathQuery

XpathQuery implementation that retuns a multiple text items from an xpath derived from metadata.

In the adapter configuration file this class is aliased as multi-item-metadata-xpath-query which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.services.metadata.xpath.XpathQueryImpl

logR

Constructor Summary

Constructors

Constructor and Description
MultiItemMetadataXpathQuery()
MultiItemMetadataXpathQuery(java.lang.String metadataKey, java.lang.String xpathMetadataKey)
MultiItemMetadataXpathQuery(java.lang.String metadataKey, java.lang.String xpathMetadataKey, java.lang.String separator)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSeparator()
MetadataElement	resolveXpath(org.w3c.dom.Document doc, XPath xpath, java.lang.String expr) Executes an Xpath query.
void	setSeparator(java.lang.String s) Set the separator used to separate items.

Methods inherited from class com.adaptris.core.services.metadata.xpath.MetadataXpathQueryImpl

createXpathQuery, getXpathMetadataKey, setXpathMetadataKey, verify

Methods inherited from class com.adaptris.core.services.metadata.xpath.XpathQueryImpl

allowEmptyResults, getAllowEmptyResults, getMetadataKey, setAllowEmptyResults, setMetadataKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.services.metadata.xpath.XpathMetadataQuery

createXpathQuery, getMetadataKey, verify

Constructor Detail

MultiItemMetadataXpathQuery

public MultiItemMetadataXpathQuery()

MultiItemMetadataXpathQuery

public MultiItemMetadataXpathQuery(java.lang.String metadataKey,
                                   java.lang.String xpathMetadataKey)

MultiItemMetadataXpathQuery

public MultiItemMetadataXpathQuery(java.lang.String metadataKey,
                                   java.lang.String xpathMetadataKey,
                                   java.lang.String separator)

Method Detail

resolveXpath

public MetadataElement resolveXpath(org.w3c.dom.Document doc,
                                    XPath xpath,
                                    java.lang.String expr)
                             throws CoreException

Description copied from interface: XpathQuery

Executes an Xpath query.

Specified by:

resolveXpath in interface XpathObjectQuery

Specified by:

resolveXpath in interface XpathQuery

Parameters:

doc - The XML document

xpath - the XPath object to use to resolve any expressions.

expr - the xpath expression

Returns:

a MetadataElement with the configured key and the extracted text value

Throws:

CoreException

getSeparator

public java.lang.String getSeparator()

setSeparator

public void setSeparator(java.lang.String s)

Set the separator used to separate items.

Parameters:

s - the separator, default '|'