com.xmlmind.xml.load

Interface SimpleInclusion

All Superinterfaces:

Inclusion, XInclusion

All Known Implementing Classes:

Conref, XInclude

public interface SimpleInclusion
extends XInclusion

An XInclusion for which included nodes come from a single, actual, XML document.

See Also:

SimpleInclusionScheme

Method Summary

Modifier and Type	Method and Description
Node[]	copySourceNodes(Node firstNode, Node lastNode) Returns nodes to be included, which are copies, as is (XInclude 1.0) or modified (DITA Conref, XInclude 1.1), of specified source nodes.
Node[]	getSourceNodes(Document sourceDocument, Node inclusionHolder) Returns the original nodes.
URL	getSourceURL(Node inclusionHolder) Returns the URL of document from which the nodes have been included.

Methods inherited from interface com.xmlmind.xml.load.XInclusion

getSchemeName, include, isMarkedForUpdate, setMarkedForUpdate, uninclude

Methods inherited from interface com.xmlmind.xml.doc.Inclusion

toClipboardForm

Method Detail

getSourceURL

URL getSourceURL(Node inclusionHolder)

Returns the URL of document from which the nodes have been included. May return null (e.g. unresolved DITA conkeyref).

Parameters:

inclusionHolder - one of the included nodes, that is, one of the nodes having an INCLUSION_PROPERTY property pointing to this SimpleInclusion.

Generally this parameter is not used.

getSourceNodes

Node[] getSourceNodes(Document sourceDocument,
                      Node inclusionHolder)
               throws InclusionException

Returns the original nodes. Included nodes are copies, possibly modified (e.g. DITA conref), of these original nodes.

Parameters:

sourceDocument - the document containing the original nodes.

The URL of this document is returned by getSourceURL(com.xmlmind.xml.doc.Node).

inclusionHolder - one of the included nodes, that is, one of the nodes having an INCLUSION_PROPERTY property pointing to this SimpleInclusion.

Generally this parameter is not used.

Returns:

a non-empty array containing original nodes.

Throws:

InclusionException - if this SimpleInclusion fails to locate the original nodes

copySourceNodes

Node[] copySourceNodes(Node firstNode,
                       Node lastNode)

Returns nodes to be included, which are copies, as is (XInclude 1.0) or modified (DITA Conref, XInclude 1.1), of specified source nodes.

This method is needed to implement the copyAsInclusion command.

Parameters:

firstNode - first source node represented by this inclusion object

lastNode - last source node represented by this inclusion object

firstNode and lastNode specify a node range which is attached to the document tree. None of these nodes has already been included.

Returns:

a copy of specified node range