Package net.sf.saxon.functions

Class Doc

java.lang.Object
net.sf.saxon.functions.AbstractFunction
net.sf.saxon.functions.SystemFunction
net.sf.saxon.functions.Doc
All Implemented Interfaces:
Callable, FunctionItem, GroundedValue, Item, Sequence
public class Doc extends SystemFunction implements Callable
Implement the fn:doc() function - a simplified form of the Document function

  • Constructor Details

    • Doc

      public Doc()

  • Method Details

    • getParseOptions

      public ParseOptions getParseOptions()
      Get the parsing options set via setParseOptions()
      Returns:
      the parsing options

    • setParseOptions

      public void setParseOptions(ParseOptions parseOptions)
      Set options to be used for the parsing operation. Defaults to the parsing options set in the Configuration
      Parameters:
      parseOptions - the parsing options to be used. Currently only affects the behaviour of the sendDocument() method (used in streamed merging)

    • getCardinality

      public int getCardinality(Expression[] arguments)
      Description copied from class: SystemFunction
      Get the cardinality, given knowledge of the actual arguments
      Overrides:
      getCardinality in class SystemFunction
      Parameters:
      arguments - the actual arguments supplied
      Returns:
      the most precise available cardinality that the function will return

    • makeFunctionCall

      public Expression makeFunctionCall(Expression... arguments)
      Description copied from class: SystemFunction
      Make an expression that either calls this function, or that is equivalent to a call on this function
      Overrides:
      makeFunctionCall in class SystemFunction
      Parameters:
      arguments - the supplied arguments to the function call
      Returns:
      either a function call on this function, or an expression that delivers the same result

    • maybePreEvaluate

      public static Expression maybePreEvaluate(SystemFunction sf, Expression[] arguments)

    • call

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

    • getSpecialProperties

      public int getSpecialProperties(Expression[] arguments)
      Get the static properties of this expression (other than its type). The result is bit-signficant. These properties are used for optimizations. In general, if property bit is set, it is true, but if it is unset, the value is unknown.
      Overrides:
      getSpecialProperties in class SystemFunction
      Parameters:
      arguments - the expressions supplied as arguments to the function
      Returns:
      the properties