<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:49 GMT 2011 -->
<TITLE>
net.sf.saxon.dom
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="net.sf.saxon.dom";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../net/sf/saxon/event/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/dom/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package net.sf.saxon.dom
</H2>
This package provides glue classes that enable Saxon to process a source
document supplied as a DOM tree in the form of a DOMSource object; it also provides
classes that present a DOM view of Saxon's native tree structures.
<P>
<B>See:</B>
<BR>
<A HREF="#package_description"><B>Description</B></A>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/AttrOverNodeInfo.html" title="class in net.sf.saxon.dom">AttrOverNodeInfo</A></B></TD>
<TD>This class is an implementation of the DOM Attr class that wraps a Saxon NodeInfo
representation of an attribute or namespace node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/DocumentBuilderFactoryImpl.html" title="class in net.sf.saxon.dom">DocumentBuilderFactoryImpl</A></B></TD>
<TD><B>Deprecated.</B> <I>since 9.3.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/DocumentBuilderImpl.html" title="class in net.sf.saxon.dom">DocumentBuilderImpl</A></B></TD>
<TD>This class implements the JAXP DocumentBuilder interface, allowing a Saxon TinyTree to be
constructed using standard JAXP parsing interfaces.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/DocumentOverNodeInfo.html" title="class in net.sf.saxon.dom">DocumentOverNodeInfo</A></B></TD>
<TD>This class is an implementation of the DOM Document class that wraps a Saxon DocumentInfo
representation of a document node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/DocumentWrapper.html" title="class in net.sf.saxon.dom">DocumentWrapper</A></B></TD>
<TD>The document node of a tree implemented as a wrapper around a DOM Document.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/DOMEnvelope.html" title="class in net.sf.saxon.dom">DOMEnvelope</A></B></TD>
<TD>DOMEnvelope is an object model representation in which DOM interfaces are wrapped around
Saxon NodeInfo nodes: that is, it implements the DOM on top of a Saxon tree implementation
such as the tiny tree or linked tree.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/DOMNodeList.html" title="class in net.sf.saxon.dom">DOMNodeList</A></B></TD>
<TD>This class wraps a list of nodes as a DOM NodeList</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/DOMObjectModel.html" title="class in net.sf.saxon.dom">DOMObjectModel</A></B></TD>
<TD>This interface must be implemented by any third-party object model that can
be wrapped with a wrapper that implements the Saxon Object Model (the NodeInfo interface).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/DOMSender.html" title="class in net.sf.saxon.dom">DOMSender</A></B></TD>
<TD>DOMSender.java: pseudo-SAX driver for a DOM source document.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/DOMTransform.html" title="class in net.sf.saxon.dom">DOMTransform</A></B></TD>
<TD>Variant of command line net.sf.saxon.Transform do build the source document
in DOM and then proceed with the transformation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/DOMWriter.html" title="class in net.sf.saxon.dom">DOMWriter</A></B></TD>
<TD>DOMWriter is a Receiver that attaches the result tree to a specified Node in the DOM Document</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/ElementOverNodeInfo.html" title="class in net.sf.saxon.dom">ElementOverNodeInfo</A></B></TD>
<TD>This class is an implementation of the DOM Element class that wraps a Saxon NodeInfo
representation of an element node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/NodeOverNodeInfo.html" title="class in net.sf.saxon.dom">NodeOverNodeInfo</A></B></TD>
<TD>This class implements the DOM Node interface as a wrapper around a Saxon NodeInfo object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/NodeWrapper.html" title="class in net.sf.saxon.dom">NodeWrapper</A></B></TD>
<TD>A node in the XML parse tree representing an XML element, character content, or attribute.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/PIOverNodeInfo.html" title="class in net.sf.saxon.dom">PIOverNodeInfo</A></B></TD>
<TD>This class is an implementation of the DOM ProcessingInstruction interface that wraps a Saxon NodeInfo
representation of a text or comment node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/TextOverAttrInfo.html" title="class in net.sf.saxon.dom">TextOverAttrInfo</A></B></TD>
<TD>This class represents a DOM text node that is the child of a DOM attribute node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/TextOverNodeInfo.html" title="class in net.sf.saxon.dom">TextOverNodeInfo</A></B></TD>
<TD>This class is an implementation of the DOM Text and Comment interfaces that wraps a Saxon NodeInfo
representation of a text or comment node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/TypeInfoImpl.html" title="class in net.sf.saxon.dom">TypeInfoImpl</A></B></TD>
<TD>This class implements the DOM TypeInfo interface as a wrapper over the Saxon SchemaType
interface.</TD>
</TR>
</TABLE>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Exception Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/dom/DOMExceptionImpl.html" title="class in net.sf.saxon.dom">DOMExceptionImpl</A></B></TD>
<TD>DOM operations only raise exceptions in "exceptional" circumstances,
i.e., when an operation is impossible to perform (either for logical
reasons, because data is lost, or because the implementation has become
unstable).</TD>
</TR>
</TABLE>
<P>
<A NAME="package_description"><!-- --></A><H2>
Package net.sf.saxon.dom Description
</H2>
<P>
<p>This package provides glue classes that enable Saxon to process a source
document supplied as a DOM tree in the form of a DOMSource object; it also provides
classes that present a DOM view of Saxon's native tree structures.</p>
<p>The native Saxon tree structures (the linked tree and tiny tree) do not
implement DOM interfaces directly. However, Saxon supports the DOM at two levels:</p>
<ul>
<li><p>The input to a transformation or query may be supplied in the form of
a <code>DOMSource</code> (which contains a DOM document). Saxon is capable of either performing the
query or transformation on the DOM <i>in situ</i>, by wrapping the DOM nodes in
a layer that make them appear to be Saxon nodes, or of converting the DOM to Saxon's native tree
implementation. </p></li>
<li><p>It is possible for a transformation or query to call extension functions
that use DOM interfaces to access a Saxon tree. If the Saxon tree is in fact a wrapper
around the DOM, then extension functions will be presented with the underlying
DOM nodes. In other cases, Saxon adds a wrapper to the native Saxon nodes to make
them implement the DOM interfaces.</p>
<p>Note that Saxon's tree structures are immutable. Updating interfaces
in the DOM API are therefore not supported.</p></li></ul>
<p>The classes <A HREF="../../../../net/sf/saxon/dom/NodeWrapper.html" title="class in net.sf.saxon.dom"><CODE>NodeWrapper</CODE></A> and <A HREF="../../../../net/sf/saxon/dom/DocumentWrapper.html" title="class in net.sf.saxon.dom"><CODE>DocumentWrapper</CODE></A> implement the Saxon interfaces
<A HREF="../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om"><CODE>NodeInfo</CODE></A> and <A HREF="../../../../net/sf/saxon/om/DocumentInfo.html" title="interface in net.sf.saxon.om"><CODE>DocumentInfo</CODE></A> on top of an underlying DOM
<code>Node</code> or <code>Document</code> object respectively. This enables XPath expressions to be executed directly against
the DOM.</p>
<p>The classes <A HREF="../../../../net/sf/saxon/dom/NodeOverNodeInfo.html" title="class in net.sf.saxon.dom"><CODE>NodeOverNodeInfo</CODE></A>,
<A HREF="../../../../net/sf/saxon/dom/DocumentOverNodeInfo.html" title="class in net.sf.saxon.dom"><CODE>DocumentOverNodeInfo</CODE></A>, and the like do the converse:
they provide a DOM wrapper over a native Saxon node.</p>
<p><b>Note that using the DOM with Saxon is considerably less efficient than using
Saxon's native tree implementations, the TinyTree and the LinkedTree.
The DOM should be used only where there is some good reason, e.g. where other parts
of the application have to use DOM interfaces.</b></p>
<p>Saxon doesn't stop you modifying the contents of the DOM in the course of a
transformation (for example, from an extension function, or in a different thread)
but the consequences of doing so are unpredictable.</p>
<hr>
<p align="center"><i>Michael H. Kay<br/>
Saxonica Limited<br/>
July 2010</i></p>
<P>
<P>
<DL>
</DL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../net/sf/saxon/event/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/dom/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
