Package net.sf.saxon.functions

Class Replace

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.RegexFunction

net.sf.saxon.functions.Replace

All Implemented Interfaces:

Callable, StatefulSystemFunction, FunctionItem, 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	Description
Replace()

Method Summary

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

copy, getRegularExpression, getStaticRegex, makeOptimizedFunctionCall

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

dependsOnContextItem, dynamicCall, equals, export, exportAdditionalArguments, exportAttributes, fixArguments, getArity, getCardinality, getContextNode, getDescription, getDetails, getElaborator, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, getStreamerName, getUniStringArg, hashCode, importAttributes, isSequenceVariadic, isTrustedResultType, makeCall, makeFunction, makeFunction40, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, toShortString, toString, typeCheckCaller

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

atomize, deepEqual40, deepEquals, effectiveBooleanValue, getAnnotations, getUnicodeStringValue, isArray, isMap, makeNewContext, simplify, typeCheck

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getGenre

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

asIterable, concatenate, containsNode, materialize

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

getLength, getStringValue, head, isStreamed, itemAt, iterate, reduce, subsequence

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

makeRepeatable

Constructor Details

Replace

public Replace()

Method Details

make20

public static Replace make20()

make40

public static Replace make40()

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(UnicodeString 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