Class Replace

All Implemented Interfaces:
Serializable, SourceLocator, LocationProvider, SaxonLocator, CallableExpression, InstructionInfo, Locator

public class Replace extends SystemFunction implements CallableExpression
This class implements the replace() function for replacing substrings that match a regular expression
See Also:
  • Constructor Details

    • Replace

      public Replace()
  • Method Details

    • simplify

      public Expression simplify(ExpressionVisitor visitor) 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
      Parameters:
      visitor - an expression visitor
      Returns:
      the simplified expression
      Throws:
      XPathException - if an error is discovered during expression rewriting
    • optimize

      public Expression optimize(ExpressionVisitor visitor, ExpressionVisitor.ContextItemType contextItemType) throws XPathException
      Perform optimisation of an expression and its subexpressions.

      This method is called after all references to functions and variables have been resolved to the declaration of the function or variable, and after all type checking has been done.

      Overrides:
      optimize in class SystemFunction
      Parameters:
      visitor - an expression visitor
      contextItemType - the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set to Type.ITEM_TYPE
      Returns:
      the original expression, rewritten if appropriate to optimize execution
      Throws:
      XPathException - if an error is discovered during this phase (typically a type error)
    • getCompiledRegularExpression

      public RegularExpression getCompiledRegularExpression()
      Get the compiled regular expression if available, otherwise return null
      Returns:
      the compiled regex, or null
    • evaluateItem

      public Item evaluateItem(XPathContext c) throws XPathException
      Evaluate the function in a string context
      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
    • call

      public SequenceIterator call(SequenceIterator[] arguments, XPathContext context) throws XPathException
      Evaluate the expression
      Specified by:
      call in interface CallableExpression
      Parameters:
      arguments - the values of the arguments, supplied as SequenceIterators
      context - the dynamic evaluation context
      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