<!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:51 GMT 2011 -->
<TITLE>
net.sf.saxon.pattern
</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="net.sf.saxon.pattern";
}
}
</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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/option/xom/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../net/sf/saxon/pull/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/pattern/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.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>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package net.sf.saxon.pattern
</H2>
This package provides classes associated with XSLT pattern handling.
<P>
<B>See:</B>
<BR>
<A HREF="#package_description"><B>Description</B></A>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/PatternFinder.html" title="interface in net.sf.saxon.pattern">PatternFinder</A></B></TD>
<TD>This interface enables a client to find all nodes in a document that match a particular pattern.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/QNameTest.html" title="interface in net.sf.saxon.pattern">QNameTest</A></B></TD>
<TD>Interface for tests against a QName.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/SchemaNodeTest.html" title="interface in net.sf.saxon.pattern">SchemaNodeTest</A></B></TD>
<TD>Marker interface for schema-element() and schema-attribute() node tests</TD>
</TR>
</TABLE>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/AnchorPattern.html" title="class in net.sf.saxon.pattern">AnchorPattern</A></B></TD>
<TD>This is a special pattern that matches the "anchor node"; it is not used for XSLT patterns,
but for the selectors that arise when evaluating XPath expressions in streaming mode; the anchor
node is the context node for the streamed XPath evaluation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/AnyChildNodeTest.html" title="class in net.sf.saxon.pattern">AnyChildNodeTest</A></B></TD>
<TD>An AnyChildNodePattern is the pattern node(), which matches any node except a root node,
an attribute node, or a namespace node: in other words, any node that is the child of another
node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/AnyNodeTest.html" title="class in net.sf.saxon.pattern">AnyNodeTest</A></B></TD>
<TD>NodeTest is an interface that enables a test of whether a node has a particular
name and type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/CombinedNodeTest.html" title="class in net.sf.saxon.pattern">CombinedNodeTest</A></B></TD>
<TD>A CombinedNodeTest combines two nodetests using one of the operators
union (=or), intersect (=and), difference (= "and not").</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/ConditionalPattern.html" title="class in net.sf.saxon.pattern">ConditionalPattern</A></B></TD>
<TD>A ConditionalPattern tests a node against one of a number of patterns depending on the value of a condition.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/ContentTypeTest.html" title="class in net.sf.saxon.pattern">ContentTypeTest</A></B></TD>
<TD>NodeTest is an interface that enables a test of whether a node matches particular
conditions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/DocumentNodeTest.html" title="class in net.sf.saxon.pattern">DocumentNodeTest</A></B></TD>
<TD>A DocumentNodeTest implements the test document-node(element(~,~))</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/EmptySequenceTest.html" title="class in net.sf.saxon.pattern">EmptySequenceTest</A></B></TD>
<TD>NodeTest is an interface that enables a test of whether a node has a particular
name and type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/ExceptPattern.html" title="class in net.sf.saxon.pattern">ExceptPattern</A></B></TD>
<TD>A pattern formed as the difference of two other patterns</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/IdrefTest.html" title="class in net.sf.saxon.pattern">IdrefTest</A></B></TD>
<TD>IdrefTest is a test that cannot be represented directly in XPath or
XSLT patterns, but which is used internally for matching IDREF nodes: it tests
whether the node has the is-idref property</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/IntersectPattern.html" title="class in net.sf.saxon.pattern">IntersectPattern</A></B></TD>
<TD>A pattern formed as the difference of two other patterns</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/ItemTypePattern.html" title="class in net.sf.saxon.pattern">ItemTypePattern</A></B></TD>
<TD>A ItemTypePattern is a pattern that consists simply of an ItemType.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/LocalNameTest.html" title="class in net.sf.saxon.pattern">LocalNameTest</A></B></TD>
<TD>NodeTest is an interface that enables a test of whether a node has a particular
name and type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/LocationPathPattern.html" title="class in net.sf.saxon.pattern">LocationPathPattern</A></B></TD>
<TD>A LocationPathPattern represents a path, for example of the form A/B/C...</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/NamespaceTest.html" title="class in net.sf.saxon.pattern">NamespaceTest</A></B></TD>
<TD>NodeTest is an interface that enables a test of whether a node has a particular
name and type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/NameTest.html" title="class in net.sf.saxon.pattern">NameTest</A></B></TD>
<TD>NodeTest is an interface that enables a test of whether a node has a particular
name and type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/NodeKindTest.html" title="class in net.sf.saxon.pattern">NodeKindTest</A></B></TD>
<TD>NodeTest is an interface that enables a test of whether a node has a particular
name and kind.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/NodeSetPattern.html" title="class in net.sf.saxon.pattern">NodeSetPattern</A></B></TD>
<TD>A NodeSetPattern is a pattern based on an expression that is evaluated to return a set of nodes;
a node matches the pattern if it is a member of this node-set.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A></B></TD>
<TD>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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A></B></TD>
<TD>A Pattern represents the result of parsing an XSLT pattern string.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/PatternMaker.html" title="class in net.sf.saxon.pattern">PatternMaker</A></B></TD>
<TD>This is a singleton class used to convert an expression to an equivalent pattern.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/PatternParser.html" title="class in net.sf.saxon.pattern">PatternParser</A></B></TD>
<TD>Parser for XSLT patterns.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/PatternSponsor.html" title="class in net.sf.saxon.pattern">PatternSponsor</A></B></TD>
<TD>The PatternSponsor class allows a Pattern to be treated like an expression.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/PatternWithPredicate.html" title="class in net.sf.saxon.pattern">PatternWithPredicate</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/UnionPattern.html" title="class in net.sf.saxon.pattern">UnionPattern</A></B></TD>
<TD>A pattern formed as the union (or) of two other patterns</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/UnionQNameTest.html" title="class in net.sf.saxon.pattern">UnionQNameTest</A></B></TD>
<TD>A QNameTest that is the union of a number of supplied QNameTests</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/pattern/VennPattern.html" title="class in net.sf.saxon.pattern">VennPattern</A></B></TD>
<TD>A pattern formed as the union, intersection, or difference of two other patterns</TD>
</TR>
</TABLE>
<P>
<A NAME="package_description"><!-- --></A><H2>
Package net.sf.saxon.pattern Description
</H2>
<P>
<p>This package provides classes associated with XSLT pattern handling. </p>
<p>The principal classes are:</p>
<p><b>Pattern</b>:<br>
This represents an XSLT Pattern. There is a static method Pattern.make() which is
used to construct a Pattern from a String (it is a factory method rather than a
constructor, because it typically returns some subclass of Pattern according
to the syntax supplied). Subclasses of Pattern represent different kinds of pattern
such as LocationPathPattern and IDKeyPattern. What they all have in common is a match()
method, which determines whether a given node matches the pattern. A pattern is
not in itself an Expression, but the class <code>PatternSponsor</code> is used
to wrap a pattern making it look like an expression for the benefit of the static analysis
(allowing the same mechanisms to be used for example to find all the references to a variable).</p>
<p><b>NodeTest</b>:<br>
This represents a NodeTest within a step of an XPath expression. A NodeTest performs several
roles: as well as its use in conjuction with an axis to form a step of a path expression,
it acts as an ItemType used in handling type checking of nodes, and (wrapped in a NodeTestPattern)
it acts as an XSLT pattern for use in constructs such as the <code>match</code> attribute of
<code>xsl:template</code> and <code>xsl:key</code>.
A NodeTest is used directly to implement simple patterns such as <code>match="item"</code>
or <code>match="*"</code>. There are several subclasses of NodeTest, depending on the conditions
to be matched: node type, node name, namespace URI, and so on. The class AnyNodeTest matches any node,
while NoNodeTest matches nothing. NodeTests can also be combined using the operators of intersection,
difference, and union, to describe the more complex types that are sometimes computed by the type
checking machinery.</p>
<hr>
<p align="center"><i>Michael H. Kay<br/>
Saxonica Limited<br/>
9 February 2005</i></p>
<P>
<P>
<DL>
</DL>
<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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/option/xom/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../net/sf/saxon/pull/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/pattern/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.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>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
