Class JRegexIterator

java.lang.Object
net.sf.saxon.regex.JRegexIterator
All Implemented Interfaces:
SequenceIterator, RegexIterator

public class JRegexIterator extends Object implements RegexIterator
Class JRegexIterator - provides an iterator over matched and unmatched substrings. This implementation of RegexIterator uses the JDK regular expression engine.
  • Constructor Details

    • JRegexIterator

      public JRegexIterator(String string, Pattern pattern)
      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 analysed
      pattern - the regular expression
  • Method Details

    • next

      public Item next()
      Get the next item in the sequence
      Specified by:
      next in interface SequenceIterator
      Returns:
      the next item in the sequence
    • current

      public Item current()
      Get the current item in the sequence
      Specified by:
      current in interface SequenceIterator
      Returns:
      the item most recently returned by next()
    • position

      public int position()
      Get the position of the current item in the sequence
      Specified by:
      position in interface SequenceIterator
      Returns:
      the position of the item most recently returned by next(), starting at 1
    • getAnother

      public SequenceIterator getAnother()
      Get another iterator over the same items
      Specified by:
      getAnother in interface SequenceIterator
      Returns:
      a new iterator, positioned before the first item
    • getProperties

      public int getProperties()
      Get properties of this iterator, as a bit-significant integer.
      Specified by:
      getProperties in interface SequenceIterator
      Returns:
      the properties of this iterator. This will be some combination of properties such as SequenceIterator.GROUNDED, SequenceIterator.LAST_POSITION_FINDER, and SequenceIterator.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 interface RegexIterator
      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

      public 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
    • getRegexGroupIterator

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