<!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:24 GMT 2011 -->
<TITLE>
NameTest
</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="NameTest";
}
}
</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/pattern/NamespaceTest.html" title="class in net.sf.saxon.pattern"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/pattern/NodeKindTest.html" title="class in net.sf.saxon.pattern"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/pattern/NameTest.html" target="_top"><B>FRAMES</B></A>
<A HREF="NameTest.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 | FIELD | <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.pattern</FONT>
<BR>
Class NameTest</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/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">net.sf.saxon.pattern.NodeTest</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.saxon.pattern.NameTest</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/pattern/QNameTest.html" title="interface in net.sf.saxon.pattern">QNameTest</A>, <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>NameTest</B><DT>extends <A HREF="../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A><DT>implements <A HREF="../../../../net/sf/saxon/pattern/QNameTest.html" title="interface in net.sf.saxon.pattern">QNameTest</A></DL>
</PRE>
<P>
NodeTest is an interface that enables a test of whether a node has a particular
name and type. A NameTest matches the node kind and the namespace URI and the local
name.
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>Michael H. Kay</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#net.sf.saxon.pattern.NameTest">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== 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/pattern/NameTest.html#NameTest(int, int, net.sf.saxon.om.NamePool)">NameTest</A></B>(int nodeKind,
int nameCode,
<A HREF="../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> namePool)</CODE>
<BR>
Create a NameTest to match nodes by their nameCode allocated from the NamePool</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pattern/NameTest.html#NameTest(int, net.sf.saxon.om.NodeName, net.sf.saxon.om.NamePool)">NameTest</A></B>(int nodeKind,
<A HREF="../../../../net/sf/saxon/om/NodeName.html" title="interface in net.sf.saxon.om">NodeName</A> name,
<A HREF="../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> pool)</CODE>
<BR>
Create a NameTest to match nodes by name</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pattern/NameTest.html#NameTest(int, java.lang.String, java.lang.String, net.sf.saxon.om.NamePool)">NameTest</A></B>(int nodeKind,
<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> uri,
<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> localName,
<A HREF="../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> namePool)</CODE>
<BR>
Create a NameTest to match nodes by name</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pattern/NameTest.html#NameTest(net.sf.saxon.om.NodeInfo)">NameTest</A></B>(<A HREF="../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node)</CODE>
<BR>
Create a NameTest for nodes of the same type and name as a given node</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> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pattern/NameTest.html#equals(java.lang.Object)">equals</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> other)</CODE>
<BR>
Determines whether two NameTests are equal</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> double</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pattern/NameTest.html#getDefaultPriority()">getDefaultPriority</A></B>()</CODE>
<BR>
Determine the default priority of this node test when used on its own as a Pattern</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="../../../../net/sf/saxon/pattern/NameTest.html#getFingerprint()">getFingerprint</A></B>()</CODE>
<BR>
Get the fingerprint required</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pattern/NameTest.html#getNamePool()">getNamePool</A></B>()</CODE>
<BR>
Get the NamePool associated with this NameTest</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="../../../../net/sf/saxon/pattern/NameTest.html#getNodeKindMask()">getNodeKindMask</A></B>()</CODE>
<BR>
Get a mask indicating which kinds of nodes this NodeTest can match.</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="../../../../net/sf/saxon/pattern/NameTest.html#getPrimitiveType()">getPrimitiveType</A></B>()</CODE>
<BR>
Determine the types of nodes to which this pattern applies.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/expr/sort/IntSet.html" title="interface in net.sf.saxon.expr.sort">IntSet</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pattern/NameTest.html#getRequiredNodeNames()">getRequiredNodeNames</A></B>()</CODE>
<BR>
Get the set of node names allowed by this NodeTest.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pattern/NameTest.html#getSuperType(net.sf.saxon.type.TypeHierarchy)">getSuperType</A></B>(<A HREF="../../../../net/sf/saxon/type/TypeHierarchy.html" title="class in net.sf.saxon.type">TypeHierarchy</A> th)</CODE>
<BR>
Get the type from which this item type is derived by restriction.</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="../../../../net/sf/saxon/pattern/NameTest.html#hashCode()">hashCode</A></B>()</CODE>
<BR>
Returns a hash code value for the object.</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/pattern/NameTest.html#matches(int, net.sf.saxon.om.NodeName, int)">matches</A></B>(int nodeKind,
<A HREF="../../../../net/sf/saxon/om/NodeName.html" title="interface in net.sf.saxon.om">NodeName</A> name,
int annotation)</CODE>
<BR>
Test whether this node test is satisfied by a given node.</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/pattern/NameTest.html#matches(net.sf.saxon.om.NodeInfo)">matches</A></B>(<A HREF="../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node)</CODE>
<BR>
Test whether this node test is satisfied by a given node.</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/pattern/NameTest.html#matches(net.sf.saxon.om.StructuredQName)">matches</A></B>(<A HREF="../../../../net/sf/saxon/om/StructuredQName.html" title="class in net.sf.saxon.om">StructuredQName</A> qname)</CODE>
<BR>
Test whether the NameTest matches a given QName</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/pattern/NameTest.html#matches(net.sf.saxon.tree.tiny.TinyTree, int)">matches</A></B>(<A HREF="../../../../net/sf/saxon/tree/tiny/TinyTree.html" title="class in net.sf.saxon.tree.tiny">TinyTree</A> tree,
int nodeNr)</CODE>
<BR>
Test whether this node test is satisfied by a given node on a TinyTree.</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/pattern/NameTest.html#toString()">toString</A></B>()</CODE>
<BR>
</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/pattern/NameTest.html#toString(net.sf.saxon.om.NamePool)">toString</A></B>(<A HREF="../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> pool)</CODE>
<BR>
Display the type descriptor for diagnostics</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_net.sf.saxon.pattern.NodeTest"><!-- --></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.pattern.<A HREF="../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#getAtomizedItemType()">getAtomizedItemType</A>, <A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#getContentType()">getContentType</A>, <A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#getPrimitiveItemType()">getPrimitiveItemType</A>, <A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#isAtomicType()">isAtomicType</A>, <A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#isAtomizable()">isAtomizable</A>, <A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#isNillable()">isNillable</A>, <A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#isPlainType()">isPlainType</A>, <A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#matches(net.sf.saxon.om.Item, net.sf.saxon.expr.XPathContext)">matches</A>, <A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#matchesItem(net.sf.saxon.om.Item, boolean, net.sf.saxon.Configuration)">matchesItem</A>, <A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#visitNamedSchemaComponents(net.sf.saxon.type.SchemaComponentVisitor)">visitNamedSchemaComponents</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#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#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#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="NameTest(int, java.lang.String, java.lang.String, net.sf.saxon.om.NamePool)"><!-- --></A><H3>
NameTest</H3>
<PRE>
public <B>NameTest</B>(int nodeKind,
<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> uri,
<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> localName,
<A HREF="../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> namePool)</PRE>
<DL>
<DD>Create a NameTest to match nodes by name
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>nodeKind</CODE> - the kind of node, for example <A HREF="../../../../net/sf/saxon/type/Type.html#ELEMENT"><CODE>Type.ELEMENT</CODE></A><DD><CODE>uri</CODE> - the namespace URI of the required nodes. Supply "" to match nodes that are in
no namespace<DD><CODE>localName</CODE> - the local name of the required nodes. Supply "" to match unnamed nodes<DD><CODE>namePool</CODE> - the namePool holding the name codes<DT><B>Since:</B></DT>
<DD>9.0</DD>
</DL>
</DL>
<HR>
<A NAME="NameTest(int, int, net.sf.saxon.om.NamePool)"><!-- --></A><H3>
NameTest</H3>
<PRE>
public <B>NameTest</B>(int nodeKind,
int nameCode,
<A HREF="../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> namePool)</PRE>
<DL>
<DD>Create a NameTest to match nodes by their nameCode allocated from the NamePool
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>nodeKind</CODE> - the kind of node, for example <A HREF="../../../../net/sf/saxon/type/Type.html#ELEMENT"><CODE>Type.ELEMENT</CODE></A><DD><CODE>nameCode</CODE> - the nameCode representing the name of the node<DD><CODE>namePool</CODE> - the namePool holding the name codes<DT><B>Since:</B></DT>
<DD>8.4</DD>
</DL>
</DL>
<HR>
<A NAME="NameTest(int, net.sf.saxon.om.NodeName, net.sf.saxon.om.NamePool)"><!-- --></A><H3>
NameTest</H3>
<PRE>
public <B>NameTest</B>(int nodeKind,
<A HREF="../../../../net/sf/saxon/om/NodeName.html" title="interface in net.sf.saxon.om">NodeName</A> name,
<A HREF="../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> pool)</PRE>
<DL>
<DD>Create a NameTest to match nodes by name
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>nodeKind</CODE> - the kind of node, for example <A HREF="../../../../net/sf/saxon/type/Type.html#ELEMENT"><CODE>Type.ELEMENT</CODE></A><DD><CODE>name</CODE> - the name of the nodes that this NameTest will match<DD><CODE>pool</CODE> - the namePool holding the name codes<DT><B>Since:</B></DT>
<DD>9.4</DD>
</DL>
</DL>
<HR>
<A NAME="NameTest(net.sf.saxon.om.NodeInfo)"><!-- --></A><H3>
NameTest</H3>
<PRE>
public <B>NameTest</B>(<A HREF="../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node)</PRE>
<DL>
<DD>Create a NameTest for nodes of the same type and name as a given node
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node whose node kind and node name will form the basis of the NameTest</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="getNamePool()"><!-- --></A><H3>
getNamePool</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> <B>getNamePool</B>()</PRE>
<DL>
<DD>Get the NamePool associated with this NameTest
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the NamePool</DL>
</DD>
</DL>
<HR>
<A NAME="matches(int, net.sf.saxon.om.NodeName, int)"><!-- --></A><H3>
matches</H3>
<PRE>
public boolean <B>matches</B>(int nodeKind,
<A HREF="../../../../net/sf/saxon/om/NodeName.html" title="interface in net.sf.saxon.om">NodeName</A> name,
int annotation)</PRE>
<DL>
<DD>Test whether this node test is satisfied by a given node. This method is only
fully supported for a subset of NodeTests, because it doesn't provide all the information
needed to evaluate all node tests. In particular (a) it can't be used to evaluate a node
test of the form element(N,T) or schema-element(E) where it is necessary to know whether the
node is nilled, and (b) it can't be used to evaluate a node test of the form
document-node(element(X)). This in practice means that it is used (a) to evaluate the
simple node tests found in the XPath 1.0 subset used in XML Schema, and (b) to evaluate
node tests where the node kind is known to be an attribute.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#matches(int, net.sf.saxon.om.NodeName, int)">matches</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeKind</CODE> - The kind of node to be matched<DD><CODE>name</CODE> - identifies the expanded name of the node to be matched.
The value should be null for a node with no name.<DD><CODE>annotation</CODE> - The actual content type of the node</DL>
</DD>
</DL>
<HR>
<A NAME="matches(net.sf.saxon.tree.tiny.TinyTree, int)"><!-- --></A><H3>
matches</H3>
<PRE>
public boolean <B>matches</B>(<A HREF="../../../../net/sf/saxon/tree/tiny/TinyTree.html" title="class in net.sf.saxon.tree.tiny">TinyTree</A> tree,
int nodeNr)</PRE>
<DL>
<DD>Test whether this node test is satisfied by a given node on a TinyTree. The node
must be a document, element, text, comment, or processing instruction node.
This method is provided so that when navigating a TinyTree a node can be rejected without
actually instantiating a NodeInfo object.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#matches(net.sf.saxon.tree.tiny.TinyTree, int)">matches</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>tree</CODE> - the TinyTree containing the node<DD><CODE>nodeNr</CODE> - the number of the node within the TinyTree
<DT><B>Returns:</B><DD>true if the node matches the NodeTest, otherwise false</DL>
</DD>
</DL>
<HR>
<A NAME="matches(net.sf.saxon.om.NodeInfo)"><!-- --></A><H3>
matches</H3>
<PRE>
public boolean <B>matches</B>(<A HREF="../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node)</PRE>
<DL>
<DD>Test whether this node test is satisfied by a given node. This alternative
method is used in the case of nodes where calculating the fingerprint is expensive,
for example DOM or JDOM nodes.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#matches(net.sf.saxon.om.NodeInfo)">matches</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node to be matched</DL>
</DD>
</DL>
<HR>
<A NAME="matches(net.sf.saxon.om.StructuredQName)"><!-- --></A><H3>
matches</H3>
<PRE>
public boolean <B>matches</B>(<A HREF="../../../../net/sf/saxon/om/StructuredQName.html" title="class in net.sf.saxon.om">StructuredQName</A> qname)</PRE>
<DL>
<DD>Test whether the NameTest matches a given QName
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/pattern/QNameTest.html#matches(net.sf.saxon.om.StructuredQName)">matches</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/pattern/QNameTest.html" title="interface in net.sf.saxon.pattern">QNameTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>qname</CODE> - the QName to be matched
<DT><B>Returns:</B><DD>true if the name matches</DL>
</DD>
</DL>
<HR>
<A NAME="getDefaultPriority()"><!-- --></A><H3>
getDefaultPriority</H3>
<PRE>
public final double <B>getDefaultPriority</B>()</PRE>
<DL>
<DD>Determine the default priority of this node test when used on its own as a Pattern
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#getDefaultPriority()">getDefaultPriority</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the default priority</DL>
</DD>
</DL>
<HR>
<A NAME="getFingerprint()"><!-- --></A><H3>
getFingerprint</H3>
<PRE>
public int <B>getFingerprint</B>()</PRE>
<DL>
<DD>Get the fingerprint required
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#getFingerprint()">getFingerprint</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getPrimitiveType()"><!-- --></A><H3>
getPrimitiveType</H3>
<PRE>
public int <B>getPrimitiveType</B>()</PRE>
<DL>
<DD>Determine the types of nodes to which this pattern applies. Used for optimisation.
For patterns that match nodes of several types, return Type.NODE
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#getPrimitiveType()">getPrimitiveType</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#getPrimitiveType()">getPrimitiveType</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the type of node matched by this pattern. e.g. Type.ELEMENT or Type.TEXT</DL>
</DD>
</DL>
<HR>
<A NAME="getSuperType(net.sf.saxon.type.TypeHierarchy)"><!-- --></A><H3>
getSuperType</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A> <B>getSuperType</B>(<A HREF="../../../../net/sf/saxon/type/TypeHierarchy.html" title="class in net.sf.saxon.type">TypeHierarchy</A> th)</PRE>
<DL>
<DD>Get the type from which this item type is derived by restriction. This
is the supertype in the XPath type heirarchy, as distinct from the Schema
base type: this means that the supertype of xs:boolean is xs:anyAtomicType,
whose supertype is item() (rather than xs:anySimpleType).
<p>
In fact the concept of "supertype" is not really well-defined, because the types
form a lattice rather than a hierarchy. The only real requirement on this function
is that it returns a type that strictly subsumes this type, ideally as narrowly
as possible.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#getSuperType(net.sf.saxon.type.TypeHierarchy)">getSuperType</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#getSuperType(net.sf.saxon.type.TypeHierarchy)">getSuperType</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>th</CODE> - the type hierarchy cache
<DT><B>Returns:</B><DD>the supertype, or null if this type is item()</DL>
</DD>
</DL>
<HR>
<A NAME="getNodeKindMask()"><!-- --></A><H3>
getNodeKindMask</H3>
<PRE>
public int <B>getNodeKindMask</B>()</PRE>
<DL>
<DD>Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination
of bits: 1<<Type.ELEMENT for element nodes, 1<<Type.TEXT for text nodes, and so on.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#getNodeKindMask()">getNodeKindMask</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a combination of bits: 1<<Type.ELEMENT for element nodes, 1<<Type.TEXT for text nodes, and so on</DL>
</DD>
</DL>
<HR>
<A NAME="getRequiredNodeNames()"><!-- --></A><H3>
getRequiredNodeNames</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/expr/sort/IntSet.html" title="interface in net.sf.saxon.expr.sort">IntSet</A> <B>getRequiredNodeNames</B>()</PRE>
<DL>
<DD>Get the set of node names allowed by this NodeTest. This is returned as a set of Integer fingerprints.
A null value indicates that all names are permitted (i.e. that there are no constraints on the node name.
The default implementation returns null.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#getRequiredNodeNames()">getRequiredNodeNames</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the set of integer fingerprints of the node names that this node test can match.</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</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>toString</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><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></CODE> in class <CODE><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></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="toString(net.sf.saxon.om.NamePool)"><!-- --></A><H3>
toString</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>toString</B>(<A HREF="../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> pool)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#toString(net.sf.saxon.om.NamePool)">NodeTest</A></CODE></B></DD>
<DD>Display the type descriptor for diagnostics
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#toString(net.sf.saxon.om.NamePool)">toString</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#toString(net.sf.saxon.om.NamePool)">toString</A></CODE> in class <CODE><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pool</CODE> - the name pool
<DT><B>Returns:</B><DD>a string representation of the type, in notation resembling but not necessarily
identical to XPath syntax</DL>
</DD>
</DL>
<HR>
<A NAME="hashCode()"><!-- --></A><H3>
hashCode</H3>
<PRE>
public int <B>hashCode</B>()</PRE>
<DL>
<DD>Returns a hash code value for the object.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><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></CODE> in class <CODE><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></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <B>equals</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> other)</PRE>
<DL>
<DD>Determines whether two NameTests are equal
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><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></CODE> in class <CODE><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></CODE></DL>
</DD>
<DD><DL>
</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/pattern/NamespaceTest.html" title="class in net.sf.saxon.pattern"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/pattern/NodeKindTest.html" title="class in net.sf.saxon.pattern"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/pattern/NameTest.html" target="_top"><B>FRAMES</B></A>
<A HREF="NameTest.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 | FIELD | <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>
