com.xmlmind.xml.xinclude

Class XIncludeScheme

java.lang.Object

com.xmlmind.xml.xinclude.XIncludeScheme

All Implemented Interfaces:

SimpleInclusionScheme, XInclusionScheme

public final class XIncludeScheme
extends Object
implements SimpleInclusionScheme

Represents the XInclude inclusion scheme. Supports both XInclude v1.0 and v1.1 (upward-compatible with v1.0).

See Also:

XInclude, XInclude 1.0, XInclude 1.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XIncludeScheme.Option Option keys supported by the options argument of 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[]).

Field Summary

Fields

Modifier and Type	Field and Description
static SimpleInclusionScheme[]	AS_LIST A 1-element array containing a ready-to-use instance of this scheme.
static XIncludeScheme	INSTANCE A ready-to-use instance of this scheme.

Constructor Summary

Constructors

Constructor and Description
XIncludeScheme()

Method Summary

Modifier and Type	Method and Description
static String	computeXPointer(Node firstNode, Node lastNode) Helper function: compute the XPointer corresponding to specified node range.
boolean	createSimpleInclusion(Node firstNode, Node lastNode, boolean createAbsoluteReference, String absoluteReference, Map<Object,Object> options, SimpleInclusion[] created) Create and return an SimpleInclusion representing specified nodes.
boolean	detectXInclusion(Node[] directive, boolean isElement, XInclusion[] detected) Create and return the XInclusion corresponding to specified directive, when such directive has been recognized by this scheme.
static boolean	elementXPointer(Element element, Map<Element,String> elementToId, StringBuilder buffer)
Attribute[]	getCopiedAttributes()
Attribute[]	getCopiedAttributesWhenMultipleInstances()
String	getSchemeName() Returns a name identifying uniquely this scheme.
Includable[]	listIncludables(Document targetDoc) Lists obvious node ranges (typically a single element having an ID) found in specified document which could be successfully copied by reference using SimpleInclusionScheme.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[]).
void	setCopiedAttributes(Attribute[] attrs)
void	setCopiedAttributes(String spec)
void	setCopiedAttributesWhenMultipleInstances(Attribute[] attrs)
void	setCopiedAttributesWhenMultipleInstances(String spec)

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final XIncludeScheme INSTANCE

A ready-to-use instance of this scheme.

AS_LIST

public static final SimpleInclusionScheme[] AS_LIST

A 1-element array containing a ready-to-use instance of this scheme.

Constructor Detail

XIncludeScheme

public XIncludeScheme()

Method Detail

setCopiedAttributesWhenMultipleInstances

public void setCopiedAttributesWhenMultipleInstances(String spec)
                                              throws IllegalArgumentException

Throws:

IllegalArgumentException

setCopiedAttributesWhenMultipleInstances

public void setCopiedAttributesWhenMultipleInstances(Attribute[] attrs)

setCopiedAttributes

public void setCopiedAttributes(String spec)
                         throws IllegalArgumentException

Throws:

IllegalArgumentException

setCopiedAttributes

public void setCopiedAttributes(Attribute[] attrs)

getCopiedAttributesWhenMultipleInstances

public Attribute[] getCopiedAttributesWhenMultipleInstances()

getCopiedAttributes

public Attribute[] getCopiedAttributes()

getSchemeName

public String getSchemeName()

Description copied from interface: XInclusionScheme

Returns a name identifying uniquely this scheme. Example: "XInclude".

Specified by:

getSchemeName in interface XInclusionScheme

detectXInclusion

public boolean detectXInclusion(Node[] directive,
                                boolean isElement,
                                XInclusion[] detected)
                         throws InclusionException

Description copied from interface: XInclusionScheme

Create and return the XInclusion corresponding to specified directive, when such directive has been recognized by this scheme.

Specified by:

detectXInclusion in interface XInclusionScheme

Parameters:

directive - an array of two nodes initially containing the same node: an element or a processing-instruction.

Nodes other than elements or processing-instructions cannot be used as inclusion directives.

The node passed as an argument is attached to the document being processed. By examining this node, this scheme must very quickly determine whether the node acts as an inclusion directive.

In some cases, the node contained in directive[0] is just the start of the inclusion directive. In such case, this scheme must set directive[1] to the node which is the end of the inclusion directive.

Example:

<?begin-inclusion spec="..."?>
 ...pre-included nodes, to be updated...
 <?end-inclusion>

isElement - true if directive[0] contains an element; false if directive[0] contains a processing-instruction

detected - newly created XInclusion, if any, is assigned to detected[0]. May be null (just a test, no creation of an XInclusion object).

Returns:

true if passed node has been recognized as an inclusion directive; otherwise false

Throws:

InclusionException - if the directive has been recognized but cannot be successfully parsed

createSimpleInclusion

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

Description copied from interface: SimpleInclusionScheme

Create and return an SimpleInclusion representing specified nodes.

This method is needed to implement the copyAsInclusion command.

Specified by:

createSimpleInclusion in interface SimpleInclusionScheme

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

computeXPointer

public static String computeXPointer(Node firstNode,
                                     Node lastNode)

Helper function: compute the XPointer corresponding to specified node range. For example, may return something like "element(foo/1/2)".

Parameters:

firstNode - first node of the range

lastNode - last node of the range. May be identical to firstNode.

Returns:

the XPointer in string form or null if it cannot be computed (typically because specified range is incorrect)

elementXPointer

public static boolean elementXPointer(Element element,
                                      Map<Element,String> elementToId,
                                      StringBuilder buffer)

listIncludables

public Includable[] listIncludables(Document targetDoc)

Description copied from interface: SimpleInclusionScheme

Lists obvious node ranges (typically a single element having an ID) found in specified document which could be successfully copied by reference using SimpleInclusionScheme.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.

Specified by:

listIncludables in interface SimpleInclusionScheme

Parameters:

targetDoc - the document to be searched for includable nodes

Returns:

found includable nodes. May be null or empty.