net.sf.saxon.functions

Class Replace

java.lang.Object

net.sf.saxon.om.AbstractItem

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.RegexFunction

net.sf.saxon.functions.Replace

All Implemented Interfaces:

PullEvent, Callable, Function, GroundedValue, Item, Sequence

public class Replace
extends RegexFunction

This class implements the replace() function for replacing substrings that match a regular expression

Constructor Summary

Constructors

Constructor and Description
Replace()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	allowRegexMatchingEmptyString()
StringValue	call(XPathContext context, Sequence[] arguments) Evaluate the expression
static String	checkReplacement(CharSequence rep) Check the contents of the replacement string
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.RegexFunction

getRegularExpression, getStaticRegex

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

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

Replace

public Replace()

Method Detail

allowRegexMatchingEmptyString

protected boolean allowRegexMatchingEmptyString()

Specified by:

allowRegexMatchingEmptyString in class RegexFunction

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 RegexFunction

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

call

public StringValue call(XPathContext context,
               Sequence[] arguments)
                 throws XPathException

Evaluate the expression

Parameters:

context - the dynamic evaluation context

arguments - the values of the arguments, supplied as SequenceIterators

Returns:

the result of the evaluation, in the form of a SequenceIterator

Throws:

XPathException - if a dynamic error occurs during the evaluation of the expression

checkReplacement

public static String checkReplacement(CharSequence rep)

Check the contents of the replacement string

Parameters:

rep - the replacement string

Returns:

null if the string is OK, or an error message if not