net.sf.saxon.functions
Class Replace

java.lang.Object
  net.sf.saxon.expr.Expression
      net.sf.saxon.expr.FunctionCall
          net.sf.saxon.functions.SystemFunction
              net.sf.saxon.functions.Replace

All Implemented Interfaces:

Serializable, SourceLocator, Container, EvaluableItem, SequenceIterable, InstructionInfoProvider

public class Replace
extends SystemFunction

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

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sf.saxon.expr.Expression

EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD

Constructor Summary

Replace()

Method Summary

static String	checkReplacement(CharSequence rep) Check the contents of the replacement string
Item	evaluateItem(XPathContext c) Evaluate the function in a string context
RegularExpression	getCompiledRegularExpression() Get the compiled regular expression if available, otherwise return null
Expression	simplify(StaticContext env) Simplify and validate.

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

checkArguments, computeCardinality, computeSpecialProperties, display, getDetails, getErrorCodeForTypeErrors, getItemType, main, makeSystemFunction, optimize, setDetails

Methods inherited from class net.sf.saxon.expr.FunctionCall

getArguments, getDisplayName, getFunctionNameCode, getNumberOfArguments, iterateSubExpressions, preEvaluate, promote, replaceSubExpression, setArguments, setFunctionNameCode, typeCheck

Methods inherited from class net.sf.saxon.expr.Expression

adoptChildExpression, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, effectiveBooleanValue, evaluateAsString, getCardinality, getColumnNumber, getContainingProcedure, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getInstructionInfo, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, iterate, markTailFunctionCalls, process, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, suppressValidation

Methods inherited from class java.lang.Object

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

Constructor Detail

Replace

public Replace()

Method Detail

simplify

public Expression simplify(StaticContext env)
                    throws XPathException

Simplify and validate. This is a pure function so it can be simplified in advance if the arguments are known

Overrides:

simplify in class FunctionCall

Returns:

the simplified expression

Throws:

XPathException - if an error is discovered during expression rewriting

getCompiledRegularExpression

public RegularExpression getCompiledRegularExpression()

Get the compiled regular expression if available, otherwise return null

evaluateItem

public Item evaluateItem(XPathContext c)
                  throws XPathException

Evaluate the function in a string context

Specified by:

evaluateItem in interface EvaluableItem

Overrides:

evaluateItem in class Expression

Parameters:

c - The context in which the expression is to be evaluated

Returns:

the node or atomic value that results from evaluating the expression; or null to indicate that the result is an empty sequence

Throws:

XPathException - if any dynamic error occurs evaluating the expression

checkReplacement

public static String checkReplacement(CharSequence rep)

Check the contents of the replacement string

Returns:

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