net.sf.saxon.regex
Interface RegularExpression

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

JRegularExpression

public interface RegularExpression

extends java.io.Serializable

This interface represents a compiled regular expression

Method Summary

RegexIterator	analyze(java.lang.CharSequence input) Use this regular expression to analyze an input string, in support of the XSLT analyze-string instruction.
boolean	containsMatch(java.lang.CharSequence input) Determine whether the regular expression contains a match of a given string
boolean	matches(java.lang.CharSequence input) Determine whether the regular expression match a given string in its entirety
java.lang.CharSequence	replace(java.lang.CharSequence input, java.lang.CharSequence replacement) Replace all substrings of a supplied input string that match the regular expression with a replacement string.
SequenceIterator	tokenize(java.lang.CharSequence input) Use this regular expression to tokenize an input string.

Method Detail

matches

public boolean matches(java.lang.CharSequence input)

Determine whether the regular expression match a given string in its entirety

Parameters:

input - the string to match

Returns:

true if the string matches, false otherwise

containsMatch

public boolean containsMatch(java.lang.CharSequence input)

Determine whether the regular expression contains a match of a given string

Parameters:

input - the string to match

Returns:

true if the string matches, false otherwise

tokenize

public SequenceIterator tokenize(java.lang.CharSequence input)

Use this regular expression to tokenize an input string.

Parameters:

input - the string to be tokenized

Returns:

a SequenceIterator containing the resulting tokens, as objects of type StringValue

analyze

public RegexIterator analyze(java.lang.CharSequence input)

Use this regular expression to analyze an input string, in support of the XSLT analyze-string instruction. The resulting RegexIterator provides both the matching and non-matching substrings, and allows them to be distinguished. It also provides access to matched subgroups.

replace

public java.lang.CharSequence replace(java.lang.CharSequence input,
                                      java.lang.CharSequence replacement)
                               throws XPathException

Replace all substrings of a supplied input string that match the regular expression with a replacement string.

Parameters:

input - the input string on which replacements are to be performed

replacement - the replacement string in the format of the XPath replace() function

Returns:

the result of performing the replacement

Throws:

XPathException - if the replacement string is invalid