<!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>
NodeTest
</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="NodeTest";
}
}
</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/NodeSetPattern.html" title="class in net.sf.saxon.pattern"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/pattern/Pattern.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/NodeTest.html" target="_top"><B>FRAMES</B></A>
<A HREF="NodeTest.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 NodeTest</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 "><B>net.sf.saxon.pattern.NodeTest</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/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../net/sf/saxon/pattern/AnyChildNodeTest.html" title="class in net.sf.saxon.pattern">AnyChildNodeTest</A>, <A HREF="../../../../net/sf/saxon/pattern/AnyNodeTest.html" title="class in net.sf.saxon.pattern">AnyNodeTest</A>, <A HREF="../../../../net/sf/saxon/pattern/CombinedNodeTest.html" title="class in net.sf.saxon.pattern">CombinedNodeTest</A>, <A HREF="../../../../net/sf/saxon/pattern/ContentTypeTest.html" title="class in net.sf.saxon.pattern">ContentTypeTest</A>, <A HREF="../../../../net/sf/saxon/pattern/DocumentNodeTest.html" title="class in net.sf.saxon.pattern">DocumentNodeTest</A>, <A HREF="../../../../net/sf/saxon/pattern/EmptySequenceTest.html" title="class in net.sf.saxon.pattern">EmptySequenceTest</A>, <A HREF="../../../../net/sf/saxon/pattern/LocalNameTest.html" title="class in net.sf.saxon.pattern">LocalNameTest</A>, <A HREF="../../../../net/sf/saxon/pattern/NamespaceTest.html" title="class in net.sf.saxon.pattern">NamespaceTest</A>, <A HREF="../../../../net/sf/saxon/pattern/NameTest.html" title="class in net.sf.saxon.pattern">NameTest</A>, <A HREF="../../../../net/sf/saxon/pattern/NodeKindTest.html" title="class in net.sf.saxon.pattern">NodeKindTest</A>, <A HREF="../../../../com/saxonica/validate/SchemaAttributeTest.html" title="class in com.saxonica.validate">SchemaAttributeTest</A>, <A HREF="../../../../com/saxonica/validate/SchemaElementTest.html" title="class in com.saxonica.validate">SchemaElementTest</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class <B>NodeTest</B><DT>extends <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><DT>implements <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL>
</PRE>
<P>
A NodeTest is a simple kind of pattern that enables a context-free test of whether
a node matches a given node kind and name. There are several kinds of node test: a full name test, a prefix test, and an
"any node of a given type" test, an "any node of any type" test, a "no nodes"
test (used, e.g. for "@comment()").
<p>As well as being used to support XSLT pattern matching, NodeTests act as predicates in
axis steps, and also act as item types for type matching.</p>
<p>For use in user-written application calling <A HREF="../../../../net/sf/saxon/om/NodeInfo.html#iterateAxis(byte, net.sf.saxon.pattern.NodeTest)"><CODE>NodeInfo.iterateAxis(byte, NodeTest)</CODE></A>,
it is possible to write a user-defined subclass of <code>NodeTest</code> that implements
a single method, <A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#matches(int, net.sf.saxon.om.NodeName, int)"><CODE>matches(int, NodeName, int)</CODE></A></p>
<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.NodeTest">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/NodeTest.html#NodeTest()">NodeTest</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/type/AtomicType.html" title="interface in net.sf.saxon.type">AtomicType</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#getAtomizedItemType()">getAtomizedItemType</A></B>()</CODE>
<BR>
Get the item type of the atomic values that will be produced when an item
of this type is atomized (assuming that atomization succeeds)</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/type/SchemaType.html" title="interface in net.sf.saxon.type">SchemaType</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#getContentType()">getContentType</A></B>()</CODE>
<BR>
Get the content type allowed by this NodeTest (that is, the type annotation of the matched nodes).</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/NodeTest.html#getFingerprint()">getFingerprint</A></B>()</CODE>
<BR>
Get the name of the nodes matched by this nodetest, if it matches a specific name.</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/NodeTest.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> <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/NodeTest.html#getPrimitiveItemType()">getPrimitiveItemType</A></B>()</CODE>
<BR>
Get the primitive item type corresponding to this item type.</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/NodeTest.html#getPrimitiveType()">getPrimitiveType</A></B>()</CODE>
<BR>
Get the basic kind of object that this ItemType matches: for a NodeTest, this is the kind of node,
or Type.Node if it matches different kinds of nodes.</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/NodeTest.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/NodeTest.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> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#isAtomicType()">isAtomicType</A></B>()</CODE>
<BR>
Determine whether this item type is an atomic type</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/NodeTest.html#isAtomizable()">isAtomizable</A></B>()</CODE>
<BR>
Ask whether values of this type are atomizable</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/NodeTest.html#isNillable()">isNillable</A></B>()</CODE>
<BR>
Determine whether the content type (if present) is nillable</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/NodeTest.html#isPlainType()">isPlainType</A></B>()</CODE>
<BR>
Determine whether this item type is atomic (that is, whether it can ONLY match
atomic values)</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="../../../../net/sf/saxon/pattern/NodeTest.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/NodeTest.html#matches(net.sf.saxon.om.Item, net.sf.saxon.expr.XPathContext)">matches</A></B>(<A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A> item,
<A HREF="../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE>
<BR>
Test whether a given item conforms to this type</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/NodeTest.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/NodeTest.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> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#matchesItem(net.sf.saxon.om.Item, boolean, net.sf.saxon.Configuration)">matchesItem</A></B>(<A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A> item,
boolean allowURIPromotion,
<A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</CODE>
<BR>
Test whether a given item conforms to this type.</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/NodeTest.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>
<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="../../../../net/sf/saxon/pattern/NodeTest.html#visitNamedSchemaComponents(net.sf.saxon.type.SchemaComponentVisitor)">visitNamedSchemaComponents</A></B>(<A HREF="../../../../net/sf/saxon/type/SchemaComponentVisitor.html" title="interface in net.sf.saxon.type">SchemaComponentVisitor</A> visitor)</CODE>
<BR>
Visit all the schema components used in this ItemType definition</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_net.sf.saxon.type.ItemType"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface net.sf.saxon.type.<A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#getDefaultPriority()">getDefaultPriority</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="NodeTest()"><!-- --></A><H3>
NodeTest</H3>
<PRE>
public <B>NodeTest</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="matches(net.sf.saxon.om.Item, net.sf.saxon.expr.XPathContext)"><!-- --></A><H3>
matches</H3>
<PRE>
public boolean <B>matches</B>(<A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A> item,
<A HREF="../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#matches(net.sf.saxon.om.Item, net.sf.saxon.expr.XPathContext)">ItemType</A></CODE></B></DD>
<DD>Test whether a given item conforms to this type
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#matches(net.sf.saxon.om.Item, net.sf.saxon.expr.XPathContext)">matches</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>Parameters:</B><DD><CODE>item</CODE> - The item to be tested<DD><CODE>context</CODE> - the XPath dynamic evaluation context
<DT><B>Returns:</B><DD>true if the item is an instance of this type; false otherwise</DL>
</DD>
</DL>
<HR>
<A NAME="matchesItem(net.sf.saxon.om.Item, boolean, net.sf.saxon.Configuration)"><!-- --></A><H3>
matchesItem</H3>
<PRE>
public boolean <B>matchesItem</B>(<A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A> item,
boolean allowURIPromotion,
<A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</PRE>
<DL>
<DD>Test whether a given item conforms to this type. This implements a method of the ItemType interface.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#matchesItem(net.sf.saxon.om.Item, boolean, net.sf.saxon.Configuration)">matchesItem</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>Parameters:</B><DD><CODE>item</CODE> - The item to be tested<DD><CODE>allowURIPromotion</CODE> - true of promotion of anyURI to string is permitted<DD><CODE>config</CODE> - the Saxon Configuration
<DT><B>Returns:</B><DD>true if the item is an instance of this type; false otherwise</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></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="getPrimitiveItemType()"><!-- --></A><H3>
getPrimitiveItemType</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A> <B>getPrimitiveItemType</B>()</PRE>
<DL>
<DD>Get the primitive item type corresponding to this item type. For item(),
this is Type.ITEM. For node(), it is Type.NODE. For specific node kinds,
it is the value representing the node kind, for example Type.ELEMENT.
For anyAtomicValue it is Type.ATOMIC_VALUE. For numeric it is Type.NUMBER.
For other atomic types it is the primitive type as defined in XML Schema,
except that INTEGER is considered to be a primitive type.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#getPrimitiveItemType()">getPrimitiveItemType</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 corresponding primitive type</DL>
</DD>
</DL>
<HR>
<A NAME="getPrimitiveType()"><!-- --></A><H3>
getPrimitiveType</H3>
<PRE>
public int <B>getPrimitiveType</B>()</PRE>
<DL>
<DD>Get the basic kind of object that this ItemType matches: for a NodeTest, this is the kind of node,
or Type.Node if it matches different kinds of nodes.
<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></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the node kind matched by this node test</DL>
</DD>
</DL>
<HR>
<A NAME="getFingerprint()"><!-- --></A><H3>
getFingerprint</H3>
<PRE>
public int <B>getFingerprint</B>()</PRE>
<DL>
<DD>Get the name of the nodes matched by this nodetest, if it matches a specific name.
Return -1 if the node test matches nodes of more than one name
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isAtomicType()"><!-- --></A><H3>
isAtomicType</H3>
<PRE>
public boolean <B>isAtomicType</B>()</PRE>
<DL>
<DD>Determine whether this item type is an atomic type
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#isAtomicType()">isAtomicType</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>true if this is ANY_ATOMIC_TYPE or a subtype thereof</DL>
</DD>
</DL>
<HR>
<A NAME="isPlainType()"><!-- --></A><H3>
isPlainType</H3>
<PRE>
public boolean <B>isPlainType</B>()</PRE>
<DL>
<DD>Determine whether this item type is atomic (that is, whether it can ONLY match
atomic values)
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#isPlainType()">isPlainType</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>false: this is not ANY_ATOMIC_TYPE or a subtype thereof</DL>
</DD>
</DL>
<HR>
<A NAME="getAtomizedItemType()"><!-- --></A><H3>
getAtomizedItemType</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/type/AtomicType.html" title="interface in net.sf.saxon.type">AtomicType</A> <B>getAtomizedItemType</B>()</PRE>
<DL>
<DD>Get the item type of the atomic values that will be produced when an item
of this type is atomized (assuming that atomization succeeds)
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#getAtomizedItemType()">getAtomizedItemType</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 best available item type of the atomic values that will be produced when an item
of this type is atomized</DL>
</DD>
</DL>
<HR>
<A NAME="isAtomizable()"><!-- --></A><H3>
isAtomizable</H3>
<PRE>
public boolean <B>isAtomizable</B>()</PRE>
<DL>
<DD>Ask whether values of this type are atomizable
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#isAtomizable()">isAtomizable</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>true unless it is known that these items will be elements with element-only
content, in which case return false</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. The default implementation instantiates the node
and then calls the method <A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#matches(net.sf.saxon.om.NodeInfo)"><CODE>matches(NodeInfo)</CODE></A>
<P>
<DD><DL>
</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(int, net.sf.saxon.om.NodeName, int)"><!-- --></A><H3>
matches</H3>
<PRE>
public abstract 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>
</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.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. The default implementation calls the method
<A HREF="../../../../net/sf/saxon/pattern/NodeTest.html#matches(int, net.sf.saxon.om.NodeName, int)"><CODE>matches(int, NodeName, int)</CODE></A>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node to be matched</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. The default
implementation indicates that nodes of all kinds are matched.
<P>
<DD><DL>
</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="getContentType()"><!-- --></A><H3>
getContentType</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/type/SchemaType.html" title="interface in net.sf.saxon.type">SchemaType</A> <B>getContentType</B>()</PRE>
<DL>
<DD>Get the content type allowed by this NodeTest (that is, the type annotation of the matched nodes).
Return AnyType if there are no restrictions. The default implementation returns AnyType.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the type annotation that all nodes matching this NodeTest must satisfy</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.
If all names are permitted (i.e. there are no constraints on the node name), returns IntInfiniteSet.getInstance().
The default implementation returns the universal set.
<P>
<DD><DL>
</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="isNillable()"><!-- --></A><H3>
isNillable</H3>
<PRE>
public boolean <B>isNillable</B>()</PRE>
<DL>
<DD>Determine whether the content type (if present) is nillable
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if the content test (when present) can match nodes that are nilled</DL>
</DD>
</DL>
<HR>
<A NAME="visitNamedSchemaComponents(net.sf.saxon.type.SchemaComponentVisitor)"><!-- --></A><H3>
visitNamedSchemaComponents</H3>
<PRE>
public void <B>visitNamedSchemaComponents</B>(<A HREF="../../../../net/sf/saxon/type/SchemaComponentVisitor.html" title="interface in net.sf.saxon.type">SchemaComponentVisitor</A> visitor)
throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Visit all the schema components used in this ItemType definition
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/type/ItemType.html#visitNamedSchemaComponents(net.sf.saxon.type.SchemaComponentVisitor)">visitNamedSchemaComponents</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>Parameters:</B><DD><CODE>visitor</CODE> - the visitor class to be called when each component is visited
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if an error occurs</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>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></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>
<!-- ========= 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/NodeSetPattern.html" title="class in net.sf.saxon.pattern"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/pattern/Pattern.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/NodeTest.html" target="_top"><B>FRAMES</B></A>
<A HREF="NodeTest.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>
