Google Git
Sign in
apache / xalan-site / 9bd7a158adb6ed5414b8eefa57ab0f8b842ed7a3 / . / docs / xalan / xalan-j / apidocs / org / apache / xml / dtm / DTMFilter.html
blob: be6b78eb5ecbd8c32365ec41af7900cc05d9fb81 [file] [log] [blame]
<!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.5.0_18) on Sun Apr 01 21:18:30 PDT 2012 -->
<TITLE>
DTMFilter
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xml.dtm.DTMFilter interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="DTMFilter";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= 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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DTMFilter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/xml/dtm/DTMException.html" title="class in org.apache.xml.dtm"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xml/dtm/DTMFilter.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="DTMFilter.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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">
org.apache.xml.dtm</FONT>
<BR>
Interface DTMFilter</H2>
<HR>
<DL>
<DT><PRE>public interface <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.27"><B>DTMFilter</B></A></DL>
</PRE>
<P>
Simple filter for doing node tests. Note the semantics of this are
somewhat different that the DOM's NodeFilter.
<P>
<P>
<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>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#SHOW_ALL">SHOW_ALL</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Show all <code>Nodes</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#SHOW_ATTRIBUTE">SHOW_ATTRIBUTE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Show <code>Attr</code> nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#SHOW_BYFUNCTION">SHOW_BYFUNCTION</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Special bit for filters implementing match patterns starting with
a function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#SHOW_CDATA_SECTION">SHOW_CDATA_SECTION</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Show <code>CDATASection</code> nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#SHOW_COMMENT">SHOW_COMMENT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Show <code>Comment</code> nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#SHOW_DOCUMENT">SHOW_DOCUMENT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Show <code>Document</code> nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#SHOW_DOCUMENT_FRAGMENT">SHOW_DOCUMENT_FRAGMENT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Show <code>DocumentFragment</code> nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#SHOW_DOCUMENT_TYPE">SHOW_DOCUMENT_TYPE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Show <code>DocumentType</code> nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#SHOW_ELEMENT">SHOW_ELEMENT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Show <code>Element</code> nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#SHOW_ENTITY">SHOW_ENTITY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Show <code>Entity</code> nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#SHOW_ENTITY_REFERENCE">SHOW_ENTITY_REFERENCE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Show <code>EntityReference</code> nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#SHOW_NAMESPACE">SHOW_NAMESPACE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This bit instructs the iterator to show namespace nodes, which
are modeled by DTM but not by the DOM.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#SHOW_NOTATION">SHOW_NOTATION</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Show <code>Notation</code> nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#SHOW_PROCESSING_INSTRUCTION">SHOW_PROCESSING_INSTRUCTION</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Show <code>ProcessingInstruction</code> nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#SHOW_TEXT">SHOW_TEXT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Show <code>Text</code> nodes.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#acceptNode(int, int)">acceptNode</A></B>(int&nbsp;nodeHandle,
int&nbsp;whatToShow)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Test whether a specified node is visible in the logical view of a
<code>DTMIterator</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/DTMFilter.html#acceptNode(int, int, int)">acceptNode</A></B>(int&nbsp;nodeHandle,
int&nbsp;whatToShow,
int&nbsp;expandedName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Test whether a specified node is visible in the logical view of a
<code>DTMIterator</code>.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="SHOW_ALL"><!-- --></A><H3>
SHOW_ALL</H3>
<PRE>
static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.37"><B>SHOW_ALL</B></A></PRE>
<DL>
<DD>Show all <code>Nodes</code>.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTMFilter.SHOW_ALL">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SHOW_ELEMENT"><!-- --></A><H3>
SHOW_ELEMENT</H3>
<PRE>
static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.42"><B>SHOW_ELEMENT</B></A></PRE>
<DL>
<DD>Show <code>Element</code> nodes.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTMFilter.SHOW_ELEMENT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SHOW_ATTRIBUTE"><!-- --></A><H3>
SHOW_ATTRIBUTE</H3>
<PRE>
static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.52"><B>SHOW_ATTRIBUTE</B></A></PRE>
<DL>
<DD>Show <code>Attr</code> nodes. This is meaningful only when creating an
iterator or tree-walker with an attribute node as its
<code>root</code>; in this case, it means that the attribute node
will appear in the first position of the iteration or traversal.
Since attributes are never children of other nodes, they do not
appear when traversing over the main document tree.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTMFilter.SHOW_ATTRIBUTE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SHOW_TEXT"><!-- --></A><H3>
SHOW_TEXT</H3>
<PRE>
static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.57"><B>SHOW_TEXT</B></A></PRE>
<DL>
<DD>Show <code>Text</code> nodes.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTMFilter.SHOW_TEXT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SHOW_CDATA_SECTION"><!-- --></A><H3>
SHOW_CDATA_SECTION</H3>
<PRE>
static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.62"><B>SHOW_CDATA_SECTION</B></A></PRE>
<DL>
<DD>Show <code>CDATASection</code> nodes.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTMFilter.SHOW_CDATA_SECTION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SHOW_ENTITY_REFERENCE"><!-- --></A><H3>
SHOW_ENTITY_REFERENCE</H3>
<PRE>
static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.69"><B>SHOW_ENTITY_REFERENCE</B></A></PRE>
<DL>
<DD>Show <code>EntityReference</code> nodes. Note that if Entity References
have been fully expanded while the tree was being constructed, these
nodes will not appear and this mask has no effect.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTMFilter.SHOW_ENTITY_REFERENCE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SHOW_ENTITY"><!-- --></A><H3>
SHOW_ENTITY</H3>
<PRE>
static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.79"><B>SHOW_ENTITY</B></A></PRE>
<DL>
<DD>Show <code>Entity</code> nodes. This is meaningful only when creating
an iterator or tree-walker with an<code> Entity</code> node as its
<code>root</code>; in this case, it means that the <code>Entity</code>
node will appear in the first position of the traversal. Since
entities are not part of the document tree, they do not appear when
traversing over the main document tree.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTMFilter.SHOW_ENTITY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SHOW_PROCESSING_INSTRUCTION"><!-- --></A><H3>
SHOW_PROCESSING_INSTRUCTION</H3>
<PRE>
static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.84"><B>SHOW_PROCESSING_INSTRUCTION</B></A></PRE>
<DL>
<DD>Show <code>ProcessingInstruction</code> nodes.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTMFilter.SHOW_PROCESSING_INSTRUCTION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SHOW_COMMENT"><!-- --></A><H3>
SHOW_COMMENT</H3>
<PRE>
static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.89"><B>SHOW_COMMENT</B></A></PRE>
<DL>
<DD>Show <code>Comment</code> nodes.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTMFilter.SHOW_COMMENT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SHOW_DOCUMENT"><!-- --></A><H3>
SHOW_DOCUMENT</H3>
<PRE>
static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.96"><B>SHOW_DOCUMENT</B></A></PRE>
<DL>
<DD>Show <code>Document</code> nodes. (Of course, as with Attributes
and such, this is meaningful only when the iteration root is the
Document itself, since Document has no parent.)
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTMFilter.SHOW_DOCUMENT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SHOW_DOCUMENT_TYPE"><!-- --></A><H3>
SHOW_DOCUMENT_TYPE</H3>
<PRE>
static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.101"><B>SHOW_DOCUMENT_TYPE</B></A></PRE>
<DL>
<DD>Show <code>DocumentType</code> nodes.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTMFilter.SHOW_DOCUMENT_TYPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SHOW_DOCUMENT_FRAGMENT"><!-- --></A><H3>
SHOW_DOCUMENT_FRAGMENT</H3>
<PRE>
static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.108"><B>SHOW_DOCUMENT_FRAGMENT</B></A></PRE>
<DL>
<DD>Show <code>DocumentFragment</code> nodes. (Of course, as with
Attributes and such, this is meaningful only when the iteration
root is the Document itself, since DocumentFragment has no parent.)
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTMFilter.SHOW_DOCUMENT_FRAGMENT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SHOW_NOTATION"><!-- --></A><H3>
SHOW_NOTATION</H3>
<PRE>
static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.118"><B>SHOW_NOTATION</B></A></PRE>
<DL>
<DD>Show <code>Notation</code> nodes. This is meaningful only when creating
an iterator or tree-walker with a <code>Notation</code> node as its
<code>root</code>; in this case, it means that the
<code>Notation</code> node will appear in the first position of the
traversal. Since notations are not part of the document tree, they do
not appear when traversing over the main document tree.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTMFilter.SHOW_NOTATION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SHOW_NAMESPACE"><!-- --></A><H3>
SHOW_NAMESPACE</H3>
<PRE>
static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.130"><B>SHOW_NAMESPACE</B></A></PRE>
<DL>
<DD>This bit instructs the iterator to show namespace nodes, which
are modeled by DTM but not by the DOM. Make sure this does not
conflict with <CODE>NodeFilter</CODE>.
<p>
%REVIEW% Might be safer to start from higher bits and work down,
to leave room for the DOM to expand its set of constants... Or,
possibly, to create a DTM-specific field for these additional bits.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTMFilter.SHOW_NAMESPACE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SHOW_BYFUNCTION"><!-- --></A><H3>
SHOW_BYFUNCTION</H3>
<PRE>
static final int <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.141"><B>SHOW_BYFUNCTION</B></A></PRE>
<DL>
<DD>Special bit for filters implementing match patterns starting with
a function. Make sure this does not conflict with
<CODE>NodeFilter</CODE>.
<p>
%REVIEW% Might be safer to start from higher bits and work down,
to leave room for the DOM to expand its set of constants... Or,
possibly, to create a DTM-specific field for these additional bits.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.DTMFilter.SHOW_BYFUNCTION">Constant Field Values</A></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="acceptNode(int, int)"><!-- --></A><H3>
acceptNode</H3>
<PRE>
short <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.154"><B>acceptNode</B></A>(int&nbsp;nodeHandle,
int&nbsp;whatToShow)</PRE>
<DL>
<DD>Test whether a specified node is visible in the logical view of a
<code>DTMIterator</code>. Normally, this function
will be called by the implementation of <code>DTMIterator</code>;
it is not normally called directly from
user code.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - int Handle of the node.<DD><CODE>whatToShow</CODE> - one of SHOW_XXX values.
<DT><B>Returns:</B><DD>one of FILTER_ACCEPT, FILTER_REJECT, or FILTER_SKIP.</DL>
</DD>
</DL>
<HR>
<A NAME="acceptNode(int, int, int)"><!-- --></A><H3>
acceptNode</H3>
<PRE>
short <A HREF="../../../../src-html/org/apache/xml/dtm/DTMFilter.html#line.186"><B>acceptNode</B></A>(int&nbsp;nodeHandle,
int&nbsp;whatToShow,
int&nbsp;expandedName)</PRE>
<DL>
<DD>Test whether a specified node is visible in the logical view of a
<code>DTMIterator</code>. Normally, this function
will be called by the implementation of <code>DTMIterator</code>;
it is not normally called directly from
user code.
<p>
TODO: Should this be setNameMatch(expandedName) followed by accept()?
Or will we really be testing a different name at every invocation?
<p>%REVIEW% Under what circumstances will this be used? The cases
I've considered are just as easy and just about as efficient if
the name test is performed in the DTMIterator... -- Joe</p>
<p>%REVIEW% Should that 0xFFFF have a mnemonic assigned to it?
Also: This representation is assuming the expanded name is indeed
split into high/low 16-bit halfwords. If we ever change the
balance between namespace and localname bits (eg because we
decide there are many more localnames than namespaces, which is
fairly likely), this is going to break. It might be safer to
encapsulate the details with a makeExpandedName method and make
that responsible for setting up the wildcard version as well.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - int Handle of the node.<DD><CODE>whatToShow</CODE> - one of SHOW_XXX values.<DD><CODE>expandedName</CODE> - a value defining the exanded name as defined in
the DTM interface. Wild cards will be defined
by 0xFFFF in the namespace and/or localname
portion of the expandedName.
<DT><B>Returns:</B><DD>one of FILTER_ACCEPT, FILTER_REJECT, or FILTER_SKIP.</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DTMFilter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/xml/dtm/DTMException.html" title="class in org.apache.xml.dtm"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xml/dtm/DTMIterator.html" title="interface in org.apache.xml.dtm"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xml/dtm/DTMFilter.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="DTMFilter.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>