net.sf.saxon.regex

Interface RegexIterator

All Superinterfaces:
SequenceIterator
Known Implementing Classes:
DotNetRegexIterator, JRegexIterator

public interface RegexIterator
extends SequenceIterator

This class is an interator that supports the evaluation of xsl:analyze-string. It returns all the matching and non-matching substrings in an input string, and provides access to their captured groups

Fields inherited from interface net.sf.saxon.om.SequenceIterator

GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Method Summary

String
getRegexGroup(int number)
Get a substring that matches a parenthesised group within the regular expression
SequenceIterator
getRegexGroupIterator()
Get a sequence containing all the regex captured groups relating to the current matching item (except group 0, because we want to use indexing from 1).
boolean
isMatching()
Determine whether the current item in the sequence is a matching item or a non-matching item

Methods inherited from interface net.sf.saxon.om.SequenceIterator

current, getAnother, getProperties, next, position

Method Details

getRegexGroup

public String getRegexGroup(int number)
Get a substring that matches a parenthesised group within the regular expression
Parameters:
number - the number of the group to be obtained
Returns:
the substring of the current item that matches the n'th parenthesized group within the regular expression

getRegexGroupIterator

public SequenceIterator getRegexGroupIterator()
Get a sequence containing all the regex captured groups relating to the current matching item (except group 0, because we want to use indexing from 1). This is used by the saxon:analyze-string() higher-order extension function.

isMatching

public boolean isMatching()
Determine whether the current item in the sequence is a matching item or a non-matching item
Returns:
true if the current item is a matching item