com.adaptris.core.services.metadata.xpath

Interface XpathMetadataQuery

All Known Subinterfaces:

XpathObjectQuery, XpathQuery

All Known Implementing Classes:

ConfiguredXpathNodeListQuery, ConfiguredXpathNodeQuery, ConfiguredXpathQuery, ConfiguredXpathQueryImpl, MetadataXpathNodeListQuery, MetadataXpathNodeQuery, MetadataXpathQuery, MetadataXpathQueryImpl, MultiItemConfiguredXpathQuery, MultiItemMetadataXpathQuery, XpathQueryImpl

public interface XpathMetadataQuery

Base interface for generating metadata from an xpath.

Method Summary

Modifier and Type	Method and Description
java.lang.String	createXpathQuery(AdaptrisMessage msg) Create an Xpath from the AdaptrisMessage object.
java.lang.String	getMetadataKey() Get the key that this Xpath query will be associated with.
void	verify() Verify that everything associated with the query is as it should be.

Method Detail

getMetadataKey

java.lang.String getMetadataKey()

Get the key that this Xpath query will be associated with.

verify

void verify()
     throws CoreException

Verify that everything associated with the query is as it should be.

Throws:

CoreException - wrapping any underlying exception

createXpathQuery

java.lang.String createXpathQuery(AdaptrisMessage msg)
                           throws java.lang.Exception

Create an Xpath from the AdaptrisMessage object.

Parameters:

msg - the AdaptrisMessage that will be queried.

Returns:

the xpath.

Throws:

java.lang.Exception