Class String_1

All Implemented Interfaces:
Callable, FunctionItem, GroundedValue, Item, Sequence

public class String_1 extends ScalarSystemFunction
Implement XPath function string() with a single argument
  • Constructor Details Link icon

    • String_1 Link icon

      public String_1()
  • Method Details Link icon

    • evaluate Link icon

      public AtomicValue evaluate(Item arg, XPathContext context) throws XPathException
      Description copied from class: ScalarSystemFunction
      Abstract method that must be supplied in subclasses to perform the evaluation
      Specified by:
      evaluate in class ScalarSystemFunction
      Parameters:
      arg - the supplied argument
      context - the dynamic context
      Returns:
      the result of the evaluation
      Throws:
      XPathException - if a dynamic error occurs
    • resultWhenEmpty Link icon

      public Sequence resultWhenEmpty()
      Description copied from class: ScalarSystemFunction
      Method that may be supplied in subclasses, to indicate the result that is returned when an empty sequence is supplied as the argument value. The default is to return the empty sequence
      Overrides:
      resultWhenEmpty in class ScalarSystemFunction
      Returns:
      the result of evaluation when the supplied argument is an empty sequence
    • makeOptimizedFunctionCall Link icon

      public Expression makeOptimizedFunctionCall(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo, Expression... arguments) throws XPathException
      Allow the function to create an optimized call based on the values of the actual arguments
      Overrides:
      makeOptimizedFunctionCall in class SystemFunction
      Parameters:
      visitor - the expression visitor
      contextInfo - information about the context item
      arguments - the supplied arguments to the function call
      Returns:
      either a function call on this function, or an expression that delivers the same result, or null indicating that no optimization has taken place
      Throws:
      XPathException - if an error is detected
    • getStreamerName Link icon

      public String getStreamerName()
      Description copied from class: SystemFunction
      Get a name that identifies the class that can be used to evaluate this function in streaming mode, that is, supplying one item or event at a time as it is delivered by the parser. Special streaming support is generally available in Saxon-EE for all system functions that take a sequence as their argument.
      Overrides:
      getStreamerName in class SystemFunction
      Returns:
      a name that identifies a class that supports streamed evaluation of this system function, or null if no such class is available. The mapping of names to classes is defined in the Saxon-EE class StreamerMap. In non-streaming Saxon editions (HE and PE) the method always returns null.
    • getElaborator Link icon

      public Elaborator getElaborator()
      Make an elaborator for a system function call on this function
      Overrides:
      getElaborator in class SystemFunction
      Returns:
      a suitable elaborator; or null if no custom elaborator is available