Package com.saxonica.functions.qt4.csv

Class CsvFunction

java.lang.Object
net.sf.saxon.functions.AbstractFunction
net.sf.saxon.functions.SystemFunction
com.saxonica.functions.qt4.csv.CsvFunction
All Implemented Interfaces:
Callable, IFunctionWithRetainedParameterNames, FunctionItem, GroundedValue, Item, Sequence
Direct Known Subclasses:
CsvDoc, CsvToArrays, CsvToXml, ParseCsv
public abstract class CsvFunction extends SystemFunction
This abstract class provides shared option-handling support used by the functions fn:parse-csv(), fn:csv-to-xdm(), and fn:csv-to-xml().

  • Constructor Details

    • CsvFunction

      public CsvFunction()

  • Method Details

    • coreOptions

      public static OptionsParameter coreOptions()
      Provides an OptionsParameter with all the options used by every csv-* function.
      Returns:
      an OptionsParameter instance with the core options already added.

    • extendedOptions

      public static OptionsParameter extendedOptions()

    • call

      public abstract Sequence call(XPathContext context, Sequence[] arguments) throws XPathException
      Description copied from interface: Callable
      Call the Callable.
      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