net.sf.saxon.regex

Interface RegularExpression

All Superinterfaces:
Serializable
Known Implementing Classes:
DotNetRegularExpression, JRegularExpression

public interface RegularExpression
extends Serializable

This interface represents a compiled regular expression

Field Summary

static int
NATIVE_SYNTAX
Constant indicating the regular expression syntax is the native syntax for the platform (Java or .NET)
static int
XML_SCHEMA_SYNTAX
Constant indication the regular expression language is XML Schema Part 2
static int
XPATH_SYNTAX
Constant indicating the regular expression language is XPath 2.0

Method Summary

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

Field Details

NATIVE_SYNTAX

public static final int NATIVE_SYNTAX
Constant indicating the regular expression syntax is the native syntax for the platform (Java or .NET)
Field Value:
2

XML_SCHEMA_SYNTAX

public static final int XML_SCHEMA_SYNTAX
Constant indication the regular expression language is XML Schema Part 2
Field Value:
1

XPATH_SYNTAX

public static final int XPATH_SYNTAX
Constant indicating the regular expression language is XPath 2.0
Field Value:
0

Method Details

analyze

public RegexIterator analyze(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.
Parameters:
input - the character string to be analyzed using the regular expression
Returns:
an iterator over matched and unmatched substrings

containsMatch

public boolean containsMatch(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

matches

public boolean matches(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

replace

public CharSequence replace(CharSequence input,
                            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

tokenize

public SequenceIterator tokenize(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