<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:50 GMT 2011 -->
<TITLE>
net.sf.saxon.functions
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="net.sf.saxon.functions";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/expr/sort/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../net/sf/saxon/functions/regex/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/functions/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package net.sf.saxon.functions
</H2>
This package provides implementations of all the core functions available for use
in XPath expressions.
<P>
<B>See:</B>
<BR>
<A HREF="#package_description"><B>Description</B></A>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/ExtensionFunctionFactory.html" title="interface in net.sf.saxon.functions">ExtensionFunctionFactory</A></B></TD>
<TD>This is a marker interface representing an abstract superclass of JavaExtensionFunctionFactory
and DotNetExtensionFunctionFactory.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/FunctionLibrary.html" title="interface in net.sf.saxon.functions">FunctionLibrary</A></B></TD>
<TD>A FunctionLibrary handles the binding of function calls in XPath (or XQuery) expressions.</TD>
</TR>
</TABLE>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Adjust.html" title="class in net.sf.saxon.functions">Adjust</A></B></TD>
<TD>This class implements the XPath 2.0 functions
adjust-date-to-timezone(), adjust-time-timezone(), and adjust-dateTime-timezone().</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Aggregate.html" title="class in net.sf.saxon.functions">Aggregate</A></B></TD>
<TD>This abstract class provides functionality common to the sum(), avg(), count(),
exists(), and empty() functions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Available.html" title="class in net.sf.saxon.functions">Available</A></B></TD>
<TD>This class supports the XSLT element-available, function-available, and type-available functions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Average.html" title="class in net.sf.saxon.functions">Average</A></B></TD>
<TD>Implementation of the fn:avg function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/BaseURI.html" title="class in net.sf.saxon.functions">BaseURI</A></B></TD>
<TD>This class supports the base-uri() function in XPath 2.0</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/BooleanFn.html" title="class in net.sf.saxon.functions">BooleanFn</A></B></TD>
<TD>This class supports the XPath functions boolean(), not(), true(), and false()</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/CodepointEqual.html" title="class in net.sf.saxon.functions">CodepointEqual</A></B></TD>
<TD>XPath 2.0 codepoint-equal() function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/CodepointsToString.html" title="class in net.sf.saxon.functions">CodepointsToString</A></B></TD>
<TD>This class supports the function codepoints-to-string</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/CollatingFunction.html" title="class in net.sf.saxon.functions">CollatingFunction</A></B></TD>
<TD>Abstract superclass for all functions that take an optional collation argument</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Collection.html" title="class in net.sf.saxon.functions">Collection</A></B></TD>
<TD>Implement the fn:collection() function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Compare.html" title="class in net.sf.saxon.functions">Compare</A></B></TD>
<TD>XSLT 2.0 compare() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/CompileTimeFunction.html" title="class in net.sf.saxon.functions">CompileTimeFunction</A></B></TD>
<TD>Abtract class representing a function call that is always rewritten at compile-time:
it can never be executed</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Component.html" title="class in net.sf.saxon.functions">Component</A></B></TD>
<TD>This class supports the get_X_from_Y functions defined in XPath 2.0</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Concat.html" title="class in net.sf.saxon.functions">Concat</A></B></TD>
<TD>Implementation of the fn:concat() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/ConstructorFunctionLibrary.html" title="class in net.sf.saxon.functions">ConstructorFunctionLibrary</A></B></TD>
<TD>The ConstructorFunctionLibrary represents the collection of constructor functions for atomic types.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Contains.html" title="class in net.sf.saxon.functions">Contains</A></B></TD>
<TD>Implements the fn:contains() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Count.html" title="class in net.sf.saxon.functions">Count</A></B></TD>
<TD>Implementation of the fn:count function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Current.html" title="class in net.sf.saxon.functions">Current</A></B></TD>
<TD>Implement the XSLT current() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/CurrentDateTime.html" title="class in net.sf.saxon.functions">CurrentDateTime</A></B></TD>
<TD>This class implements the XPath 2.0 functions
current-date(), current-time(), and current-dateTime(), as
well as the function implicit-timezone().</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/CurrentGroup.html" title="class in net.sf.saxon.functions">CurrentGroup</A></B></TD>
<TD>Implements the XSLT function current-group()</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/CurrentGroupingKey.html" title="class in net.sf.saxon.functions">CurrentGroupingKey</A></B></TD>
<TD>Implements the XSLT function current-grouping-key()</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Data.html" title="class in net.sf.saxon.functions">Data</A></B></TD>
<TD>Implement XPath function fn:data()</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/DateTimeConstructor.html" title="class in net.sf.saxon.functions">DateTimeConstructor</A></B></TD>
<TD>This class supports the dateTime($date, $time) function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/DeepEqual.html" title="class in net.sf.saxon.functions">DeepEqual</A></B></TD>
<TD>XSLT 2.0 deep-equal() function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/DefaultCollation.html" title="class in net.sf.saxon.functions">DefaultCollation</A></B></TD>
<TD>Implement the XPath 2.0 default-collation() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/DistinctValues.html" title="class in net.sf.saxon.functions">DistinctValues</A></B></TD>
<TD>The XPath 2.0 distinct-values() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/DistinctValues.DistinctIterator.html" title="class in net.sf.saxon.functions">DistinctValues.DistinctIterator</A></B></TD>
<TD>Iterator class to return the distinct values in a sequence</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Doc.html" title="class in net.sf.saxon.functions">Doc</A></B></TD>
<TD>Implement the fn:doc() function - a simplified form of the Document function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/DocAvailable.html" title="class in net.sf.saxon.functions">DocAvailable</A></B></TD>
<TD>Implement the fn:doc-available() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/DocAvailable.ErrorDiscarder.html" title="class in net.sf.saxon.functions">DocAvailable.ErrorDiscarder</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/DocumentFn.html" title="class in net.sf.saxon.functions">DocumentFn</A></B></TD>
<TD>Implements the XSLT document() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/DocumentUriFn.html" title="class in net.sf.saxon.functions">DocumentUriFn</A></B></TD>
<TD>This class supports the document-uri() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/ElementAvailable.html" title="class in net.sf.saxon.functions">ElementAvailable</A></B></TD>
<TD>This class supports the XSLT element-available and function-available functions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Empty.html" title="class in net.sf.saxon.functions">Empty</A></B></TD>
<TD>Implementation of the fn:exists function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/EndsWith.html" title="class in net.sf.saxon.functions">EndsWith</A></B></TD>
<TD>Implements the fn:ends-with() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Error.html" title="class in net.sf.saxon.functions">Error</A></B></TD>
<TD>Implement XPath function fn:error()</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/EscapeURI.html" title="class in net.sf.saxon.functions">EscapeURI</A></B></TD>
<TD>This class supports the functions encode-for-uri() and iri-to-uri()</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/ExecutableFunctionLibrary.html" title="class in net.sf.saxon.functions">ExecutableFunctionLibrary</A></B></TD>
<TD>An ExecutableFunctionLibrary is a function library that contains definitions of functions for use at
run-time.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Exists.html" title="class in net.sf.saxon.functions">Exists</A></B></TD>
<TD>Implementation of the fn:exists function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/ForceCase.html" title="class in net.sf.saxon.functions">ForceCase</A></B></TD>
<TD>This class implements the upper-case() and lower-case() functions</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/FormatDate.html" title="class in net.sf.saxon.functions">FormatDate</A></B></TD>
<TD>Implement the format-date(), format-time(), and format-dateTime() functions
in XSLT 2.0 and XQuery 1.1.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/FormatNumber.html" title="class in net.sf.saxon.functions">FormatNumber</A></B></TD>
<TD>XSLT 2.0 implementation of format-number() function - removes the dependence on the JDK.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/FunctionArity.html" title="class in net.sf.saxon.functions">FunctionArity</A></B></TD>
<TD>This class implements the function function-arity(), which is a standard function in XQuery 1.1</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/FunctionAvailable.html" title="class in net.sf.saxon.functions">FunctionAvailable</A></B></TD>
<TD>This class supports the XSLT element-available and function-available functions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/FunctionLibraryList.html" title="class in net.sf.saxon.functions">FunctionLibraryList</A></B></TD>
<TD>A FunctionLibraryList is a list of FunctionLibraries.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/FunctionName.html" title="class in net.sf.saxon.functions">FunctionName</A></B></TD>
<TD>This class implements the function function-name(), which is a standard function in XQuery 1.1</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/GenerateId.html" title="class in net.sf.saxon.functions">GenerateId</A></B></TD>
<TD>This class supports the generate-id() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Id.html" title="class in net.sf.saxon.functions">Id</A></B></TD>
<TD>The XPath id() or element-with-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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Idref.html" title="class in net.sf.saxon.functions">Idref</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/IndexOf.html" title="class in net.sf.saxon.functions">IndexOf</A></B></TD>
<TD>The XPath 2.0 index-of() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/IndexOf.IndexIterator.html" title="class in net.sf.saxon.functions">IndexOf.IndexIterator</A></B></TD>
<TD>Iterator to return the index positions of selected items in a sequence</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/InScopePrefixes.html" title="class in net.sf.saxon.functions">InScopePrefixes</A></B></TD>
<TD>This class supports fuctions get-in-scope-prefixes()</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Insert.html" title="class in net.sf.saxon.functions">Insert</A></B></TD>
<TD>The XPath 2.0 insert-before() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Insert.InsertIterator.html" title="class in net.sf.saxon.functions">Insert.InsertIterator</A></B></TD>
<TD>Insertion iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/IntegratedFunctionCall.html" title="class in net.sf.saxon.functions">IntegratedFunctionCall</A></B></TD>
<TD>Expression representing a call to a user-written extension
function implemented as a subtype of <A HREF="../../../../net/sf/saxon/lib/ExtensionFunctionCall.html" title="class in net.sf.saxon.lib"><CODE>ExtensionFunctionCall</CODE></A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/IntegratedFunctionLibrary.html" title="class in net.sf.saxon.functions">IntegratedFunctionLibrary</A></B></TD>
<TD>A library of integrated function calls, that is, user-written extension functions implemented
as instances of the class IntegratedFunction.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/IsWholeNumber.html" title="class in net.sf.saxon.functions">IsWholeNumber</A></B></TD>
<TD>This class implements the saxon:is-whole-number() extension function,
which is specially-recognized by the system because calls are generated by the optimizer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/ItemAt.html" title="class in net.sf.saxon.functions">ItemAt</A></B></TD>
<TD>Implements the saxon:item-at() function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/KeyFn.html" title="class in net.sf.saxon.functions">KeyFn</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/KeyFn.SubtreeFilter.html" title="class in net.sf.saxon.functions">KeyFn.SubtreeFilter</A></B></TD>
<TD>Mapping class to filter nodes that have the origin node as an ancestor-or-self</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Lang.html" title="class in net.sf.saxon.functions">Lang</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Last.html" title="class in net.sf.saxon.functions">Last</A></B></TD>
<TD>Implement the XPath 2.0 function last()</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/LocalNameFn.html" title="class in net.sf.saxon.functions">LocalNameFn</A></B></TD>
<TD>This class supports the local-name() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Matches.html" title="class in net.sf.saxon.functions">Matches</A></B></TD>
<TD>This class implements the matches() function for regular expression matching</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Minimax.html" title="class in net.sf.saxon.functions">Minimax</A></B></TD>
<TD>This class implements the min() and max() functions</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/NameFn.html" title="class in net.sf.saxon.functions">NameFn</A></B></TD>
<TD>This class supports the name() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/NamespaceForPrefix.html" title="class in net.sf.saxon.functions">NamespaceForPrefix</A></B></TD>
<TD>This class supports the function namespace-uri-for-prefix()</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/NamespaceUriFn.html" title="class in net.sf.saxon.functions">NamespaceUriFn</A></B></TD>
<TD>This class supports the namespace-uri() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Nilled.html" title="class in net.sf.saxon.functions">Nilled</A></B></TD>
<TD>This class supports the nilled() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/NodeNameFn.html" title="class in net.sf.saxon.functions">NodeNameFn</A></B></TD>
<TD>This class supports the name(), local-name(), and namespace-uri() functions
from XPath 1.0, and also the XSLT generate-id() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/NormalizeSpace.html" title="class in net.sf.saxon.functions">NormalizeSpace</A></B></TD>
<TD>Implement the XPath normalize-space() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/NormalizeUnicode.html" title="class in net.sf.saxon.functions">NormalizeUnicode</A></B></TD>
<TD>Implement the XPath normalize-unicode() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/NotFn.html" title="class in net.sf.saxon.functions">NotFn</A></B></TD>
<TD>This class supports the XPath functions boolean(), not(), true(), and false()</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/NumberFn.html" title="class in net.sf.saxon.functions">NumberFn</A></B></TD>
<TD>Implements the XPath number() function.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Position.html" title="class in net.sf.saxon.functions">Position</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Put.html" title="class in net.sf.saxon.functions">Put</A></B></TD>
<TD>Implements the fn:put() function in XQuery Update 1.0.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/QNameFn.html" title="class in net.sf.saxon.functions">QNameFn</A></B></TD>
<TD>This class supports the fn:QName() function (previously named fn:expanded-QName())</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/RegexGroup.html" title="class in net.sf.saxon.functions">RegexGroup</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Remove.html" title="class in net.sf.saxon.functions">Remove</A></B></TD>
<TD>The XPath 2.0 remove() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Remove.RemoveIterator.html" title="class in net.sf.saxon.functions">Remove.RemoveIterator</A></B></TD>
<TD>An implementation of SequenceIterator that returns all items except the one
at a specified position.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Replace.html" title="class in net.sf.saxon.functions">Replace</A></B></TD>
<TD>This class implements the replace() function for replacing
substrings that match a regular expression</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/ResolveQName.html" title="class in net.sf.saxon.functions">ResolveQName</A></B></TD>
<TD>This class supports the resolve-QName function in XPath 2.0</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/ResolveURI.html" title="class in net.sf.saxon.functions">ResolveURI</A></B></TD>
<TD>This class supports the resolve-uri() functions in XPath 2.0</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Reverse.html" title="class in net.sf.saxon.functions">Reverse</A></B></TD>
<TD>Implement XPath function fn:reverse()</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Root.html" title="class in net.sf.saxon.functions">Root</A></B></TD>
<TD>Implement the XPath 2.0 root() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Rounding.html" title="class in net.sf.saxon.functions">Rounding</A></B></TD>
<TD>This class supports the ceiling(), floor(), round(), and round-to-half-even() functions,
and also the abs() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.html" title="class in net.sf.saxon.functions">StandardFunction</A></B></TD>
<TD>This class contains static data tables defining the properties of standard functions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.Entry.html" title="class in net.sf.saxon.functions">StandardFunction.Entry</A></B></TD>
<TD>An entry in the table describing the properties of a function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/StartsWith.html" title="class in net.sf.saxon.functions">StartsWith</A></B></TD>
<TD>Implements the fn:starts-with() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/StaticBaseURI.html" title="class in net.sf.saxon.functions">StaticBaseURI</A></B></TD>
<TD>This class supports the static-base-uri() function in XPath 2.0.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/StringFn.html" title="class in net.sf.saxon.functions">StringFn</A></B></TD>
<TD>Implement XPath function string()</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/StringJoin.html" title="class in net.sf.saxon.functions">StringJoin</A></B></TD>
<TD>xf:string-join(string* $sequence, string $separator)</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/StringLength.html" title="class in net.sf.saxon.functions">StringLength</A></B></TD>
<TD>Implement the XPath string-length() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/StringToCodepoints.html" title="class in net.sf.saxon.functions">StringToCodepoints</A></B></TD>
<TD>This class supports the function string-to-codepoints()</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Subsequence.html" title="class in net.sf.saxon.functions">Subsequence</A></B></TD>
<TD>Implements the XPath 2.0 subsequence() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Substring.html" title="class in net.sf.saxon.functions">Substring</A></B></TD>
<TD>This class implements the XPath substring() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/SubstringAfter.html" title="class in net.sf.saxon.functions">SubstringAfter</A></B></TD>
<TD>Implements the fn:substring-after() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/SubstringBefore.html" title="class in net.sf.saxon.functions">SubstringBefore</A></B></TD>
<TD>Implements the fn:substring-before() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Sum.html" title="class in net.sf.saxon.functions">Sum</A></B></TD>
<TD>Implementation of the fn:sum function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/SystemFunction.html" title="class in net.sf.saxon.functions">SystemFunction</A></B></TD>
<TD>Abstract superclass for system-defined and user-defined functions</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/SystemFunctionLibrary.html" title="class in net.sf.saxon.functions">SystemFunctionLibrary</A></B></TD>
<TD>The SystemFunctionLibrary represents the collection of functions in the fn: namespace.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/SystemProperty.html" title="class in net.sf.saxon.functions">SystemProperty</A></B></TD>
<TD>Implementation of the XSLT system-property() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Tokenize.html" title="class in net.sf.saxon.functions">Tokenize</A></B></TD>
<TD>This class implements the tokenize() function for regular expression matching.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Trace.html" title="class in net.sf.saxon.functions">Trace</A></B></TD>
<TD>This class supports the XPath 2.0 function trace().</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Translate.html" title="class in net.sf.saxon.functions">Translate</A></B></TD>
<TD>Implement the XPath translate() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/TreatFn.html" title="class in net.sf.saxon.functions">TreatFn</A></B></TD>
<TD>This class supports the XPath 2.0 functions exactly-one(), one-or-more(), zero-or-one().</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/TypeAvailable.html" title="class in net.sf.saxon.functions">TypeAvailable</A></B></TD>
<TD>This class supports the XSLT element-available and function-available functions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/Unordered.html" title="class in net.sf.saxon.functions">Unordered</A></B></TD>
<TD>XPath 2.0 unordered() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/UnparsedEntity.html" title="class in net.sf.saxon.functions">UnparsedEntity</A></B></TD>
<TD>Implements the unparsed-entity-uri() function defined in XSLT 1.0
and the unparsed-entity-public-id() function defined in XSLT 2.0</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/UnparsedText.html" title="class in net.sf.saxon.functions">UnparsedText</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/UnparsedTextAvailable.html" title="class in net.sf.saxon.functions">UnparsedTextAvailable</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/UnparsedTextLines.html" title="class in net.sf.saxon.functions">UnparsedTextLines</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/UriCollection.html" title="class in net.sf.saxon.functions">UriCollection</A></B></TD>
<TD>Implement the fn:uri-collection() function (new in XQuery 3.0/XSLT 3.0).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/URIQueryParameters.html" title="class in net.sf.saxon.functions">URIQueryParameters</A></B></TD>
<TD>A set of query parameters on a URI passed to the collection() or document() function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/URIQueryParameters.RegexFilter.html" title="class in net.sf.saxon.functions">URIQueryParameters.RegexFilter</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/functions/VendorFunctionLibrary.html" title="class in net.sf.saxon.functions">VendorFunctionLibrary</A></B></TD>
<TD>The VendorFunctionLibrary represents specially-recognized functions in the Saxon namespace.</TD>
</TR>
</TABLE>
<P>
<A NAME="package_description"><!-- --></A><H2>
Package net.sf.saxon.functions Description
</H2>
<P>
<p>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
<i>Functions and Operators</i> 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 <code>Extensions</code>, but some of the more
complex functions are in their own classes, for example <code>Evaluate</code> implements
<code>saxon:evaluate()</code>.</p>
<p>There is one class for group of closely-related functions. These all inherit from the class
net.sf.saxon.expr.Function. The class <code>StandardFunction</code> 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.</p>
<p>The package also contains machinery for defining user extension functions. A collection
of functions is represented by a <code>FunctionLibrary</code> 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 <code>FunctionLibrary</code>, and there is also a <code>FunctionLibraryList</code> that
represents the total collection of functions in these individual libraries. The
<code>JavaExtensionLibrary</code> contains the logic for binding Java extension functions
given their name and arity and the types of their arguments. The class <code>ExtensionFunctionCall</code>
contains the run-time logic for converting XPath values to the required Java types, and for converting
the result back to an XPath value.</p>
<p>These classes, although public, will not normally be used directly by user-written
Java applications.</p>
<hr>
<p align="center"><i>Michael H. Kay<br/>
Saxonica Limited<br/>
9 February 2005</i></p>
<P>
<P>
<DL>
</DL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/expr/sort/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../net/sf/saxon/functions/regex/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/functions/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
