Class FuncDocument

All Implemented Interfaces:
Serializable, SourceLocator, ExpressionNode, ExpressionOwner, XPathVisitable

public class FuncDocument extends Function2Args
Execute the Doc() function. When the document function has exactly one argument and the argument is a node-set, then the result is the union, for each node in the argument node-set, of the result of calling the document function with the first argument being the string-value of the node, and the second argument being a node-set with the node as its only member. When the document function has two arguments and the first argument is a node-set, then the result is the union, for each node in the argument node-set, of the result of calling the document function with the first argument being the string-value of the node, and with the second argument being the second argument passed to the document function.
See Also:
  • Constructor Details

    • FuncDocument

      public FuncDocument()
  • Method Details

    • execute

      public XObject execute(XPathContext xctxt) throws TransformerException
      Execute the function. The function must return a valid object.
      Overrides:
      execute in class Function
      Parameters:
      xctxt - The current execution context.
      Returns:
      A valid XObject.
      Throws:
      TransformerException
    • error

      public void error(XPathContext xctxt, String msg, Object[] args) throws TransformerException
      Tell the user of an error, and probably throw an exception.
      Overrides:
      error in class Expression
      Parameters:
      xctxt - The XPath runtime state.
      msg - The error message key
      args - Arguments to be used in the error message
      Throws:
      XSLProcessorException - thrown if the active ProblemListener and XPathContext decide the error condition is severe enough to halt processing.
      TransformerException
    • warn

      public void warn(XPathContext xctxt, String msg, Object[] args) throws TransformerException
      Warn the user of a problem.
      Overrides:
      warn in class Expression
      Parameters:
      xctxt - The XPath runtime state.
      msg - Warning message key
      args - Arguments to be used in the warning message
      Throws:
      XSLProcessorException - thrown if the active ProblemListener and XPathContext decide the error condition is severe enough to halt processing.
      TransformerException
    • checkNumberArgs

      public void checkNumberArgs(int argNum) throws WrongNumberArgsException
      Overide the superclass method to allow one or two arguments.
      Overrides:
      checkNumberArgs in class Function2Args
      Parameters:
      argNum - Number of arguments passed in to this function
      Throws:
      WrongNumberArgsException
    • isNodesetExpr

      public boolean isNodesetExpr()
      Tell if the expression is a nodeset expression.
      Overrides:
      isNodesetExpr in class Expression
      Returns:
      true if the expression can be represented as a nodeset.