uk.co.lakesidetech.springxmldb.dao
Interface IXPathXMLDBDao

All Known Implementing Classes:
BaseXPathXMLDBDao

public interface IXPathXMLDBDao

Defines a Dao for querying a collection in a XML database with a xpath query

Author:
Stuart Eccles

Method Summary
 java.util.Map queryResourceWithXPathCollectionAsDOM(java.lang.String resourceId, java.lang.String xPathQuery, java.lang.String collectionPath)
          Query a particular with xpath and return a map of results with keys of the resource IDs and values of w3c DOM documents of the results (not necessarily the resource documents, but the result of the query)
 java.util.Map queryResourceWithXPathCollectionAsString(java.lang.String resourceId, java.lang.String xPathQuery, java.lang.String collectionPath)
          Query a particular with xpath and return a map of results with keys of the resource IDs and values of String xml of the results (not necessarily the resource documents, but the result of the query)
 java.util.Map queryWithXPathCollectionAsDOM(java.lang.String xPathQuery, java.lang.String collectionPath)
          Query a collection with xpath and return a map of results with keys of the resource IDs and values of w3c DOM documents of the results (not necessarily the resource documents, but the result of the query)
 java.util.Map queryWithXPathCollectionAsString(java.lang.String xPathQuery, java.lang.String collectionPath)
          Query a collection with xpath and return a map of results with keys of the resource IDs and values of Strings of the results (not necessarily the resource documents, but the result of the query)
 

Method Detail

queryWithXPathCollectionAsDOM

public java.util.Map queryWithXPathCollectionAsDOM(java.lang.String xPathQuery,
                                                   java.lang.String collectionPath)
                                            throws XMLDBDataAccessException
Query a collection with xpath and return a map of results with keys of the resource IDs and values of w3c DOM documents of the results (not necessarily the resource documents, but the result of the query)

Parameters:
xPathQuery - the xpath query to use
collectionPath - the collection path to query (note some XML databases will also query child collections by default)
Returns:
a Map of the resourceIDs and query results
Throws:
XMLDBDataAccessException - if anything goes wrong with he query

queryWithXPathCollectionAsString

public java.util.Map queryWithXPathCollectionAsString(java.lang.String xPathQuery,
                                                      java.lang.String collectionPath)
                                               throws XMLDBDataAccessException
Query a collection with xpath and return a map of results with keys of the resource IDs and values of Strings of the results (not necessarily the resource documents, but the result of the query)

Parameters:
xPathQuery - the xpath query to use
collectionPath - the collection path to query (note some XML databases will also query child collections by default)
Returns:
a Map of the resourceIDs and query results
Throws:
XMLDBDataAccessException - if anything goes wrong with he query

queryResourceWithXPathCollectionAsDOM

public java.util.Map queryResourceWithXPathCollectionAsDOM(java.lang.String resourceId,
                                                           java.lang.String xPathQuery,
                                                           java.lang.String collectionPath)
                                                    throws XMLDBDataAccessException
Query a particular with xpath and return a map of results with keys of the resource IDs and values of w3c DOM documents of the results (not necessarily the resource documents, but the result of the query)

Parameters:
resourceId - the resource to query
xPathQuery - the xpath query to use
collectionPath - the collection path to find the resource
Returns:
a Map of the resourceIDs and query results
Throws:
XMLDBDataAccessException - if anything goes wrong with he query

queryResourceWithXPathCollectionAsString

public java.util.Map queryResourceWithXPathCollectionAsString(java.lang.String resourceId,
                                                              java.lang.String xPathQuery,
                                                              java.lang.String collectionPath)
                                                       throws XMLDBDataAccessException
Query a particular with xpath and return a map of results with keys of the resource IDs and values of String xml of the results (not necessarily the resource documents, but the result of the query)

Parameters:
resourceId - the resource to query
xPathQuery - the xpath query to use
collectionPath - the collection path to find the resource
Returns:
a Map of the resourceIDs and query results
Throws:
XMLDBDataAccessException - if anything goes wrong with he query