iaik.ixsil.util

Class InternalReferenceResolverImpl

java.lang.Object

iaik.ixsil.util.InternalReferenceResolverImpl

All Implemented Interfaces:

InternalReferenceResolverInterface

public class InternalReferenceResolverImpl
extends java.lang.Object
implements InternalReferenceResolverInterface

Standard implementation for InternalReferenceResolverInterface, which is shipped with IXSIL.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLAT_RESULT_ Result type for flat result (with node expansion of Element nodes)
static int	FOREST_RESULT_ Result type for forest result (without node expansion of Element nodes)
protected static java.lang.String	XPATHEXPR_ALLCHILDREN_ XPath expression for getting all child nodes of a document.

Constructor Summary

Constructors

Constructor and Description
InternalReferenceResolverImpl()

Method Summary

Methods

Modifier and Type	Method and Description
org.w3c.dom.NodeList	resolve(URI uri, org.w3c.dom.Document xmlDocumentOM, org.w3c.dom.NodeList hereResult) Gets a list of DOM nodes representing the content of the given URI.
protected org.w3c.dom.NodeList	resolve(URI uri, org.w3c.dom.Document xmlDocumentOM, org.w3c.dom.NodeList hereResult, int resultType)
org.w3c.dom.NodeList	resolveForest(URI uri, org.w3c.dom.Document xmlDocumentOM, org.w3c.dom.NodeList hereResult) Gets a list of DOM nodes representing the content of the given URI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FLAT_RESULT_

public static final int FLAT_RESULT_

Result type for flat result (with node expansion of Element nodes)

See Also:

Constant Field Values

FOREST_RESULT_

public static final int FOREST_RESULT_

Result type for forest result (without node expansion of Element nodes)

See Also:

Constant Field Values

XPATHEXPR_ALLCHILDREN_

protected static final java.lang.String XPATHEXPR_ALLCHILDREN_

XPath expression for getting all child nodes of a document.

See Also:

Constant Field Values

Constructor Detail

InternalReferenceResolverImpl

public InternalReferenceResolverImpl()

Method Detail

resolve

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

Gets a list of DOM nodes representing the content of the given URI. The URI must represent an internal reference. Four types of such internal references are supported by this method:

1. An empty URI ("") results in all nodes of the XML document, except that comment nodes are filtered out.
2. A reference-only URI constisting of the XPointer xpointer(/) results in all nodes of the XML document, including comment nodes.
3. A reference-only URI constisting of an XPointer of the form xpointer(id("IDREFValue") or xpointer(id('IDREFValue') result in that element node of the XML document, whose ID attribute has a value equal to IDREFValue, including all its descendants.
4. A reference-only URI consisting of a XPointer bare name (e.g. IDREFValue) has the same result as the previous option, except that comment nodes are filtered out.

Specified by:

resolve in interface InternalReferenceResolverInterface

Parameters:

uri - Specifies the internal reference.

xmlDocumentOM - The object model for the XML document to be processed.

hereResult - Not used by this implementation.

Returns:

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

Throws:

InternalReferenceResolverException - if the content for the given URI cannot be fetched.

resolveForest

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

Gets a list of DOM nodes representing the content of the given URI. The URI must represent an internal reference. Four types of such internal references are supported by this method:

1. An empty URI ("") results in all child nodes of the DOM Document, except that comment nodes are filtered out.
2. A reference-only URI constisting of the XPointer xpointer(/) results in all child nodes of the DOM Document, including comment nodes.
3. A reference-only URI constisting of an XPointer of the form xpointer(id("IDREFValue") or xpointer(id('IDREFValue') result in exactlyvthat element node of the XML document, whose ID attribute has a value equal to IDREFValue.
4. A reference-only URI consisting of a XPointer bare name (e.g. IDREFValue) has the same result as the previous option.

Parameters:

uri - Specifies the internal reference.

xmlDocumentOM - The object model for the XML document to be processed.

hereResult - Not used by this implementation.

Returns:

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

Throws:

InternalReferenceResolverException - if the content for the given URI cannot be fetched.

resolve

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

Parameters:

resultType - One of FLAT_RESULT_ or FOREST_RESULT_. FLAT_RESULT_ will lead to a result suitable for resolve(iaik.ixsil.util.URI, org.w3c.dom.Document, org.w3c.dom.NodeList), whereas FOREST_RESULT_ will lead to a result suitable for resolveForest(iaik.ixsil.util.URI, org.w3c.dom.Document, org.w3c.dom.NodeList).

Throws:

InternalReferenceResolverException

See Also:

resolve(iaik.ixsil.util.URI, org.w3c.dom.Document, org.w3c.dom.NodeList), resolveForest(iaik.ixsil.util.URI, org.w3c.dom.Document, org.w3c.dom.NodeList)