Sophie

Sophie

distrib > Mageia > 7 > i586 > by-pkgid > b3bdfe6d859a3d6920ff2c44b38e9a6f > files > 1398

saxon-manual-9.4.0.9-2.mga7.noarch.rpm

<!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:47:55 GMT 2011 -->
<TITLE>
Watch
</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="Watch";
    }
}
</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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../com/saxonica/stream/watch/VoidWatchMaker.html" title="class in com.saxonica.stream.watch"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/saxonica/stream/watch/WatchMaker.html" title="interface in com.saxonica.stream.watch"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?com/saxonica/stream/watch/Watch.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Watch.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.saxonica.stream.watch</FONT>
<BR>
Interface Watch</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/saxonica/validate/AbstractWatch.html" title="class in com.saxonica.validate">AbstractWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/ApplyImportsWatch.html" title="class in com.saxonica.stream.watch">ApplyImportsWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/ApplyTemplatesWatch.html" title="class in com.saxonica.stream.watch">ApplyTemplatesWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/ComposingWatch.html" title="class in com.saxonica.stream.watch">ComposingWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/CopyOfWatch.html" title="class in com.saxonica.stream.watch">CopyOfWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/CountWatch.html" title="class in com.saxonica.stream.watch">CountWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/EmptyWatch.html" title="class in com.saxonica.stream.watch">EmptyWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/EventPushingWatch.html" title="class in com.saxonica.stream.watch">EventPushingWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/ExistsWatch.html" title="class in com.saxonica.stream.watch">ExistsWatch</A>, <A HREF="../../../../com/saxonica/validate/FieldWatch.html" title="class in com.saxonica.validate">FieldWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/ForEachComposingWatch.html" title="class in com.saxonica.stream.watch">ForEachComposingWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/ForEachWatch.html" title="class in com.saxonica.stream.watch">ForEachWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/IterateWatch.html" title="class in com.saxonica.stream.watch">IterateWatch</A>, <A HREF="../../../../com/saxonica/validate/KeySelectorWatch.html" title="class in com.saxonica.validate">KeySelectorWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/NextMatchWatch.html" title="class in com.saxonica.stream.watch">NextMatchWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/NonstreamingExpressionWatch.html" title="class in com.saxonica.stream.watch">NonstreamingExpressionWatch</A>, <A HREF="../../../../com/saxonica/validate/RefSelectorWatch.html" title="class in com.saxonica.validate">RefSelectorWatch</A>, <A HREF="../../../../com/saxonica/validate/SelectorWatch.html" title="class in com.saxonica.validate">SelectorWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/SimpleContentWatch.html" title="class in com.saxonica.stream.watch">SimpleContentWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/StringValueWatch.html" title="class in com.saxonica.stream.watch">StringValueWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/TypedValueWatch.html" title="class in com.saxonica.stream.watch">TypedValueWatch</A>, <A HREF="../../../../com/saxonica/stream/watch/VoidWatch.html" title="class in com.saxonica.stream.watch">VoidWatch</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>Watch</B></DL>
</PRE>

<P>
A Watch represents a class that is interested in looking at nodes passing down a push
 pipeline. Originally this was for the purpose of evaluating uniqueness and key constraints while
 validating an instance document against a schema; now it us used for many expressions that need
 to be evaluated in streaming mode.
 <p/>
 The nodes that the Watch is interested in are identified by a Selection object.
<P>

<P>
<HR>

<P>

<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/watch/Watch.html#close()">close</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The close() method is called immediately before the Watch is destroyed, that is,
 when the element whose declaration scopes the constraint implemented by this
 Watch goes out of scope.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/watch/Watch.html#endSelectedParentNode(int)">endSelectedParentNode</A></B>(int&nbsp;locationId)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signal that the endElement event has occurred for the element whose startElement
 event caused the Watch to be activated.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/saxonica/stream/om/FleetingNode.html" title="class in com.saxonica.stream.om">FleetingNode</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/watch/Watch.html#getAnchorNode()">getAnchorNode</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the anchor node for the watch.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../net/sf/saxon/om/NamespaceResolver.html" title="interface in net.sf.saxon.om">NamespaceResolver</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/watch/Watch.html#getNamespaceResolver()">getNamespaceResolver</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the namespace resolver in use by the Watch</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../net/sf/saxon/event/PipelineConfiguration.html" title="class in net.sf.saxon.event">PipelineConfiguration</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/watch/Watch.html#getPipelineConfiguration()">getPipelineConfiguration</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the pipeline configuration in use</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/watch/Watch.html#getSelection()">getSelection</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the selection (that is, the restricted XPath expression) that defines
 the nodes that this Watch is looking for</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/watch/Watch.html#notifySelectedLeafNode(com.saxonica.stream.om.FleetingNode, int)">notifySelectedLeafNode</A></B>(<A HREF="../../../../com/saxonica/stream/om/FleetingNode.html" title="class in com.saxonica.stream.om">FleetingNode</A>&nbsp;node,
                       int&nbsp;locationId)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signal that a node (other than a document or element node) that matches the selection
 has been found.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/watch/Watch.html#open()">open</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Open the watch.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/watch/Watch.html#setAnchorNode(com.saxonica.stream.om.FleetingNode)">setAnchorNode</A></B>(<A HREF="../../../../com/saxonica/stream/om/FleetingNode.html" title="class in com.saxonica.stream.om">FleetingNode</A>&nbsp;anchor)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the anchor node for the watch.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/watch/Watch.html#setNamespaceResolver(net.sf.saxon.om.NamespaceResolver)">setNamespaceResolver</A></B>(<A HREF="../../../../net/sf/saxon/om/NamespaceResolver.html" title="interface in net.sf.saxon.om">NamespaceResolver</A>&nbsp;resolver)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a NamespaceResolver for use by the Watch</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/watch/Watch.html#setPipelineConfiguration(net.sf.saxon.event.PipelineConfiguration)">setPipelineConfiguration</A></B>(<A HREF="../../../../net/sf/saxon/event/PipelineConfiguration.html" title="class in net.sf.saxon.event">PipelineConfiguration</A>&nbsp;pipe)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the pipeline configuration in use</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/watch/Watch.html#setSelection(net.sf.saxon.pattern.Pattern)">setSelection</A></B>(<A HREF="../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A>&nbsp;selection)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the selection (that is, the streamable XPath expression) that defines
 the nodes that this Watch is looking for</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../net/sf/saxon/event/Receiver.html" title="interface in net.sf.saxon.event">Receiver</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/saxonica/stream/watch/Watch.html#startSelectedParentNode(com.saxonica.stream.om.FleetingNode, int)">startSelectedParentNode</A></B>(<A HREF="../../../../com/saxonica/stream/om/FleetingNode.html" title="class in com.saxonica.stream.om">FleetingNode</A>&nbsp;node,
                        int&nbsp;locationId)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Signal that an element or document node has been found that matches the selection that this
 Watch is looking for.</TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ 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="setSelection(net.sf.saxon.pattern.Pattern)"><!-- --></A><H3>
setSelection</H3>
<PRE>
void <B>setSelection</B>(<A HREF="../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A>&nbsp;selection)</PRE>
<DL>
<DD>Set the selection (that is, the streamable XPath expression) that defines
 the nodes that this Watch is looking for
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>selection</CODE> - the streamable XPath expression</DL>
</DD>
</DL>
<HR>

<A NAME="getSelection()"><!-- --></A><H3>
getSelection</H3>
<PRE>
<A HREF="../../../../net/sf/saxon/pattern/Pattern.html" title="class in net.sf.saxon.pattern">Pattern</A> <B>getSelection</B>()</PRE>
<DL>
<DD>Get the selection (that is, the restricted XPath expression) that defines
 the nodes that this Watch is looking for
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the selection</DL>
</DD>
</DL>
<HR>

<A NAME="setPipelineConfiguration(net.sf.saxon.event.PipelineConfiguration)"><!-- --></A><H3>
setPipelineConfiguration</H3>
<PRE>
void <B>setPipelineConfiguration</B>(<A HREF="../../../../net/sf/saxon/event/PipelineConfiguration.html" title="class in net.sf.saxon.event">PipelineConfiguration</A>&nbsp;pipe)</PRE>
<DL>
<DD>Set the pipeline configuration in use
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pipe</CODE> - the pipeline Configuration in use</DL>
</DD>
</DL>
<HR>

<A NAME="getPipelineConfiguration()"><!-- --></A><H3>
getPipelineConfiguration</H3>
<PRE>
<A HREF="../../../../net/sf/saxon/event/PipelineConfiguration.html" title="class in net.sf.saxon.event">PipelineConfiguration</A> <B>getPipelineConfiguration</B>()</PRE>
<DL>
<DD>Get the pipeline configuration in use
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the pipeline configuration</DL>
</DD>
</DL>
<HR>

<A NAME="setNamespaceResolver(net.sf.saxon.om.NamespaceResolver)"><!-- --></A><H3>
setNamespaceResolver</H3>
<PRE>
void <B>setNamespaceResolver</B>(<A HREF="../../../../net/sf/saxon/om/NamespaceResolver.html" title="interface in net.sf.saxon.om">NamespaceResolver</A>&nbsp;resolver)</PRE>
<DL>
<DD>Set a NamespaceResolver for use by the Watch
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resolver</CODE> - the namespace resolver to be used</DL>
</DD>
</DL>
<HR>

<A NAME="getNamespaceResolver()"><!-- --></A><H3>
getNamespaceResolver</H3>
<PRE>
<A HREF="../../../../net/sf/saxon/om/NamespaceResolver.html" title="interface in net.sf.saxon.om">NamespaceResolver</A> <B>getNamespaceResolver</B>()</PRE>
<DL>
<DD>Get the namespace resolver in use by the Watch
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the namespace resolver</DL>
</DD>
</DL>
<HR>

<A NAME="setAnchorNode(com.saxonica.stream.om.FleetingNode)"><!-- --></A><H3>
setAnchorNode</H3>
<PRE>
void <B>setAnchorNode</B>(<A HREF="../../../../com/saxonica/stream/om/FleetingNode.html" title="class in com.saxonica.stream.om">FleetingNode</A>&nbsp;anchor)</PRE>
<DL>
<DD>Set the anchor node for the watch. This is the node to which the watch is scoped, typically the
 context node for the streamable path expression that defines the root of the subtree within which nodes
 are being sought.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>anchor</CODE> - The anchor node within which the watch is scoped</DL>
</DD>
</DL>
<HR>

<A NAME="getAnchorNode()"><!-- --></A><H3>
getAnchorNode</H3>
<PRE>
<A HREF="../../../../com/saxonica/stream/om/FleetingNode.html" title="class in com.saxonica.stream.om">FleetingNode</A> <B>getAnchorNode</B>()</PRE>
<DL>
<DD>Get the anchor node for the watch. This is the node to which the watch is scoped, typically the
 context node for the streamable path expression that defines the root of the subtree within which nodes
 are being sought.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The anchor node within which the watch is scoped</DL>
</DD>
</DL>
<HR>

<A NAME="open()"><!-- --></A><H3>
open</H3>
<PRE>
void <B>open</B>()
          throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Open the watch. This is done at the point where it first starts watching for nodes
 that match the selection.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="startSelectedParentNode(com.saxonica.stream.om.FleetingNode, int)"><!-- --></A><H3>
startSelectedParentNode</H3>
<PRE>
<A HREF="../../../../net/sf/saxon/event/Receiver.html" title="interface in net.sf.saxon.event">Receiver</A> <B>startSelectedParentNode</B>(<A HREF="../../../../com/saxonica/stream/om/FleetingNode.html" title="class in com.saxonica.stream.om">FleetingNode</A>&nbsp;node,
                                 int&nbsp;locationId)
                                 throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Signal that an element or document node has been found that matches the selection that this
 Watch is looking for. This method is called by the WatchManager while
 processing the startElement or startDocument event that matches the selection.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the element or document node whose start event has been matched<DD><CODE>locationId</CODE> - the location associated with the element or document node (may be
 the location of the instruction that created it)
<DT><B>Returns:</B><DD>a Receiver to be notified of all events starting with the startElement/startDocument event
 for the matched element, and ending with the endElement event for that element.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/type/ValidationException.html" title="class in net.sf.saxon.type">ValidationException</A></CODE> - May be raised if the constraint implemented by this
 Watch is violated
<DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="endSelectedParentNode(int)"><!-- --></A><H3>
endSelectedParentNode</H3>
<PRE>
void <B>endSelectedParentNode</B>(int&nbsp;locationId)
                           throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Signal that the endElement event has occurred for the element whose startElement
 event caused the Watch to be activated.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locationId</CODE> - the location of the element
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - May be raised if a constraint implemented by this
 Watch is violated</DL>
</DD>
</DL>
<HR>

<A NAME="notifySelectedLeafNode(com.saxonica.stream.om.FleetingNode, int)"><!-- --></A><H3>
notifySelectedLeafNode</H3>
<PRE>
void <B>notifySelectedLeafNode</B>(<A HREF="../../../../com/saxonica/stream/om/FleetingNode.html" title="class in com.saxonica.stream.om">FleetingNode</A>&nbsp;node,
                            int&nbsp;locationId)
                            throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Signal that a node (other than a document or element node) that matches the selection
 has been found.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node that was matched.<DD><CODE>locationId</CODE> - 
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
void <B>close</B>()
           throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>The close() method is called immediately before the Watch is destroyed, that is,
 when the element whose declaration scopes the constraint implemented by this
 Watch goes out of scope.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../com/saxonica/stream/watch/VoidWatchMaker.html" title="class in com.saxonica.stream.watch"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/saxonica/stream/watch/WatchMaker.html" title="interface in com.saxonica.stream.watch"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?com/saxonica/stream/watch/Watch.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Watch.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>