com.saxonica.ee.stream

Class ManualRegexIterator

java.lang.Object

net.sf.saxon.tree.iter.ManualIterator<StringValue>

com.saxonica.ee.stream.ManualRegexIterator

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LastPositionFinder, FocusIterator<StringValue>, SequenceIterator<StringValue>, RegexIterator, GroundedIterator<StringValue>, LookaheadIterator<StringValue>, ReversibleIterator<StringValue>, UnfailingIterator<StringValue>

public class ManualRegexIterator
extends ManualIterator<StringValue>
implements RegexIterator

The class ManualRegexIterator represents an iterator that is never repositioned, but can be used to represent the current regex groups in the dynamic context. It is used as a snapshot copy of a real regex iterator for use when asynchronous threads are forked, as in xsl:result-document; the purpose of taking a snapshot is to ensure that changes to the base iterator in one thread do not affect the result of the current-group() function in another thread.

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.saxon.regex.RegexIterator

RegexIterator.MatchHandler

Field Summary

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

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Constructor and Description
ManualRegexIterator(RegexIterator base)

Method Summary

Modifier and Type	Method and Description
int	getNumberOfGroups() Get the number of captured groups
java.lang.String	getRegexGroup(int number) Get a substring that matches a parenthesised group within the regular expression
boolean	isMatching() Determine whether the current item in the sequence is a matching item or a non-matching item
void	processMatchingSubstring(RegexIterator.MatchHandler action) Process a matching substring, performing specified actions at the start and end of each matching group

Methods inherited from class net.sf.saxon.tree.iter.ManualIterator

close, current, getLength, getProperties, getResidue, getReverseIterator, hasNext, incrementPosition, materialize, next, position, setContextItem, setLastPositionFinder, setPosition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

close, forEachOrFail, getProperties, materialize, next

Methods inherited from interface net.sf.saxon.tree.iter.UnfailingIterator

firstWith, forEach, toGroundedValue, toList

Constructor Detail

ManualRegexIterator

public ManualRegexIterator(RegexIterator base)

Method Detail

getNumberOfGroups

public int getNumberOfGroups()

Get the number of captured groups

Specified by:

getNumberOfGroups in interface RegexIterator

isMatching

public boolean isMatching()

Determine whether the current item in the sequence is a matching item or a non-matching item

Specified by:

isMatching in interface RegexIterator

Returns:

true if the current item is a matching item

getRegexGroup

public java.lang.String getRegexGroup(int number)

Get a substring that matches a parenthesised group within the regular expression

Specified by:

getRegexGroup in interface RegexIterator

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

processMatchingSubstring

public void processMatchingSubstring(RegexIterator.MatchHandler action)

Process a matching substring, performing specified actions at the start and end of each matching group

Specified by:

processMatchingSubstring in interface RegexIterator

Parameters:

action - the action to be performed on a matching substring