iaik.ixsil.util

Interface InternalReferenceResolverInterface

All Known Implementing Classes:

InternalReferenceResolverImpl, XPointerReferenceResolver

public interface InternalReferenceResolverInterface

Defines an interface, which IXSIL relies on to resolve internal URI references. An internal URI can have an empty value (""), which means the whole XML document; or it can have a reference-only value, i. e. the URI is empty except its reference part, for example "#AnIDReference".

See Also:

ExternalReferenceResolverInterface

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.NodeList	resolve(URI uri, org.w3c.dom.Document xmlDocumentOM, org.w3c.dom.NodeList hereResult) Returns a NodeList object providing a list of DOM nodes which correspond to the parts of the XML document selected by the internal URI.

Method Detail

resolve

org.w3c.dom.NodeList resolve(URI uri,
                             org.w3c.dom.Document xmlDocumentOM,
                             org.w3c.dom.NodeList hereResult)
                      throws InternalReferenceResolverException

Returns a NodeList object providing a list of DOM nodes which correspond to the parts of the XML document selected by the internal URI.

Parameters:

uri - The URI specifying the parts of the XML document. Must be either empty or reference-only.

xmlDocumentOM - The XML document which should be used to evaluate the internal URI.

hereResult - If the uri is reference-only, and if the reference consists of an XPointer, it can make use of the here() extension function, which has has been introduced in XML Signature, XPath Filtering. If the here() function is used, this parameter contains the result which should be used for calls to here() in the XPointer. May be null if the here() function will not be used. If not null, the NodeList must contain a single Element, Attr or ProcessingInstruction node.

Returns:

a list of DOM nodes representing the selected parts of the XML document.

Throws:

InternalReferenceResolverException - if providing the list of DOM nodes fails for any reason.