net.sf.saxon.functions

Class RegexFunction

java.lang.Object

net.sf.saxon.om.AbstractItem

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.RegexFunction

All Implemented Interfaces:

PullEvent, Callable, Function, GroundedValue, Item, Sequence

Direct Known Subclasses:

AnalyzeStringFn, Matches, Replace, Tokenize_3

public abstract class RegexFunction
extends SystemFunction

This class implements any of the functions matches(), replace(), tokenize(), analyze-string(), in the version where a flags argument is present in the argument list

Constructor Summary

Constructors

Constructor and Description
RegexFunction()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract boolean	allowRegexMatchingEmptyString()
protected RegularExpression	getRegularExpression(Sequence[] args) Get the regular expression at evaluation time
RegularExpression	getStaticRegex()
Expression	makeFunctionCall(Expression... arguments) Make an expression that either calls this function, or that is equivalent to a call on this function

Methods inherited from class net.sf.saxon.functions.SystemFunction

equals, export, exportAttributes, getArity, getCardinality, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getExpressionCompiler, getFunctionItemType, getFunctionName, getIntegerBounds, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, getStreamingAdjunct, importAttributes, makeCall, makeFunction, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, typeCheckCaller

Methods inherited from class net.sf.saxon.functions.AbstractFunction

atomize, deepEquals, effectiveBooleanValue, getStringValue, getStringValueCS, isArray, isMap, optimize, simplify, typeCheck

Methods inherited from class net.sf.saxon.om.AbstractItem

getLength, head, itemAt, iterate, reduce, subsequence

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.om.Function

call, iterate

Methods inherited from interface net.sf.saxon.om.Item

head

Methods inherited from interface net.sf.saxon.om.GroundedValue

getLength, head, itemAt, reduce, subsequence

Constructor Detail

RegexFunction

public RegexFunction()

Method Detail

getStaticRegex

public RegularExpression getStaticRegex()

allowRegexMatchingEmptyString

protected abstract boolean allowRegexMatchingEmptyString()

makeFunctionCall

public Expression makeFunctionCall(Expression... arguments)

Make an expression that either calls this function, or that is equivalent to a call on this function

Overrides:

makeFunctionCall in class SystemFunction

Parameters:

arguments - the supplied arguments to the function call

Returns:

either a function call on this function, or an expression that delivers the same result

getRegularExpression

protected RegularExpression getRegularExpression(Sequence[] args)
                                          throws XPathException

Get the regular expression at evaluation time

Parameters:

args - the argument values in the function call

Returns:

the compiled regular expression; either the expression pre-compiled statically, or the result of compiling it dynamically

Throws:

XPathException - if the regular expression is invalid