|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
XSLTransformService is a Service
that enables the execution of
XSL transformations within the context of a Collection
or
against a single XML Resource
stored in the
Collection
.
Method Summary | |
void |
clearNamespaces()
Removes all namespace mappings stored in the internal namespace map. |
void |
clearParameters()
Removes or un-binds *all* bound paramters. |
java.lang.String |
getNamespace(java.lang.String prefix)
Returns the URI string associated with prefix from
the internal namespace map. |
java.lang.String |
getParameter(java.lang.String name)
Retrieves the value of a bound parameter, or null if the parameter has not already been bound. |
void |
removeNamespace(java.lang.String prefix)
Removes the namespace mapping associated with prefix from
the internal namespace map. |
void |
removeParameter(java.lang.String name)
Removes or un-binds a bound parameter. |
void |
setNamespace(java.lang.String prefix,
java.lang.String uri)
Sets a namespace mapping in the internal namespace map used to evaluate queries. |
void |
setParameter(java.lang.String name,
java.lang.String value)
Sets a bound parameter. |
void |
setTemplates(org.xmldb.api.modules.XMLResource templates)
Sets the templates that will be used to transform this document. |
org.xmldb.api.base.Resource |
transform(java.lang.String xpath)
Uses the defined templates to trasform the results of the XPath query against the Collection . |
org.xmldb.api.base.Resource |
transformResource(java.lang.String id)
Uses the defined templates to transform the XML resource stored in the Collection associated with this service. |
Methods inherited from interface org.xmldb.api.base.Service |
getName, getVersion, setCollection |
Methods inherited from interface org.xmldb.api.base.Configurable |
getProperty, setProperty |
Method Detail |
public void setNamespace(java.lang.String prefix, java.lang.String uri) throws org.xmldb.api.base.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.
org.xmldb.api.base.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public java.lang.String getNamespace(java.lang.String prefix) throws org.xmldb.api.base.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
org.xmldb.api.base.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public void removeNamespace(java.lang.String prefix) throws org.xmldb.api.base.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.
org.xmldb.api.base.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public void clearNamespaces() throws org.xmldb.api.base.XMLDBException
org.xmldb.api.base.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public void setTemplates(org.xmldb.api.modules.XMLResource templates) throws org.xmldb.api.base.XMLDBException
templates
- The XSL stylesheet that will be used for the
transformation.
org.xmldb.api.base.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public void setParameter(java.lang.String name, java.lang.String value) throws org.xmldb.api.base.XMLDBException
name
- The bound parameter namevalue
- The bound parameter value
org.xmldb.api.base.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public java.lang.String getParameter(java.lang.String name) throws org.xmldb.api.base.XMLDBException
name
- The bound parameter value to retrieve
org.xmldb.api.base.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public void removeParameter(java.lang.String name) throws org.xmldb.api.base.XMLDBException
name
- The bound paramter name to remove.
org.xmldb.api.base.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public void clearParameters() throws org.xmldb.api.base.XMLDBException
org.xmldb.api.base.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public org.xmldb.api.base.Resource transform(java.lang.String xpath) throws org.xmldb.api.base.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
.
ResourceSet
containing the results of the query.
org.xmldb.api.base.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public org.xmldb.api.base.Resource transformResource(java.lang.String id) throws org.xmldb.api.base.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
.
id
- The id of the document to run the query against.
ResourceSet
containing the results of the query.
org.xmldb.api.base.XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |