com.xmlmind.xml.load

Interface SimpleInclusionScheme

All Superinterfaces:

XInclusionScheme

All Known Implementing Classes:

ConrefScheme, XIncludeScheme

public interface SimpleInclusionScheme
extends XInclusionScheme

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

XInclude, DITA conref, etc, are SimpleInclusion schemes.

Method Summary

Modifier and Type	Method and Description
boolean	createSimpleInclusion(Node firstNode, Node lastNode, boolean createAbsoluteReference, String absoluteReference, Map<Object,Object> options, SimpleInclusion[] created) Create and return an SimpleInclusion representing specified nodes.
Includable[]	listIncludables(Document document) Lists obvious node ranges (typically a single element having an ID) found in specified document which could be successfully copied by reference using createSimpleInclusion(com.xmlmind.xml.doc.Node, com.xmlmind.xml.doc.Node, boolean, java.lang.String, java.util.Map<java.lang.Object, java.lang.Object>, com.xmlmind.xml.load.SimpleInclusion[]).

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

detectXInclusion, getSchemeName

Method Detail

createSimpleInclusion

boolean createSimpleInclusion(Node firstNode,
                              Node lastNode,
                              boolean createAbsoluteReference,
                              String absoluteReference,
                              Map<Object,Object> options,
                              SimpleInclusion[] created)

Create and return an SimpleInclusion representing specified nodes.

This method is needed to implement the copyAsInclusion command.

Parameters:

firstNode - first node to be represented

lastNode - last node to be represented.

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

createAbsoluteReference - use absolute rather relative URL in created SimpleInclusion. This parameter may be ignored if not meaningful.

absoluteReference - the XML catalog resolved absolute reference to use.

Ignored if createAbsoluteReference is false.

If createAbsoluteReference is true:

• If null, a absolute URL determined using firstNode/lastNode is used.
• Otherwise, it is the specified absoluteReference which is used.

options - scheme-specific options other than createAbsoluteReference. May be null. This parameter may be ignored if not meaningful.

created - an SimpleInclusion representing specified nodes, if any, is assigned to created. May be null (just a test, no creation of a SimpleInclusion object).

Returns:

true if a SimpleInclusion representing specified nodes can be/has been created; false otherwise

listIncludables

Includable[] listIncludables(Document document)

Lists obvious node ranges (typically a single element having an ID) found in specified document which could be successfully copied by reference using createSimpleInclusion(com.xmlmind.xml.doc.Node, com.xmlmind.xml.doc.Node, boolean, java.lang.String, java.util.Map<java.lang.Object, java.lang.Object>, com.xmlmind.xml.load.SimpleInclusion[]).

This method is needed to implement the include command.

Parameters:

document - the document to be searched for includable nodes

Returns:

found includable nodes. May be null or empty.