<!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:22 GMT 2011 --> <TITLE> DOM4JObjectModel </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="DOM4JObjectModel"; } } </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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></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/option/dom4j/DocumentWrapper.html" title="class in net.sf.saxon.option.dom4j"><B>PREV CLASS</B></A> <A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JWriter.html" title="class in net.sf.saxon.option.dom4j"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?net/sf/saxon/option/dom4j/DOM4JObjectModel.html" target="_top"><B>FRAMES</B></A> <A HREF="DOM4JObjectModel.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> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_net.sf.saxon.om.TreeModel">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> net.sf.saxon.option.dom4j</FONT> <BR> Class DOM4JObjectModel</H2> <PRE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../net/sf/saxon/om/TreeModel.html" title="class in net.sf.saxon.om">net.sf.saxon.om.TreeModel</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.saxon.option.dom4j.DOM4JObjectModel</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A>, <A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html" title="interface in net.sf.saxon.lib">ExternalObjectModel</A></DD> </DL> <HR> <DL> <DT><PRE>public class <B>DOM4JObjectModel</B><DT>extends <A HREF="../../../../../net/sf/saxon/om/TreeModel.html" title="class in net.sf.saxon.om">TreeModel</A><DT>implements <A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html" title="interface in net.sf.saxon.lib">ExternalObjectModel</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL> </PRE> <P> This class is the DOM4J implementation of Saxon's ExternalObjectModel interface; it supports the wrapping of DOM4J documents as instances of the Saxon NodeInfo interface. <P> <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#net.sf.saxon.option.dom4j.DOM4JObjectModel">Serialized Form</A></DL> <HR> <P> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Field Summary</B></FONT></TH> </TR> </TABLE> <A NAME="fields_inherited_from_class_net.sf.saxon.om.TreeModel"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Fields inherited from class net.sf.saxon.om.<A HREF="../../../../../net/sf/saxon/om/TreeModel.html" title="class in net.sf.saxon.om">TreeModel</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../net/sf/saxon/om/TreeModel.html#LINKED_TREE">LINKED_TREE</A>, <A HREF="../../../../../net/sf/saxon/om/TreeModel.html#TINY_TREE">TINY_TREE</A>, <A HREF="../../../../../net/sf/saxon/om/TreeModel.html#TINY_TREE_CONDENSED">TINY_TREE_CONDENSED</A></CODE></TD> </TR> </TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JObjectModel.html#DOM4JObjectModel()">DOM4JObjectModel</A></B>()</CODE> <BR> </TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/event/Receiver.html" title="interface in net.sf.saxon.event">Receiver</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JObjectModel.html#getDocumentBuilder(javax.xml.transform.Result)">getDocumentBuilder</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/Result.html?is-external=true" title="class or interface in javax.xml.transform">Result</A> result)</CODE> <BR> Test whether this object model recognizes a particular kind of JAXP Result object, and if it does, return a Receiver that builds an instance of this data model from a sequence of events.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JObjectModel.html#getIdentifyingURI()">getIdentifyingURI</A></B>()</CODE> <BR> Get the URI of the external object model as used in the JAXP factory interfaces for obtaining an XPath implementation</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JObjectModel.html" title="class in net.sf.saxon.option.dom4j">DOM4JObjectModel</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JObjectModel.html#getInstance()">getInstance</A></B>()</CODE> <BR> Get a singular instance of this class</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/expr/JPConverter.html" title="class in net.sf.saxon.expr">JPConverter</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JObjectModel.html#getJPConverter(java.lang.Class)">getJPConverter</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> sourceClass)</CODE> <BR> Get a converter from values in the external object model to XPath values.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/expr/PJConverter.html" title="class in net.sf.saxon.expr">PJConverter</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JObjectModel.html#getNodeListCreator(java.lang.Object)">getNodeListCreator</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> node)</CODE> <BR> Get a converter that converts a sequence of XPath nodes to this model's representation of a node list.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/expr/PJConverter.html" title="class in net.sf.saxon.expr">PJConverter</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JObjectModel.html#getPJConverter(java.lang.Class)">getPJConverter</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> targetClass)</CODE> <BR> Get a converter from XPath values to values in the external object model</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/event/Builder.html" title="class in net.sf.saxon.event">Builder</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JObjectModel.html#makeBuilder(net.sf.saxon.event.PipelineConfiguration)">makeBuilder</A></B>(<A HREF="../../../../../net/sf/saxon/event/PipelineConfiguration.html" title="class in net.sf.saxon.event">PipelineConfiguration</A> pipe)</CODE> <BR> Make a Builder to construct an instance of this tree model from a stream of events</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JObjectModel.html#sendSource(javax.xml.transform.Source, net.sf.saxon.event.Receiver)">sendSource</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/Source.html?is-external=true" title="class or interface in javax.xml.transform">Source</A> source, <A HREF="../../../../../net/sf/saxon/event/Receiver.html" title="interface in net.sf.saxon.event">Receiver</A> receiver)</CODE> <BR> Test whether this object model recognizes a particular kind of JAXP Source object, and if it does, send the contents of the document to a supplied Receiver, and return true.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JObjectModel.html#unravel(javax.xml.transform.Source, net.sf.saxon.Configuration)">unravel</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/Source.html?is-external=true" title="class or interface in javax.xml.transform">Source</A> source, <A HREF="../../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</CODE> <BR> Wrap or unwrap a node using this object model to return the corresponding Saxon node.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/om/DocumentInfo.html" title="interface in net.sf.saxon.om">DocumentInfo</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JObjectModel.html#wrapDocument(java.lang.Object, java.lang.String, net.sf.saxon.Configuration)">wrapDocument</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> node, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> baseURI, <A HREF="../../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</CODE> <BR> Wrap a document node in the external object model in a document wrapper that implements the Saxon DocumentInfo interface</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JObjectModel.html#wrapNode(net.sf.saxon.om.DocumentInfo, java.lang.Object)">wrapNode</A></B>(<A HREF="../../../../../net/sf/saxon/om/DocumentInfo.html" title="interface in net.sf.saxon.om">DocumentInfo</A> document, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> node)</CODE> <BR> Wrap a node within the external object model in a node wrapper that implements the Saxon VirtualNode interface (which is an extension of NodeInfo)</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_net.sf.saxon.om.TreeModel"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class net.sf.saxon.om.<A HREF="../../../../../net/sf/saxon/om/TreeModel.html" title="class in net.sf.saxon.om">TreeModel</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../net/sf/saxon/om/TreeModel.html#getSymbolicValue()">getSymbolicValue</A>, <A HREF="../../../../../net/sf/saxon/om/TreeModel.html#getTreeModel(int)">getTreeModel</A>, <A HREF="../../../../../net/sf/saxon/om/TreeModel.html#isMutable()">isMutable</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> </TR> </TABLE> <P> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="DOM4JObjectModel()"><!-- --></A><H3> DOM4JObjectModel</H3> <PRE> public <B>DOM4JObjectModel</B>()</PRE> <DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="getInstance()"><!-- --></A><H3> getInstance</H3> <PRE> public static <A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JObjectModel.html" title="class in net.sf.saxon.option.dom4j">DOM4JObjectModel</A> <B>getInstance</B>()</PRE> <DL> <DD>Get a singular instance of this class <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a singular instance of this class</DL> </DD> </DL> <HR> <A NAME="getIdentifyingURI()"><!-- --></A><H3> getIdentifyingURI</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getIdentifyingURI</B>()</PRE> <DL> <DD>Get the URI of the external object model as used in the JAXP factory interfaces for obtaining an XPath implementation <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html#getIdentifyingURI()">getIdentifyingURI</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html" title="interface in net.sf.saxon.lib">ExternalObjectModel</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the URI used to identify this object model in the JAXP XPath factory mechanism.</DL> </DD> </DL> <HR> <A NAME="makeBuilder(net.sf.saxon.event.PipelineConfiguration)"><!-- --></A><H3> makeBuilder</H3> <PRE> public <A HREF="../../../../../net/sf/saxon/event/Builder.html" title="class in net.sf.saxon.event">Builder</A> <B>makeBuilder</B>(<A HREF="../../../../../net/sf/saxon/event/PipelineConfiguration.html" title="class in net.sf.saxon.event">PipelineConfiguration</A> pipe)</PRE> <DL> <DD><B>Description copied from class: <CODE><A HREF="../../../../../net/sf/saxon/om/TreeModel.html#makeBuilder(net.sf.saxon.event.PipelineConfiguration)">TreeModel</A></CODE></B></DD> <DD>Make a Builder to construct an instance of this tree model from a stream of events <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/om/TreeModel.html#makeBuilder(net.sf.saxon.event.PipelineConfiguration)">makeBuilder</A></CODE> in class <CODE><A HREF="../../../../../net/sf/saxon/om/TreeModel.html" title="class in net.sf.saxon.om">TreeModel</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a newly created Builder @param pipe</DL> </DD> </DL> <HR> <A NAME="getPJConverter(java.lang.Class)"><!-- --></A><H3> getPJConverter</H3> <PRE> public <A HREF="../../../../../net/sf/saxon/expr/PJConverter.html" title="class in net.sf.saxon.expr">PJConverter</A> <B>getPJConverter</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> targetClass)</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html#getPJConverter(java.lang.Class)">ExternalObjectModel</A></CODE></B></DD> <DD>Get a converter from XPath values to values in the external object model <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html#getPJConverter(java.lang.Class)">getPJConverter</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html" title="interface in net.sf.saxon.lib">ExternalObjectModel</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>targetClass</CODE> - the required class of the result of the conversion. If this class represents a node or list of nodes in the external object model, the method should return a converter that takes a native node or sequence of nodes as input and returns a node or sequence of nodes in the external object model representation. Otherwise, it should return null. <DT><B>Returns:</B><DD>a converter, if the targetClass is recognized as belonging to this object model; otherwise null</DL> </DD> </DL> <HR> <A NAME="getJPConverter(java.lang.Class)"><!-- --></A><H3> getJPConverter</H3> <PRE> public <A HREF="../../../../../net/sf/saxon/expr/JPConverter.html" title="class in net.sf.saxon.expr">JPConverter</A> <B>getJPConverter</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> sourceClass)</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html#getJPConverter(java.lang.Class)">ExternalObjectModel</A></CODE></B></DD> <DD>Get a converter from values in the external object model to XPath values. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html#getJPConverter(java.lang.Class)">getJPConverter</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html" title="interface in net.sf.saxon.lib">ExternalObjectModel</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>sourceClass</CODE> - the class (static or dynamic) of values to be converted <DT><B>Returns:</B><DD>a converter, if the sourceClass is recognized as belonging to this object model; otherwise null</DL> </DD> </DL> <HR> <A NAME="getNodeListCreator(java.lang.Object)"><!-- --></A><H3> getNodeListCreator</H3> <PRE> public <A HREF="../../../../../net/sf/saxon/expr/PJConverter.html" title="class in net.sf.saxon.expr">PJConverter</A> <B>getNodeListCreator</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> node)</PRE> <DL> <DD>Get a converter that converts a sequence of XPath nodes to this model's representation of a node list. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html#getNodeListCreator(java.lang.Object)">getNodeListCreator</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html" title="interface in net.sf.saxon.lib">ExternalObjectModel</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>node</CODE> - an example of the kind of node used in this model <DT><B>Returns:</B><DD>if the model does not recognize this node as one of its own, return null. Otherwise return a PJConverter that takes a list of XPath nodes (represented as NodeInfo objects) and returns a collection of nodes in this object model</DL> </DD> </DL> <HR> <A NAME="getDocumentBuilder(javax.xml.transform.Result)"><!-- --></A><H3> getDocumentBuilder</H3> <PRE> public <A HREF="../../../../../net/sf/saxon/event/Receiver.html" title="interface in net.sf.saxon.event">Receiver</A> <B>getDocumentBuilder</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/Result.html?is-external=true" title="class or interface in javax.xml.transform">Result</A> result)</PRE> <DL> <DD>Test whether this object model recognizes a particular kind of JAXP Result object, and if it does, return a Receiver that builds an instance of this data model from a sequence of events. If the Result is not recognised, return null. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html#getDocumentBuilder(javax.xml.transform.Result)">getDocumentBuilder</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html" title="interface in net.sf.saxon.lib">ExternalObjectModel</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>result</CODE> - a JAXP result object <DT><B>Returns:</B><DD>a Receiver that writes to that result, if available; or null otherwise</DL> </DD> </DL> <HR> <A NAME="sendSource(javax.xml.transform.Source, net.sf.saxon.event.Receiver)"><!-- --></A><H3> sendSource</H3> <PRE> public boolean <B>sendSource</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/Source.html?is-external=true" title="class or interface in javax.xml.transform">Source</A> source, <A HREF="../../../../../net/sf/saxon/event/Receiver.html" title="interface in net.sf.saxon.event">Receiver</A> receiver) throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Test whether this object model recognizes a particular kind of JAXP Source object, and if it does, send the contents of the document to a supplied Receiver, and return true. Otherwise, return false. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html#sendSource(javax.xml.transform.Source, net.sf.saxon.event.Receiver)">sendSource</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html" title="interface in net.sf.saxon.lib">ExternalObjectModel</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>source</CODE> - a JAXP Source object<DD><CODE>receiver</CODE> - the Receiver that is to receive the data from the Source <DT><B>Returns:</B><DD>true if the data from the Source has been sent to the Receiver, false otherwise <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if any failure occurs</DL> </DD> </DL> <HR> <A NAME="unravel(javax.xml.transform.Source, net.sf.saxon.Configuration)"><!-- --></A><H3> unravel</H3> <PRE> public <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> <B>unravel</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/Source.html?is-external=true" title="class or interface in javax.xml.transform">Source</A> source, <A HREF="../../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</PRE> <DL> <DD>Wrap or unwrap a node using this object model to return the corresponding Saxon node. If the supplied source does not belong to this object model, return null <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html#unravel(javax.xml.transform.Source, net.sf.saxon.Configuration)">unravel</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/lib/ExternalObjectModel.html" title="interface in net.sf.saxon.lib">ExternalObjectModel</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>source</CODE> - a JAXP Source object<DD><CODE>config</CODE> - the Saxon configuration <DT><B>Returns:</B><DD>a NodeInfo corresponding to the Source, if this can be constructed; otherwise null</DL> </DD> </DL> <HR> <A NAME="wrapDocument(java.lang.Object, java.lang.String, net.sf.saxon.Configuration)"><!-- --></A><H3> wrapDocument</H3> <PRE> public <A HREF="../../../../../net/sf/saxon/om/DocumentInfo.html" title="interface in net.sf.saxon.om">DocumentInfo</A> <B>wrapDocument</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> node, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> baseURI, <A HREF="../../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</PRE> <DL> <DD>Wrap a document node in the external object model in a document wrapper that implements the Saxon DocumentInfo interface <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>node</CODE> - a node (any node) in the third party document<DD><CODE>baseURI</CODE> - the base URI of the node (supply "" if unknown)<DD><CODE>config</CODE> - the Saxon configuration (which among other things provides access to the NamePool) <DT><B>Returns:</B><DD>the wrapper, which must implement DocumentInfo</DL> </DD> </DL> <HR> <A NAME="wrapNode(net.sf.saxon.om.DocumentInfo, java.lang.Object)"><!-- --></A><H3> wrapNode</H3> <PRE> public <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> <B>wrapNode</B>(<A HREF="../../../../../net/sf/saxon/om/DocumentInfo.html" title="interface in net.sf.saxon.om">DocumentInfo</A> document, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> node)</PRE> <DL> <DD>Wrap a node within the external object model in a node wrapper that implements the Saxon VirtualNode interface (which is an extension of NodeInfo) <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>document</CODE> - the document wrapper, as a DocumentInfo object<DD><CODE>node</CODE> - the node to be wrapped. This must be a node within the document wrapped by the DocumentInfo provided in the first argument <DT><B>Returns:</B><DD>the wrapper for the node, as an instance of VirtualNode</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></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/option/dom4j/DocumentWrapper.html" title="class in net.sf.saxon.option.dom4j"><B>PREV CLASS</B></A> <A HREF="../../../../../net/sf/saxon/option/dom4j/DOM4JWriter.html" title="class in net.sf.saxon.option.dom4j"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?net/sf/saxon/option/dom4j/DOM4JObjectModel.html" target="_top"><B>FRAMES</B></A> <A HREF="DOM4JObjectModel.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> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_net.sf.saxon.om.TreeModel">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></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>