Package net.sf.saxon.regex
Class ARegexIterator
java.lang.Object
net.sf.saxon.regex.ARegexIterator
- All Implemented Interfaces:
Closeable
,AutoCloseable
,LastPositionFinder
,SequenceIterator
,RegexIterator
Class ARegexIterator - provides an iterator over matched and unmatched substrings.
This implementation of RegexIterator uses the modified Jakarta regular expression engine.
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.sf.saxon.regex.RegexIterator
RegexIterator.MatchHandler
Nested classes/interfaces inherited from interface net.sf.saxon.om.SequenceIterator
SequenceIterator.Property
-
Constructor Summary
ConstructorsConstructorDescriptionARegexIterator
(UnicodeString string, UnicodeString regex, REMatcher matcher) Construct a RegexIterator. -
Method Summary
Modifier and TypeMethodDescriptionstatic IntToIntHashMap
computeNestingTable
(UnicodeString regex) Compute a table showing for each captured group number (opening paren in the regex), the number of its parent group.int
Get the last position (that is, the number of items in the sequence).int
Get the number of captured groupsGet properties of this iterator, as a bit-significant integer.getRegexGroup
(int number) Get a substring that matches a parenthesised group within the regular expressionboolean
Determine whether the current item is a matching item or a non-matching itemnext()
Get the next item in the sequencevoid
Process a matching substring, performing specified actions at the start and end of each captured subgroup.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, materialize
-
Constructor Details
-
ARegexIterator
Construct a RegexIterator. Note that the underlying matcher.find() method is called once to obtain each matching substring. But the iterator also returns non-matching substrings if these appear between the matching substrings.- Parameters:
string
- the string to be analysedmatcher
- a matcher for the regular expression
-
-
Method Details
-
getLength
Description copied from interface:LastPositionFinder
Get the last position (that is, the number of items in the sequence). This method is non-destructive: it does not change the state of the iterator. The result is undefined if the next() method of the iterator has already returned null. This method must not be called unless the result of getProperties() on the iterator includes the bit settingSequenceIterator.Property.LAST_POSITION_FINDER
- Specified by:
getLength
in interfaceLastPositionFinder
- Returns:
- the number of items in the sequence
- Throws:
XPathException
- if an error occurs evaluating the sequence in order to determine the number of items
-
next
Get the next item in the sequence- Specified by:
next
in interfaceRegexIterator
- Specified by:
next
in interfaceSequenceIterator
- Returns:
- the next item in the sequence
- Throws:
XPathException
- if an error occurs retrieving the next item
-
getProperties
Get properties of this iterator, as a bit-significant integer.- Specified by:
getProperties
in interfaceSequenceIterator
- Returns:
- the properties of this iterator. This will be some combination of
properties such as
SequenceIterator.Property.GROUNDED
,SequenceIterator.Property.LAST_POSITION_FINDER
, andSequenceIterator.Property.LOOKAHEAD
. It is always acceptable to return the value zero, indicating that there are no known special properties. It is acceptable for the properties of the iterator to change depending on its state.
-
isMatching
public boolean isMatching()Determine whether the current item is a matching item or a non-matching item- Specified by:
isMatching
in interfaceRegexIterator
- Returns:
- true if the current item (the one most recently returned by next()) is an item that matches the regular expression, or false if it is an item that does not match
-
getRegexGroup
Get a substring that matches a parenthesised group within the regular expression- Specified by:
getRegexGroup
in interfaceRegexIterator
- 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
-
getNumberOfGroups
public int getNumberOfGroups()Get the number of captured groups- Specified by:
getNumberOfGroups
in interfaceRegexIterator
-
processMatchingSubstring
Process a matching substring, performing specified actions at the start and end of each captured subgroup. This method will always be called when operating in "push" mode; it writes its result to context.getReceiver(). The matching substring text is all written to the receiver, interspersed with calls to theRegexIterator.MatchHandler
methods onGroupStart() and onGroupEnd().- Specified by:
processMatchingSubstring
in interfaceRegexIterator
- Parameters:
action
- defines the processing to be performed at the start and end of a group- Throws:
XPathException
-
computeNestingTable
Compute a table showing for each captured group number (opening paren in the regex), the number of its parent group. This is done by reparsing the source of the regular expression. This is needed when the result of a match includes an empty group, to determine its position relative to other groups finishing at the same character position.
-