Class JRegexIterator

  • All Implemented Interfaces:
    SequenceIterator, RegexIterator

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

      Constructors 
      Constructor Description
      JRegexIterator​(java.lang.String string, java.util.regex.Pattern pattern)
      Construct a RegexIterator.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Item current()
      Get the current item in the sequence
      SequenceIterator getAnother()
      Get another iterator over the same items
      int getProperties()
      Get properties of this iterator, as a bit-significant integer.
      java.lang.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 groups (except group 0, because we want to use indexing from 1).
      boolean isMatching()
      Determine whether the current item is a matching item or a non-matching item
      Item next()
      Get the next item in the sequence
      int position()
      Get the position of the current item in the sequence
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • JRegexIterator

        public JRegexIterator​(java.lang.String string,
                              java.util.regex.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 Detail

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