org.xmldb.api.modules
public interface XPathQueryService extends Service
Service
that enables the execution of
XPath queries within the context of a Collection
or against a
single XML Resource
stored in the Collection
.Modifier and Type | Method and Description |
---|---|
void |
clearNamespaces()
Removes all namespace mappings stored in the internal namespace map.
|
java.lang.String |
getNamespace(java.lang.String prefix)
Returns the URI string associated with
prefix from
the internal namespace map. |
ResourceSet |
query(java.lang.String query)
Run an XPath query against the
Collection . |
ResourceSet |
queryResource(java.lang.String id,
java.lang.String query)
Run an XPath query against an XML resource stored in the
Collection associated with this service. |
void |
removeNamespace(java.lang.String prefix)
Removes the namespace mapping associated with
prefix from
the internal namespace map. |
void |
setNamespace(java.lang.String prefix,
java.lang.String uri)
Sets a namespace mapping in the internal namespace map used to evaluate
queries.
|
getName, getVersion, setCollection
getProperty, setProperty
void setNamespace(java.lang.String prefix, java.lang.String uri) throws XMLDBException
prefix
is null or empty the default namespace is
associated with the provided URI. A null or empty uri
results
in an exception being thrown.prefix
- The prefix to set in the map. If
prefix
is empty or null the
default namespace will be associated with the provided URI.uri
- The URI for the namespace to be associated with prefix.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.java.lang.String getNamespace(java.lang.String prefix) throws XMLDBException
prefix
from
the internal namespace map. If prefix
is null or empty the
URI for the default namespace will be returned. If a mapping for the
prefix
can not be found null is returned.prefix
- The prefix to retrieve from the namespace map.prefix
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.void removeNamespace(java.lang.String prefix) throws XMLDBException
prefix
from
the internal namespace map. If prefix
is null or empty the
mapping for the default namespace will be removed.prefix
- The prefix to remove from the namespace map. If
prefix
is null or empty the mapping for the default
namespace will be removed.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.void clearNamespaces() throws XMLDBException
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.ResourceSet query(java.lang.String query) throws XMLDBException
Collection
. The XPath will be
applied to all XML resources stored in the Collection
.
The result is a
ResourceSet
containing the results of the query. Any
namespaces used in the query
string will be evaluated using
the mappings setup using setNamespace
.query
- The XPath query string to use.ResourceSet
containing the results of the query.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.ResourceSet queryResource(java.lang.String id, java.lang.String query) throws XMLDBException
Collection
associated with this service. The result is a
ResourceSet
containing the results of the query. Any
namespaces used in the query
string will be evaluated using
the mappings setup using setNamespace
.query
- The XPath query string to use.id
- The id of the document to run the query against.ResourceSet
containing the results of the query.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.