net.sf.saxon.dotnet
Class DotNetRegularExpression

java.lang.Object
  net.sf.saxon.dotnet.DotNetRegularExpression

All Implemented Interfaces:

java.io.Serializable, RegularExpression

public class DotNetRegularExpression
extends java.lang.Object
implements RegularExpression

A compiled regular expression implemented using the .NET regex package

See Also:

Serialized Form

Field Summary

Fields inherited from interface net.sf.saxon.regex.RegularExpression

NATIVE_SYNTAX, XML_SCHEMA_SYNTAX, XPATH_SYNTAX

Constructor Summary

DotNetRegularExpression(java.lang.CharSequence regex, int xmlVersion, int syntax, java.lang.CharSequence flags)
Create (compile) a 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
static boolean	isCaseBlind(java.lang.CharSequence inFlags) Test whether the 'i' flag is set.
static boolean	isIgnoreWhitespace(java.lang.CharSequence inFlags) Test whether the 'x' flag is set.
boolean	matches(java.lang.CharSequence input) Determine whether the regular expression matches (the whole of) a given string
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.
static RegexOptions	setFlags(java.lang.CharSequence inFlags) Set the Java flags from the supplied XPath flags.
SequenceIterator	tokenize(java.lang.CharSequence input) Use this regular expression to tokenize an input string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DotNetRegularExpression

public DotNetRegularExpression(java.lang.CharSequence regex,
                               int xmlVersion,
                               int syntax,
                               java.lang.CharSequence flags)
                        throws XPathException

Create (compile) a regular expression

Parameters:

regex - the source text of the regular expression, in XML Schema or XPath syntax

xmlVersion - indicates whether XML 1.0 or XML 1.1 is in use

syntax - indicates whether this is an XPath regular expression, an XML Schema regular expression, or a regex in .NET native regex syntax

flags - the flags argument as supplied to functions such as fn:matches(), in string form

Throws:

XPathException - if the syntax of the regular expression or flags is incorrect

Method Detail

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.

Specified by:

analyze in interface RegularExpression

Parameters:

input - the character string to be analyzed using the regular expression

Returns:

an iterator over matched and unmatched substrings

containsMatch

public boolean containsMatch(java.lang.CharSequence input)

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

Specified by:

containsMatch in interface RegularExpression

Parameters:

input - the string to match

Returns:

true if the string matches, false otherwise

matches

public boolean matches(java.lang.CharSequence input)

Determine whether the regular expression matches (the whole of) a given string

Specified by:

matches in interface RegularExpression

Parameters:

input - the string to match

Returns:

true if the regular expression matches the whole input string, false otherwise

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.

Specified by:

replace in interface RegularExpression

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(java.lang.CharSequence input)

Use this regular expression to tokenize an input string.

Specified by:

tokenize in interface RegularExpression

Parameters:

input - the string to be tokenized

Returns:

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

setFlags

public static RegexOptions setFlags(java.lang.CharSequence inFlags)
                             throws XPathException

Set the Java flags from the supplied XPath flags.

Parameters:

inFlags - the flags as a string, e.g. "im"

Returns:

the flags as a RegexOptions FlagsAttribute

Throws:

XPathException - if the supplied value is invalid

isIgnoreWhitespace

public static boolean isIgnoreWhitespace(java.lang.CharSequence inFlags)

Test whether the 'x' flag is set.

Parameters:

inFlags - the flags as a string, e.g. "im"

Returns:

true if the 'x' flag is set

isCaseBlind

public static boolean isCaseBlind(java.lang.CharSequence inFlags)

Test whether the 'i' flag is set.

Parameters:

inFlags - the flags as a string, e.g. "im"

Returns:

true if the 'i' flag is set