XIncluder Class Reference

#include <elm/xom/XIncluder.h>

Static Public Member Functions
static Document *	resolve (Document *in)
static Document *	resolve (Document *in, Builder &builder)
static void	resolveInPlace (Document *in)
static void	resolveInPlace (Document *in, Builder &builder)

Static Public Attributes
static const String	NS = XINCLUDE_NS

Detailed Description

Implements XInclude resolution as specified in XML Inclusions (XInclude) Version 1.0. Fallbacks are supported. The XPointer element() scheme and shorthand XPointers are also supported. The XPointer xpointer() scheme is not supported. The accept and accept-language attributes are supported.

Member Function Documentation

resolve() [1/2]

Document * resolve ( Document *  in )

static

Returns a copy of the document in which all xinclude:include elements have been replaced by their referenced content. The original Document object is not modified. Resolution is recursive; that is, include elements in the included documents are themselves resolved. The Document returned contains no include elements.

Parameters

in	The document in which include elements should be resolved.

Returns

Copy of the document in which all xinclude:include elements have been replaced by their referenced content.

Warning

Not implemented !

resolve() [2/2]

Document * resolve ( Document *  in, Builder &  builder  )

static

Returns a copy of the document in which all xinclude:include elements have been replaced by their referenced content as loaded by the builder. The original Document object is not modified. Resolution is recursive; that is, include elements in the included documents are themselves resolved. The document returned contains no include elements.

Parameters

in	The document in which include elements should be resolved.
builder	The builder used to build the nodes included from other documents.

Returns

Copy of the document in which all xinclude:include elements have been replaced by their referenced content.

Warning

Not implemented !

resolveInPlace() [1/2]

void resolveInPlace ( Document *  in )

static

Modifies a document by replacing all xinclude:include elements by their referenced content. Resolution is recursive; that is, include elements in the included documents are themselves resolved. The resolved document contains no xinclude:include elements.

If the inclusion fails for any reason—XInclude syntax error, missing resource with no fallback, etc.—the document may be left in a partially resolved state.

Parameters

in	The document in which include elements should be resolved.

resolveInPlace() [2/2]

void resolveInPlace ( Document *  in, Builder &  builder  )

static

Modifies a document by replacing all xinclude:include elements with their referenced content as loaded by the builder. Resolution is recursive; that is, include elements in the included documents are themselves resolved. The resolved document contains no xinclude:include elements.

If the inclusion fails for any reason — XInclude syntax error, missing resource with no fallback, etc. — the document may be left in a partially resolved state.

Parameters

in	The document in which include elements should be resolved.
builder	The builder used to build the nodes included from other documents

Warning

Not implemented !

Member Data Documentation

NS

const String NS = XINCLUDE_NS

static

The namespace name of all XInclude elements.

---

The documentation for this class was generated from the following files:

• include/elm/xom/XIncluder.h
• src/xom_XIncluder.cpp