Class Translate

All Implemented Interfaces:
Serializable, SourceLocator, LocationProvider, SaxonLocator, EvaluableItem, SequenceIterable, InstructionInfo, Locator

public class Translate extends SystemFunction
Implement the XPath translate() function
See Also:
  • Constructor Details

    • Translate

      public Translate()
  • Method Details

    • typeCheck

      public Expression typeCheck(ExpressionVisitor visitor, ItemType contextItemType) throws XPathException
      Description copied from class: FunctionCall
      Type-check the expression. This also calls preEvaluate() to evaluate the function if all the arguments are constant; functions that do not require this behavior can override the preEvaluate method.
      Overrides:
      typeCheck in class FunctionCall
      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 to perform necessary run-time type checks, and to perform other type-related optimizations
      Throws:
      XPathException - if an error is discovered during this phase (typically a type error)
    • evaluateItem

      public Item evaluateItem(XPathContext context) throws XPathException
      Evaluate the function
      Specified by:
      evaluateItem in interface EvaluableItem
      Overrides:
      evaluateItem in class Expression
      Parameters:
      context - 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
    • getStaticMap

      public IntToIntMap getStaticMap()
      Get the translation map built at compile time if there is one
    • translate

      public static CharSequence translate(StringValue sv0, StringValue sv1, StringValue sv2)
      Perform the translate function
    • translateUsingMap

      public static CharSequence translateUsingMap(CharSequence in, IntToIntMap map)
      Implement the translate() function using an index built at compile time
      Parameters:
      in - the string to be translated
      map - index built at compile time, mapping input characters to output characters. The map returns -1 for a character that is to be deleted from the input string, Integer.MAX_VALUE for a character that is to remain intact
      Returns:
      the translated character string