| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
|
| <!--NewPage-->
|
| <HTML>
|
| <HEAD>
|
| <!-- Generated by javadoc on Thu Nov 22 17:12:56 EST 2007 -->
|
| <TITLE>
|
| Xalan-Java 2.7.1: Class DTMManager
|
| </TITLE>
|
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
|
| </HEAD>
|
| <BODY BGCOLOR="white">
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <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="class-use/DTMManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../../org/apache/xml/dtm/DTMAxisTraverser.html"><B>PREV CLASS</B></A>
|
| NEXT CLASS</FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="DTMManager.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| <!-- ======== START OF CLASS DATA ======== -->
|
| <H2>
|
| <FONT SIZE="-1">
|
| org.apache.xml.dtm</FONT>
|
| <BR>
|
| Class DTMManager</H2>
|
| <PRE>
|
| java.lang.Object
|
| |
|
| +--<B>org.apache.xml.dtm.DTMManager</B>
|
| </PRE>
|
| <DL>
|
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/xml/dtm/ref/DTMManagerDefault.html">DTMManagerDefault</A>, <A HREF="../../../../org/apache/xpath/XPathContext.html">XPathContext</A></DD>
|
| </DL>
|
| <HR>
|
| <DL>
|
| <DT>public abstract class <B>DTMManager</B><DT>extends java.lang.Object</DL>
|
|
|
| <P>
|
| A DTMManager instance can be used to create DTM and |
| DTMIterator objects, and manage the DTM objects in the system. |
| |
| <p>The system property that determines which Factory implementation |
| to create is named "org.apache.xml.utils.DTMFactory". This |
| property names a concrete subclass of the DTMFactory abstract |
| class. If the property is not defined, a platform default is be used.</p> |
| |
| <p>An instance of this class <emph>must</emph> be safe to use across |
| thread instances. It is expected that a client will create a single instance |
| of a DTMManager to use across multiple threads. This will allow sharing |
| of DTMs across multiple processes.</p> |
| |
| <p>Note: this class is incomplete right now. It will be pretty much |
| modeled after javax.xml.transform.TransformerFactory in terms of its |
| factory support.</p> |
| |
| <p>State: In progress!!</p>
|
| <P>
|
| <HR>
|
|
|
| <P>
|
| <!-- ======== INNER CLASS SUMMARY ======== -->
|
|
|
|
|
| <!-- =========== FIELD SUMMARY =========== -->
|
|
|
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Field Summary</B></FONT></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>static int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#IDENT_DTM_DEFAULT">IDENT_DTM_DEFAULT</A></B></CODE>
|
|
|
| <BR>
|
| When this bitmask is ANDed with a DTM node handle number, the result |
| is the DTM's document identity number.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>static int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#IDENT_DTM_NODE_BITS">IDENT_DTM_NODE_BITS</A></B></CODE>
|
|
|
| <BR>
|
| This value, set at compile time, controls how many bits of the |
| DTM node identifier numbers are used to identify a node within a |
| document, and thus sets the maximum number of nodes per |
| document.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>static int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#IDENT_MAX_DTMS">IDENT_MAX_DTMS</A></B></CODE>
|
|
|
| <BR>
|
| This is the maximum number of DTMs available.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>static int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#IDENT_NODE_DEFAULT">IDENT_NODE_DEFAULT</A></B></CODE>
|
|
|
| <BR>
|
| When this bitmask is ANDed with a DTM node handle number, the result |
| is the low bits of the node's index number within that DTM.</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="../../../../org/apache/xml/dtm/DTMManager.html#m_incremental">m_incremental</A></B></CODE>
|
|
|
| <BR>
|
| </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="../../../../org/apache/xml/dtm/DTMManager.html#m_source_location">m_source_location</A></B></CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
|
| <!-- ========== METHOD SUMMARY =========== -->
|
|
|
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Method Summary</B></FONT></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract <A HREF="../../../../org/apache/xml/dtm/DTM.html">DTM</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#createDocumentFragment()">createDocumentFragment</A></B>()</CODE>
|
|
|
| <BR>
|
| Creates a DTM representing an empty <code>DocumentFragment</code> object.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#createDTMIterator(int)">createDTMIterator</A></B>(int node)</CODE>
|
|
|
| <BR>
|
| Create a new <code>DTMIterator</code> that holds exactly one node.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#createDTMIterator(int, org.apache.xml.dtm.DTMFilter, boolean)">createDTMIterator</A></B>(int whatToShow, |
| <A HREF="../../../../org/apache/xml/dtm/DTMFilter.html">DTMFilter</A> filter, |
| boolean entityReferenceExpansion)</CODE>
|
|
|
| <BR>
|
| Create a new <code>DTMIterator</code> based only on a whatToShow |
| and a DTMFilter.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#createDTMIterator(java.lang.Object, int)">createDTMIterator</A></B>(java.lang.Object xpathCompiler, |
| int pos)</CODE>
|
|
|
| <BR>
|
| Create a new <code>DTMIterator</code> based on an XPath |
| <a href="http://www.w3.org/TR/xpath#NT-LocationPath>LocationPath</a> or |
| a <a href="http://www.w3.org/TR/xpath#NT-UnionExpr">UnionExpr</a>.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#createDTMIterator(java.lang.String, org.apache.xml.utils.PrefixResolver)">createDTMIterator</A></B>(java.lang.String xpathString, |
| <A HREF="../../../../org/apache/xml/utils/PrefixResolver.html">PrefixResolver</A> presolver)</CODE>
|
|
|
| <BR>
|
| Create a new <code>DTMIterator</code> based on an XPath |
| <a href="http://www.w3.org/TR/xpath#NT-LocationPath>LocationPath</a> or |
| a <a href="http://www.w3.org/TR/xpath#NT-UnionExpr">UnionExpr</a>.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract <A HREF="../../../../org/apache/xml/dtm/DTM.html">DTM</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#getDTM(int)">getDTM</A></B>(int nodeHandle)</CODE>
|
|
|
| <BR>
|
| Get the instance of DTM that "owns" a node handle.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract <A HREF="../../../../org/apache/xml/dtm/DTM.html">DTM</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#getDTM(javax.xml.transform.Source, boolean, org.apache.xml.dtm.DTMWSFilter, boolean, boolean)">getDTM</A></B>(<A HREF="../../../../javax/xml/transform/Source.html">Source</A> source, |
| boolean unique, |
| <A HREF="../../../../org/apache/xml/dtm/DTMWSFilter.html">DTMWSFilter</A> whiteSpaceFilter, |
| boolean incremental, |
| boolean doIndexing)</CODE>
|
|
|
| <BR>
|
| Get an instance of a DTM, loaded with the content from the |
| specified source.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#getDTMHandleFromNode(org.w3c.dom.Node)">getDTMHandleFromNode</A></B>(<A HREF="../../../../org/w3c/dom/Node.html">Node</A> node)</CODE>
|
|
|
| <BR>
|
| Given a W3C DOM node, try and return a DTM handle.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#getDTMIdentity(org.apache.xml.dtm.DTM)">getDTMIdentity</A></B>(<A HREF="../../../../org/apache/xml/dtm/DTM.html">DTM</A> dtm)</CODE>
|
|
|
| <BR>
|
| %TBD% Doc |
| |
| NEEDSDOC @param dtm |
| |
| NEEDSDOC ($objectName$) @return</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#getDTMIdentityMask()">getDTMIdentityMask</A></B>()</CODE>
|
|
|
| <BR>
|
| %TBD% Doc |
| |
| NEEDSDOC ($objectName$) @return</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="../../../../org/apache/xml/dtm/DTMManager.html#getIncremental()">getIncremental</A></B>()</CODE>
|
|
|
| <BR>
|
| Get a flag indicating whether an incremental transform is desired</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#getNodeIdentityMask()">getNodeIdentityMask</A></B>()</CODE>
|
|
|
| <BR>
|
| %TBD% Doc |
| |
| NEEDSDOC ($objectName$) @return</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="../../../../org/apache/xml/dtm/DTMManager.html#getSource_location()">getSource_location</A></B>()</CODE>
|
|
|
| <BR>
|
| Get a flag indicating whether the transformation phase should |
| keep track of line and column numbers for the input source |
| document.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../../org/apache/xml/utils/XMLStringFactory.html">XMLStringFactory</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#getXMLStringFactory()">getXMLStringFactory</A></B>()</CODE>
|
|
|
| <BR>
|
| Get the XMLStringFactory used for the DTMs.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>static <A HREF="../../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#newInstance(org.apache.xml.utils.XMLStringFactory)">newInstance</A></B>(<A HREF="../../../../org/apache/xml/utils/XMLStringFactory.html">XMLStringFactory</A> xsf)</CODE>
|
|
|
| <BR>
|
| Obtain a new instance of a <code>DTMManager</code>.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#release(org.apache.xml.dtm.DTM, boolean)">release</A></B>(<A HREF="../../../../org/apache/xml/dtm/DTM.html">DTM</A> dtm, |
| boolean shouldHardDelete)</CODE>
|
|
|
| <BR>
|
| Release a DTM either to a lru pool, or completely remove reference.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#setIncremental(boolean)">setIncremental</A></B>(boolean incremental)</CODE>
|
|
|
| <BR>
|
| Set a flag indicating whether an incremental transform is desired |
| This flag should have the same value as the FEATURE_INCREMENTAL feature |
| which is set by the TransformerFactory.setAttribut() method before a |
| DTMManager is created</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#setSource_location(boolean)">setSource_location</A></B>(boolean sourceLocation)</CODE>
|
|
|
| <BR>
|
| Set a flag indicating whether the transformation phase should |
| keep track of line and column numbers for the input source |
| document.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMManager.html#setXMLStringFactory(org.apache.xml.utils.XMLStringFactory)">setXMLStringFactory</A></B>(<A HREF="../../../../org/apache/xml/utils/XMLStringFactory.html">XMLStringFactory</A> xsf)</CODE>
|
|
|
| <BR>
|
| Set the XMLStringFactory used for the DTMs.</TD>
|
| </TR>
|
| </TABLE>
|
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Methods inherited from class java.lang.Object</B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE>equals,
|
| getClass,
|
| hashCode,
|
| notify,
|
| notifyAll,
|
| toString,
|
| wait,
|
| wait,
|
| wait</CODE></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <P>
|
|
|
| <!-- ============ FIELD DETAIL =========== -->
|
|
|
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Field Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="m_incremental"><!-- --></A><H3>
|
| m_incremental</H3>
|
| <PRE>
|
| public boolean <B>m_incremental</B></PRE>
|
| <DL>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="m_source_location"><!-- --></A><H3>
|
| m_source_location</H3>
|
| <PRE>
|
| public boolean <B>m_source_location</B></PRE>
|
| <DL>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="IDENT_DTM_NODE_BITS"><!-- --></A><H3>
|
| IDENT_DTM_NODE_BITS</H3>
|
| <PRE>
|
| public static final int <B>IDENT_DTM_NODE_BITS</B></PRE>
|
| <DL>
|
| <DD>This value, set at compile time, controls how many bits of the |
| DTM node identifier numbers are used to identify a node within a |
| document, and thus sets the maximum number of nodes per |
| document. The remaining bits are used to identify the DTM |
| document which contains this node. |
| |
| If you change IDENT_DTM_NODE_BITS, be sure to rebuild _ALL_ the |
| files which use it... including the IDKey testcases. |
| |
| (FuncGenerateKey currently uses the node identifier directly and |
| thus is affected when this changes. The IDKEY results will still be |
| _correct_ (presuming no other breakage), but simple equality |
| comparison against the previous "golden" files will probably |
| complain.)</DL>
|
| <HR>
|
|
|
| <A NAME="IDENT_NODE_DEFAULT"><!-- --></A><H3>
|
| IDENT_NODE_DEFAULT</H3>
|
| <PRE>
|
| public static final int <B>IDENT_NODE_DEFAULT</B></PRE>
|
| <DL>
|
| <DD>When this bitmask is ANDed with a DTM node handle number, the result |
| is the low bits of the node's index number within that DTM. To obtain |
| the high bits, add the DTM ID portion's offset as assigned in the DTM |
| Manager.</DL>
|
| <HR>
|
|
|
| <A NAME="IDENT_DTM_DEFAULT"><!-- --></A><H3>
|
| IDENT_DTM_DEFAULT</H3>
|
| <PRE>
|
| public static final int <B>IDENT_DTM_DEFAULT</B></PRE>
|
| <DL>
|
| <DD>When this bitmask is ANDed with a DTM node handle number, the result |
| is the DTM's document identity number.</DL>
|
| <HR>
|
|
|
| <A NAME="IDENT_MAX_DTMS"><!-- --></A><H3>
|
| IDENT_MAX_DTMS</H3>
|
| <PRE>
|
| public static final int <B>IDENT_MAX_DTMS</B></PRE>
|
| <DL>
|
| <DD>This is the maximum number of DTMs available. The highest DTM is |
| one less than this.</DL>
|
|
|
| <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
|
|
| <!-- ============ METHOD DETAIL ========== -->
|
|
|
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Method Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="getXMLStringFactory()"><!-- --></A><H3>
|
| getXMLStringFactory</H3>
|
| <PRE>
|
| public <A HREF="../../../../org/apache/xml/utils/XMLStringFactory.html">XMLStringFactory</A> <B>getXMLStringFactory</B>()</PRE>
|
| <DL>
|
| <DD>Get the XMLStringFactory used for the DTMs.<DD><DL>
|
| <DT><B>Returns:</B><DD>a valid XMLStringFactory object, or null if it hasn't been set yet.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setXMLStringFactory(org.apache.xml.utils.XMLStringFactory)"><!-- --></A><H3>
|
| setXMLStringFactory</H3>
|
| <PRE>
|
| public void <B>setXMLStringFactory</B>(<A HREF="../../../../org/apache/xml/utils/XMLStringFactory.html">XMLStringFactory</A> xsf)</PRE>
|
| <DL>
|
| <DD>Set the XMLStringFactory used for the DTMs.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xsf</CODE> - a valid XMLStringFactory object, should not be null.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="newInstance(org.apache.xml.utils.XMLStringFactory)"><!-- --></A><H3>
|
| newInstance</H3>
|
| <PRE>
|
| public static <A HREF="../../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> <B>newInstance</B>(<A HREF="../../../../org/apache/xml/utils/XMLStringFactory.html">XMLStringFactory</A> xsf) |
| throws <A HREF="../../../../org/apache/xml/dtm/DTMConfigurationException.html">DTMConfigurationException</A></PRE>
|
| <DL>
|
| <DD>Obtain a new instance of a <code>DTMManager</code>. |
| This static method creates a new factory instance |
| This method uses the following ordered lookup procedure to determine |
| the <code>DTMManager</code> implementation class to |
| load: |
| <ul> |
| <li> |
| Use the <code>org.apache.xml.dtm.DTMManager</code> system |
| property. |
| </li> |
| <li> |
| Use the JAVA_HOME(the parent directory where jdk is |
| installed)/lib/xalan.properties for a property file that contains the |
| name of the implementation class keyed on the same value as the |
| system property defined above. |
| </li> |
| <li> |
| Use the Services API (as detailed in the JAR specification), if |
| available, to determine the classname. The Services API will look |
| for a classname in the file |
| <code>META-INF/services/org.apache.xml.dtm.DTMManager</code> |
| in jars available to the runtime. |
| </li> |
| <li> |
| Use the default <code>DTMManager</code> classname, which is |
| <code>org.apache.xml.dtm.ref.DTMManagerDefault</code>. |
| </li> |
| </ul> |
| |
| Once an application has obtained a reference to a <code> |
| DTMManager</code> it can use the factory to configure |
| and obtain parser instances.<DD><DL>
|
| <DT><B>Returns:</B><DD>new DTMManager instance, never null.<DT><B>Throws:</B><DD><A HREF="../../../../org/apache/xml/dtm/DTMConfigurationException.html">DTMConfigurationException</A> - if the implementation is not available or cannot be instantiated.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getDTM(javax.xml.transform.Source, boolean, org.apache.xml.dtm.DTMWSFilter, boolean, boolean)"><!-- --></A><H3>
|
| getDTM</H3>
|
| <PRE>
|
| public abstract <A HREF="../../../../org/apache/xml/dtm/DTM.html">DTM</A> <B>getDTM</B>(<A HREF="../../../../javax/xml/transform/Source.html">Source</A> source, |
| boolean unique, |
| <A HREF="../../../../org/apache/xml/dtm/DTMWSFilter.html">DTMWSFilter</A> whiteSpaceFilter, |
| boolean incremental, |
| boolean doIndexing)</PRE>
|
| <DL>
|
| <DD>Get an instance of a DTM, loaded with the content from the |
| specified source. If the unique flag is true, a new instance will |
| always be returned. Otherwise it is up to the DTMManager to return a |
| new instance or an instance that it already created and may be being used |
| by someone else. |
| |
| (More parameters may eventually need to be added for error handling |
| and entity resolution, and to better control selection of implementations.)<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>source</CODE> - the specification of the source object, which may be null, |
| in which case it is assumed that node construction will take |
| by some other means.<DD><CODE>unique</CODE> - true if the returned DTM must be unique, probably because it |
| is going to be mutated.<DD><CODE>whiteSpaceFilter</CODE> - Enables filtering of whitespace nodes, and may |
| be null.<DD><CODE>incremental</CODE> - true if the DTM should be built incrementally, if |
| possible.<DD><CODE>doIndexing</CODE> - true if the caller considers it worth it to use |
| indexing schemes.<DT><B>Returns:</B><DD>a non-null DTM reference.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getDTM(int)"><!-- --></A><H3>
|
| getDTM</H3>
|
| <PRE>
|
| public abstract <A HREF="../../../../org/apache/xml/dtm/DTM.html">DTM</A> <B>getDTM</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Get the instance of DTM that "owns" a node handle.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the nodeHandle.<DT><B>Returns:</B><DD>a non-null DTM reference.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getDTMHandleFromNode(org.w3c.dom.Node)"><!-- --></A><H3>
|
| getDTMHandleFromNode</H3>
|
| <PRE>
|
| public abstract int <B>getDTMHandleFromNode</B>(<A HREF="../../../../org/w3c/dom/Node.html">Node</A> node)</PRE>
|
| <DL>
|
| <DD>Given a W3C DOM node, try and return a DTM handle. |
| Note: calling this may be non-optimal.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>node</CODE> - Non-null reference to a DOM node.<DT><B>Returns:</B><DD>a valid DTM handle.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="createDocumentFragment()"><!-- --></A><H3>
|
| createDocumentFragment</H3>
|
| <PRE>
|
| public abstract <A HREF="../../../../org/apache/xml/dtm/DTM.html">DTM</A> <B>createDocumentFragment</B>()</PRE>
|
| <DL>
|
| <DD>Creates a DTM representing an empty <code>DocumentFragment</code> object.<DD><DL>
|
| <DT><B>Returns:</B><DD>a non-null DTM reference.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="release(org.apache.xml.dtm.DTM, boolean)"><!-- --></A><H3>
|
| release</H3>
|
| <PRE>
|
| public abstract boolean <B>release</B>(<A HREF="../../../../org/apache/xml/dtm/DTM.html">DTM</A> dtm, |
| boolean shouldHardDelete)</PRE>
|
| <DL>
|
| <DD>Release a DTM either to a lru pool, or completely remove reference. |
| DTMs without system IDs are always hard deleted. |
| State: experimental.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>dtm</CODE> - The DTM to be released.<DD><CODE>shouldHardDelete</CODE> - True if the DTM should be removed no matter what.<DT><B>Returns:</B><DD>true if the DTM was removed, false if it was put back in a lru pool.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="createDTMIterator(java.lang.Object, int)"><!-- --></A><H3>
|
| createDTMIterator</H3>
|
| <PRE>
|
| public abstract <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A> <B>createDTMIterator</B>(java.lang.Object xpathCompiler, |
| int pos)</PRE>
|
| <DL>
|
| <DD>Create a new <code>DTMIterator</code> based on an XPath |
| <a href="http://www.w3.org/TR/xpath#NT-LocationPath>LocationPath</a> or |
| a <a href="http://www.w3.org/TR/xpath#NT-UnionExpr">UnionExpr</a>.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xpathCompiler</CODE> - ??? Somehow we need to pass in a subpart of the |
| expression. I hate to do this with strings, since the larger expression |
| has already been parsed.<DD><CODE>pos</CODE> - The position in the expression.<DT><B>Returns:</B><DD>The newly created <code>DTMIterator</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="createDTMIterator(java.lang.String, org.apache.xml.utils.PrefixResolver)"><!-- --></A><H3>
|
| createDTMIterator</H3>
|
| <PRE>
|
| public abstract <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A> <B>createDTMIterator</B>(java.lang.String xpathString, |
| <A HREF="../../../../org/apache/xml/utils/PrefixResolver.html">PrefixResolver</A> presolver)</PRE>
|
| <DL>
|
| <DD>Create a new <code>DTMIterator</code> based on an XPath |
| <a href="http://www.w3.org/TR/xpath#NT-LocationPath>LocationPath</a> or |
| a <a href="http://www.w3.org/TR/xpath#NT-UnionExpr">UnionExpr</a>.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xpathString</CODE> - Must be a valid string expressing a |
| <a href="http://www.w3.org/TR/xpath#NT-LocationPath>LocationPath</a> or |
| a <a href="http://www.w3.org/TR/xpath#NT-UnionExpr">UnionExpr</a>.<DD><CODE>presolver</CODE> - An object that can resolve prefixes to namespace URLs.<DT><B>Returns:</B><DD>The newly created <code>DTMIterator</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="createDTMIterator(int, org.apache.xml.dtm.DTMFilter, boolean)"><!-- --></A><H3>
|
| createDTMIterator</H3>
|
| <PRE>
|
| public abstract <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A> <B>createDTMIterator</B>(int whatToShow, |
| <A HREF="../../../../org/apache/xml/dtm/DTMFilter.html">DTMFilter</A> filter, |
| boolean entityReferenceExpansion)</PRE>
|
| <DL>
|
| <DD>Create a new <code>DTMIterator</code> based only on a whatToShow |
| and a DTMFilter. The traversal semantics are defined as the |
| descendant access. |
| <p> |
| Note that DTMIterators may not be an exact match to DOM |
| NodeIterators. They are initialized and used in much the same way |
| as a NodeIterator, but their response to document mutation is not |
| currently defined.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>whatToShow</CODE> - This flag specifies which node types may appear in |
| the logical view of the tree presented by the iterator. See the |
| description of <code>NodeFilter</code> for the set of possible |
| <code>SHOW_</code> values.These flags can be combined using |
| <code>OR</code>.<DD><CODE>filter</CODE> - The <code>NodeFilter</code> to be used with this |
| <code>DTMFilter</code>, or <code>null</code> to indicate no filter.<DD><CODE>entityReferenceExpansion</CODE> - The value of this flag determines |
| whether entity reference nodes are expanded.<DT><B>Returns:</B><DD>The newly created <code>DTMIterator</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="createDTMIterator(int)"><!-- --></A><H3>
|
| createDTMIterator</H3>
|
| <PRE>
|
| public abstract <A HREF="../../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A> <B>createDTMIterator</B>(int node)</PRE>
|
| <DL>
|
| <DD>Create a new <code>DTMIterator</code> that holds exactly one node.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>node</CODE> - The node handle that the DTMIterator will iterate to.<DT><B>Returns:</B><DD>The newly created <code>DTMIterator</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getIncremental()"><!-- --></A><H3>
|
| getIncremental</H3>
|
| <PRE>
|
| public boolean <B>getIncremental</B>()</PRE>
|
| <DL>
|
| <DD>Get a flag indicating whether an incremental transform is desired<DD><DL>
|
| <DT><B>Returns:</B><DD>incremental boolean.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setIncremental(boolean)"><!-- --></A><H3>
|
| setIncremental</H3>
|
| <PRE>
|
| public void <B>setIncremental</B>(boolean incremental)</PRE>
|
| <DL>
|
| <DD>Set a flag indicating whether an incremental transform is desired |
| This flag should have the same value as the FEATURE_INCREMENTAL feature |
| which is set by the TransformerFactory.setAttribut() method before a |
| DTMManager is created<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>incremental</CODE> - boolean to use to set m_incremental.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getSource_location()"><!-- --></A><H3>
|
| getSource_location</H3>
|
| <PRE>
|
| public boolean <B>getSource_location</B>()</PRE>
|
| <DL>
|
| <DD>Get a flag indicating whether the transformation phase should |
| keep track of line and column numbers for the input source |
| document.<DD><DL>
|
| <DT><B>Returns:</B><DD>source location boolean</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setSource_location(boolean)"><!-- --></A><H3>
|
| setSource_location</H3>
|
| <PRE>
|
| public void <B>setSource_location</B>(boolean sourceLocation)</PRE>
|
| <DL>
|
| <DD>Set a flag indicating whether the transformation phase should |
| keep track of line and column numbers for the input source |
| document. |
| This flag should have the same value as the FEATURE_SOURCE_LOCATION feature |
| which is set by the TransformerFactory.setAttribut() method before a |
| DTMManager is created<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>sourceLocation</CODE> - boolean to use to set m_source_location</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getDTMIdentity(org.apache.xml.dtm.DTM)"><!-- --></A><H3>
|
| getDTMIdentity</H3>
|
| <PRE>
|
| public abstract int <B>getDTMIdentity</B>(<A HREF="../../../../org/apache/xml/dtm/DTM.html">DTM</A> dtm)</PRE>
|
| <DL>
|
| <DD>%TBD% Doc |
| |
| NEEDSDOC @param dtm |
| |
| NEEDSDOC ($objectName$) @return</DL>
|
| <HR>
|
|
|
| <A NAME="getDTMIdentityMask()"><!-- --></A><H3>
|
| getDTMIdentityMask</H3>
|
| <PRE>
|
| public int <B>getDTMIdentityMask</B>()</PRE>
|
| <DL>
|
| <DD>%TBD% Doc |
| |
| NEEDSDOC ($objectName$) @return</DL>
|
| <HR>
|
|
|
| <A NAME="getNodeIdentityMask()"><!-- --></A><H3>
|
| getNodeIdentityMask</H3>
|
| <PRE>
|
| public int <B>getNodeIdentityMask</B>()</PRE>
|
| <DL>
|
| <DD>%TBD% Doc |
| |
| NEEDSDOC ($objectName$) @return</DL>
|
| <!-- ========= END OF CLASS DATA ========= -->
|
| <HR>
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <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="class-use/DTMManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../../org/apache/xml/dtm/DTMAxisTraverser.html"><B>PREV CLASS</B></A>
|
| NEXT CLASS</FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="DTMManager.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| Copyright © 2006 Apache XML Project. All Rights Reserved.
|
| </BODY>
|
| </HTML>
|
