Package net.sf.saxon.functions
This package provides implementations of all the core functions available for use
in XPath expressions. This includes all the functions defined in the XPath 2.0
Functions and Operators specification, as well as the additional functions
defined for use in XSLT. The package also includes Saxon extension functions. Most
of these are in a single class Extensions
, but some of the more
complex functions are in their own classes, for example Evaluate
implements
saxon:evaluate()
.
There is one class for group of closely-related functions. These all inherit from the class
net.sf.saxon.expr.Function. The class StandardFunction
is used to map a function
name to its implementation; it contains tables of information describing the signature of each
function, so that the type-checking code is completely generic.
The package also contains machinery for defining user extension functions. A collection
of functions is represented by a FunctionLibrary
object. There are several
standard function libraries available, covering core functions, Saxon extension functions
constructor functions, and user extension functions: each category is covered by a subclass
of FunctionLibrary
, and there is also a FunctionLibraryList
that
represents the total collection of functions in these individual libraries. The
JavaExtensionLibrary
contains the logic for binding Java extension functions
given their name and arity and the types of their arguments. The class ExtensionFunctionCall
contains the run-time logic for converting XPath values to the required Java types, and for converting
the result back to an XPath value.
These classes, although public, will not normally be used directly by user-written Java applications.
Michael H. Kay
Saxonica Limited
9 February 2005
-
ClassDescriptionThis class implements the XPath 2.0 functions adjust-date-to-timezone(), adjust-time-timezone(), and adjust-dateTime-timezone().This class implements the sum(), avg(), count() functions,This class supports the XSLT element-available and function-available functions.This class supports the base-uri() functions in XPath 2.0This class supports the XPath functions boolean(), not(), true(), and false()XPath 2.0 codepoint-equal() function.This class supports the function codepoints-to-stringAbstract superclass for all functions that take an optional collation argumentImplement the fn:collection() function.XSLT 2.0 compare() functionAbtract class representing a function call that is always rewritten at compile-time: it can never be executedThis class supports the get_X_from_Y functions defined in XPath 2.0The ConstructorFunctionLibrary represents the collection of constructor functions for atomic types.This class implements the contains(), starts-with(), ends-with(), substring-before(), and substring-after() functionsImplement the XSLT current() functionThis class implements the XPath 2.0 functions current-date(), current-time(), and current-dateTime(), as well as the function implicit-timezone().Implements the XSLT functions current-group() and current-grouping-key()Implement XPath function fn:data()This class supports the dateTime($date, $time) functionXSLT 2.0 deep-equal() function.Implement the XPath 2.0 default-collation() functionThe XPath 2.0 distinct-values() functionIterator class to return the distinct values in a sequenceImplement the fn:doc() function - a simplified form of the Document functionImplement the fn:doc-available() functionImplements the XSLT document() functionImplement XPath function fn:error()This class supports the functions encode-for-uri() and iri-to-uri()This class implements the saxon:evaluate(), saxon:expression(), and saxon:eval() extension functions, which are specially-recognized by the system because they need access to parts of the static contextInner class PreparedExpression represents a compiled XPath expression together with the standard variables $p1 ..An ExecutableFunctionLibrary is a function library that contains definitions of functions for use at run-time.Implement the exists() and empty() functionsThis class acts as a container for an extension function defined to call a method in a user-defined class.This is a marker interface representing an abstract superclass of JavaExtensionFunctionFactory and DotNetExtensionFunctionFactory.This class implements functions that are supplied as standard with SAXON, but which are not defined in the XSLT or XPath specifications.This class implements the upper-case() and lower-case() functionsImplement the format-date() function in XSLT 2.0XSLT 2.0 implementation of format-number() function - removes the dependence on the JDK.A FunctionLibrary handles the binding of function calls in XPath (or XQuery) expressions.A FunctionLibraryList is a list of FunctionLibraries.The XPath id() function XPath 2.0 version: accepts any sequence as the first parameter; each item in the sequence is taken as an IDREFS value, that is, a space-separated list of ID values.The XPath 2.0 index-of() functionIterator to return the index positions of selected items in a sequenceThis class supports fuctions get-in-scope-prefixes()The XPath 2.0 insert-before() functionThis class implements the saxon:is-whole-number() extension function, which is specially-recognized by the system because calls are generated by the optimizer.Implements the saxon:item-at() function.This class acts as a factory for creating expressions that call Java extension functions.The JavaExtensionLibrary is a FunctionLibrary that binds XPath function calls to calls on Java methods (or constructors, or fields).Implement the XPath 2.0 function last()This class implements the matches() function for regular expression matchingThis class implements the min() and max() functionsThis class supports the name(), local-name(), and namespace-uri() functions from XPath 1.0, and also the XSLT generate-id() functionThis class supports the function namespace-uri-for-prefix()This class supports the nilled() functionImplement the XPath normalize-space() functionImplement the XPath normalize-unicode() functionImplements the XPath number() function.This class implements the saxon:parse() extension function, which is specially-recognized by the system because it needs access to parts of the static contextImplements the fn:put() function in XQuery Update 1.0.This class supports the fn:QName() function (previously named fn:expanded-QName())The XPath 2.0 remove() functionAn implementation of SequenceIterator that returns all items except the one at a specified position.This class implements the replace() function for replacing substrings that match a regular expressionThis class supports the resolve-QName function in XPath 2.0This class supports the resolve-uri() functions in XPath 2.0Implement XPath function fn:reverse()Implement the XPath 2.0 root() functionThis class supports the ceiling(), floor(), round(), and round-to-half-even() functions, and also the abs() functionThis class implements the saxon:serialize() extension function, which is specially-recognized by the system because it needs access to parts of the static contextThis class implements the default collection URI Resolver.This class contains static data tables defining the properties of standard functions.An entry in the table describing the properties of a functionThis class supports the static-base-uri() function in XPath 2.0.Implement XPath function string()xf:string-join(string* $sequence, string $separator)Implement the XPath string-length() functionThis class supports the function string-to-codepoints()Implements the XPath 2.0 subsequence() functionThis class implements the XPath substring() functionAbstract superclass for system-defined and user-defined functionsThe SystemFunctionLibrary represents the collection of functions in the fn: namespace.Implementation of the XSLT system-property() functionThis class implements the tokenize() function for regular expression matching.This class supports the XPath 2.0 function trace().Implement the XPath translate() functionThis class supports the XPath 2.0 functions exactly-one(), one-or-more(), zero-or-one().XPath 2.0 unordered() functionImplements the unparsed-entity-uri() function defined in XSLT 1.0 and the unparsed-entity-public-id() function defined in XSLT 2.0A set of query parameters on a URI passed to the collection() or document() functionThe VendorFunctionLibrary represents specially-recognized functions in the Saxon namespace.This is a marker interface used to identify functions that are defined in XSLT rather than in XPath