net.sf.saxon.functions
Class Replace

java.lang.Object
  |
  +--net.sf.saxon.expr.ComputedExpression
        |
        +--net.sf.saxon.expr.FunctionCall
              |
              +--net.sf.saxon.functions.SystemFunction
                    |
                    +--net.sf.saxon.functions.Replace

All Implemented Interfaces:

Expression, java.io.Serializable

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.functions.SystemFunction

operation

 

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

argument

 

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

lineNumber, NO_ARGUMENTS, staticProperties

 

Constructor Summary

Replace()

 

Method Summary
Item	evaluateItem(XPathContext c)           Evaluate the function in a string context
Expression	simplify()           Simplify and validate.

 

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

addContextDocumentArgument, checkArguments, computeCardinality, display, getDetails, getItemType, getName, getRequiredType, main, makeSystemFunction, useContextItemAsDefault

 

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

analyze, checkArgumentCount, getNumberOfArguments, getSubExpressions, preEvaluate, promote, setArguments, simplifyArguments

 

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

computeDependencies, computeSpecialProperties, computeStaticProperties, dynamicError, effectiveBooleanValue, evaluateAsString, getCardinality, getDependencies, getIntrinsicDependencies, getLineNumber, getSourceLocator, getSpecialProperties, iterate, markTailFunctionCalls, setLineNumber, typeError

 

Methods inherited from class java.lang.Object

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

 

Constructor Detail

Replace

public Replace()

simplify

public Expression simplify()
                    throws XPathException

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

Specified by:

simplify in interface Expression

Overrides:

simplify in class FunctionCall

Returns:

the simplified expression

Throws:

XPathException - if an error is discovered during expression rewriting

evaluateItem

public Item evaluateItem(XPathContext c)
                  throws XPathException

Evaluate the function in a string context

Specified by:

evaluateItem in interface Expression

Overrides:

evaluateItem in class ComputedExpression

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