net.sf.saxon.pattern
Interface PatternFinder

All Superinterfaces:
Serializable
All Known Implementing Classes:
IDPattern, IdrefTest, KeyPattern, LocationPathPattern, NodeTestPattern, PathFinder, Pattern, UnionPattern

public interface PatternFinder
extends Serializable

This interface enables a client to find all nodes in a document that match a particular pattern. In fact, it allows any subset of nodes in a document to be located. It is used specifically by the internal implementation of keys. In XSLT, the criterion for including nodes in a key is that they match an XSLT pattern. Internally, however, keys are used for a wider range of purposes, and the nodes indexed by the key are defined by a PatternFinder


Method Summary
 SequenceIterator selectNodes(DocumentInfo doc, XPathContext context)
          Select nodes in a document using this PatternFinder.
 

Method Detail

selectNodes

SequenceIterator selectNodes(DocumentInfo doc,
                             XPathContext context)
                             throws XPathException
Select nodes in a document using this PatternFinder.

Parameters:
doc - the document node at the root of a tree
context - the dynamic evaluation context
Returns:
an iterator over the selected nodes in the document.
Throws:
XPathException


Copyright (C) Michael H. Kay. All rights reserved.