|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnu.xom.xinclude.XIncluder
Implements XInclude resolution as specified in the
November
10, 2003 2nd Last Call Working Draft of 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
,
accept-language
, and accept-charset
attributes are supported.
Field Summary | |
static java.lang.String |
XINCLUDE_NS
The namespace name of all XInclude elements. |
Method Summary | |
static Document |
resolve(Document in)
Returns a copy of the argument Document
in which all xinclude:include elements have been
replaced by their referenced content. |
static Document |
resolve(Document in,
Builder builder)
Returns a copy of the argument Document
in which all xinclude:include elements have been
replaced by their referenced content. |
static void |
resolveInPlace(Document in)
Modifies a Document by replacing all
xinclude:include elements
by their referenced content. |
static void |
resolveInPlace(Document in,
Builder builder)
Modifies a Document by replacing all
xinclude:include elements with their referenced
content. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String XINCLUDE_NS
The namespace name of all XInclude elements.
Method Detail |
public static Document resolve(Document in) throws BadParseAttributeException, InclusionLoopException, java.io.IOException, NoIncludeLocationException, ParsingException, java.io.UnsupportedEncodingException, XIncludeException
Returns a copy of the argument 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.
in
- the Document
in which include elements
should be resolved
Document
in which
all XInclude have been replaced by their referenced content
BadParseAttributeException
- if an include
element has a parse
attribute with any value
other than text
or parse
InclusionLoopException
- if this Element
contains an XInclude element that attempts to include
a document in which this element is directly or indirectly
included.
java.io.IOException
- if an included document could not be loaded,
and no fallback was available
NoIncludeLocationException
- if an xinclude:include
element does not have an href
attribute.
ParsingException
- if an included XML document
was malformed
java.io.UnsupportedEncodingException
- if an included document
used an encoding this parser does not support, and no
fallback was available
XIncludeException
- if the document violates the
syntax rules of XInclude
XMLException
- if resolving an include element would
result in a malformed document,public static Document resolve(Document in, Builder builder) throws BadParseAttributeException, InclusionLoopException, java.io.IOException, NoIncludeLocationException, ParsingException, java.io.UnsupportedEncodingException, XIncludeException
Returns a copy of the argument 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.
in
- the Document
in which include elements
should be resolvedbuilder
- the Builder
used to build the
nodes included from other documents
Document
in which
all XInclude have been replaced by their referenced content
BadParseAttributeException
- if an include
element has a parse
attribute with any value
other than text
or parse
InclusionLoopException
- if this Element
contains an XInclude element that attempts to include
a document in which this element is directly or indirectly
included.
java.io.IOException
- if an included document could not be loaded,
and no fallback was available
NoIncludeLocationException
- if an xinclude:include
element does not have an href attribute.
ParsingException
- if an included XML document
was malformed
java.io.UnsupportedEncodingException
- if an included document
used an encoding this parser does not support, and no
fallback was available
XIncludeException
- if the document violates the
syntax rules of XInclude
XMLException
- if resolving an include element would
result in a malformed document,public static void resolveInPlace(Document in) throws BadParseAttributeException, InclusionLoopException, java.io.IOException, NoIncludeLocationException, ParsingException, java.io.UnsupportedEncodingException, XIncludeException
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.
in
- the Document
in which include elements
should be resolved
BadParseAttributeException
- if an include
element has a parse
attribute
with any value other than text
or parse
InclusionLoopException
- if this Element
contains an XInclude element that attempts to include a
document in which this element is directly or indirectly
included
java.io.IOException
- if an included document could not be loaded,
and no fallback was available
NoIncludeLocationException
- if an xinclude:include
element does not have an href
attribute.
ParsingException
- if an included XML document
was malformed
java.io.UnsupportedEncodingException
- if an included document
used an encoding this parser does not support, and no
fallback was available
XIncludeException
- if the document violates the
syntax rules of XInclude
XMLException
- if resolving an include element would
result in a malformed documentpublic static void resolveInPlace(Document in, Builder builder) throws BadParseAttributeException, InclusionLoopException, java.io.IOException, NoIncludeLocationException, ParsingException, java.io.UnsupportedEncodingException, XIncludeException
Modifies a Document
by replacing all
xinclude:include
elements with 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.
in
- the Document
in which include elements
should be resolvedbuilder
- the Builder
used to build the
nodes included from other documents
BadParseAttributeException
- if an include
element has a parse
attribute
with any value other than text
or parse
InclusionLoopException
- if this Element
contains an XInclude element that attempts to include a
document in which this element is directly or indirectly
included
java.io.IOException
- if an included document could not be loaded,
and no fallback was available
NoIncludeLocationException
- if an xinclude:include
element does not have an href
attribute.
ParsingException
- if an included XML document
was malformed
java.io.UnsupportedEncodingException
- if an included document
used an encoding this parser does not support, and no
fallback was available
XIncludeException
- if the document violates the
syntax rules of XInclude
XMLException
- if resolving an include element would
result in a malformed document
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |