Class StartsWith

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

public class StartsWith extends CollatingFunctionFixed
Implements the fn:starts-with() function, with the collation already known
  • Constructor Details Link icon

    • StartsWith Link icon

      public StartsWith()
  • Method Details Link icon

    • isSubstringMatchingFunction Link icon

      public boolean isSubstringMatchingFunction()
      Description copied from class: CollatingFunctionFixed
      Ask whether this function needs a collation that can handle substring matching
      Overrides:
      isSubstringMatchingFunction in class CollatingFunctionFixed
      Returns:
      true in the case of functions such as contains() and starts-with() where substring matching is required. Returns false by default;
    • 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. Note: modifying the contents of this array should not be attempted, it is likely to have no effect.
      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
    • startsWith Link icon

      public static boolean startsWith(UnicodeString arg0, UnicodeString arg1, SubstringMatcher collator)
    • call Link icon

      public BooleanValue call(XPathContext context, Sequence[] arguments) throws XPathException
      Evaluate the function
      Parameters:
      context - the dynamic evaluation context
      arguments - the values of the arguments, supplied as Sequences.

      Generally it is advisable, if calling iterate() to process a supplied sequence, to call it only once; if the value is required more than once, it should first be converted to a GroundedValue by calling the utility method SequenceTool.toGroundedValue().

      If the expected value is a single item, the item should be obtained by calling Sequence.head(): it cannot be assumed that the item will be passed as an instance of Item or AtomicValue.

      It is the caller's responsibility to perform any type conversions required to convert arguments to the type expected by the callee. An exception is where this Callable is explicitly an argument-converting wrapper around the original Callable.

      Returns:
      the result of the evaluation, in the form of a Sequence. It is the responsibility of the callee to ensure that the type of result conforms to the expected result type.
      Throws:
      XPathException - if a dynamic error occurs during the evaluation of the expression