<!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:47 GMT 2011 -->
<TITLE>
com.saxonica.functions.extfn
</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="com.saxonica.functions.extfn";
}
}
</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="../../../../com/saxonica/functions/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../com/saxonica/functions/hof/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/saxonica/functions/extfn/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 com.saxonica.functions.extfn
</H2>
The package <code>com.saxonica.extfn</code> contains implementations of extension
functions in the Saxon namespace.
<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>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/AnalyzeStringFunction.html" title="class in com.saxonica.functions.extfn">AnalyzeStringFunction</A></B></TD>
<TD>This class implements the extension function saxon:analyze-string().</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/CompileQuery.html" title="class in com.saxonica.functions.extfn">CompileQuery</A></B></TD>
<TD>This class implements the saxon:compile-query() extension function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/CompileStylesheet.html" title="class in com.saxonica.functions.extfn">CompileStylesheet</A></B></TD>
<TD>This class implements the saxon:compile-stylesheet() extension function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/DeepEqual.html" title="class in com.saxonica.functions.extfn">DeepEqual</A></B></TD>
<TD>Implements the saxon:deep-equal() function, a variant of fn:deep-equal that provides
additional control over how the comparison is performed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Deref.html" title="class in com.saxonica.functions.extfn">Deref</A></B></TD>
<TD>This class implements the extension function saxon:ref().</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/DynamicErrorInfo.html" title="class in com.saxonica.functions.extfn">DynamicErrorInfo</A></B></TD>
<TD>This class implements the extension function saxon:dynamic-error-info(), which underpins the
variables accessible within saxon:catch such as $err:code etc.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Eval.html" title="class in com.saxonica.functions.extfn">Eval</A></B></TD>
<TD>This class implements the saxon:eval() extension function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Evaluate.html" title="class in com.saxonica.functions.extfn">Evaluate</A></B></TD>
<TD>This class implements the saxon:evaluate() extension function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Evaluate.EvaluateCall.html" title="class in com.saxonica.functions.extfn">Evaluate.EvaluateCall</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Evaluate.PreparedExpression.html" title="class in com.saxonica.functions.extfn">Evaluate.PreparedExpression</A></B></TD>
<TD>Inner class PreparedExpression represents a compiled XPath expression together
with the standard variables $p1 ..</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/EvaluateNode.html" title="class in com.saxonica.functions.extfn">EvaluateNode</A></B></TD>
<TD>This class implements the saxon:evaluate-node() extension function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/ExpressionFn.html" title="class in com.saxonica.functions.extfn">ExpressionFn</A></B></TD>
<TD>This class implements the saxon:expression() extension function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Extensions.html" title="class in com.saxonica.functions.extfn">Extensions</A></B></TD>
<TD>This class implements functions that are supplied as standard with SAXON,
but which are not defined in the XSLT or XPath specifications.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/ExtraFunctionLibrary.html" title="class in com.saxonica.functions.extfn">ExtraFunctionLibrary</A></B></TD>
<TD>The ExtraFunctionLibrary represents additions to the set of Saxon vendor-supplied
extension functions that are available only with the Saxon-PE and Saxon-EE editions</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Find.html" title="class in com.saxonica.functions.extfn">Find</A></B></TD>
<TD>This class implements the extension function saxon:find, which finds a value within an indexed sequence</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/ForEachGroupFunction.html" title="class in com.saxonica.functions.extfn">ForEachGroupFunction</A></B></TD>
<TD>This class implements the extension function saxon:for-each-group().</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/GeneralFilterFunction.html" title="class in com.saxonica.functions.extfn">GeneralFilterFunction</A></B></TD>
<TD>This class provides an abstract framework for a collection of extension functions that have the
same general characteristics: (a) the first argument is a sequence, (b) the result is a subset/rearrangement
of that sequence, (d) the second argument is a single argument function that is applied to the members
of the sequence, (e) the default function if the second argument is omitted is fn:data(),
(e) the processing may depend on the default collation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/GeneralFilterFunction.GeneralFilterFunctionCall.html" title="class in com.saxonica.functions.extfn">GeneralFilterFunction.GeneralFilterFunctionCall</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Highest.html" title="class in com.saxonica.functions.extfn">Highest</A></B></TD>
<TD>This class implements the saxon:highest() extension function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/HighestOrLowest.html" title="class in com.saxonica.functions.extfn">HighestOrLowest</A></B></TD>
<TD>This class implements the saxon:highest() and saxon:lowest() extension functions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Index.html" title="class in com.saxonica.functions.extfn">Index</A></B></TD>
<TD>This class supports the extension function saxon:index, which returns an indexed sequence</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/LastModified.html" title="class in com.saxonica.functions.extfn">LastModified</A></B></TD>
<TD>Extension function to determined the last-modified date of a file</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Leading.html" title="class in com.saxonica.functions.extfn">Leading</A></B></TD>
<TD>This class implements the saxon:leading() extension functions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Lowest.html" title="class in com.saxonica.functions.extfn">Lowest</A></B></TD>
<TD>This class implements the saxon:lowest() extension function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Parse.html" title="class in com.saxonica.functions.extfn">Parse</A></B></TD>
<TD>This class implements the saxon:parse() extension function,
which is specially-recognized by the system because it needs access
to parts of the static context</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Parse.ParseCall.html" title="class in com.saxonica.functions.extfn">Parse.ParseCall</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/ParseHtml.html" title="class in com.saxonica.functions.extfn">ParseHtml</A></B></TD>
<TD>Supports the saxon:parse-html() function, a variant of saxon:parse() that differs
only in that it uses the TagSoup HTML parser</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/QueryFn.html" title="class in com.saxonica.functions.extfn">QueryFn</A></B></TD>
<TD>This class implements the saxon:query() extension function</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Ref.html" title="class in com.saxonica.functions.extfn">Ref</A></B></TD>
<TD>This class implements the extension function saxon:ref().</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Serialize.html" title="class in com.saxonica.functions.extfn">Serialize</A></B></TD>
<TD>This class implements the saxon:serialize() extension function,
which is specially-recognized by the system because it needs access
to parts of the static context</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/Sort.html" title="class in com.saxonica.functions.extfn">Sort</A></B></TD>
<TD>This class implements the saxon:sort() extension functions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/SubsequenceTestFn.html" title="class in com.saxonica.functions.extfn">SubsequenceTestFn</A></B></TD>
<TD>Abstract class providing functionality common to functions saxon:subsequence-before,
saxon:subsequence-after etc;
contains the concrete implementations of these functions as inner subclasses</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/SubsequenceTestFn.SubsequenceAfterFn.html" title="class in com.saxonica.functions.extfn">SubsequenceTestFn.SubsequenceAfterFn</A></B></TD>
<TD>Implement saxon:subsequence-after</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/SubsequenceTestFn.SubsequenceBeforeFn.html" title="class in com.saxonica.functions.extfn">SubsequenceTestFn.SubsequenceBeforeFn</A></B></TD>
<TD>Implement saxon:subsequence-before</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/SubsequenceTestFn.SubsequenceFromFn.html" title="class in com.saxonica.functions.extfn">SubsequenceTestFn.SubsequenceFromFn</A></B></TD>
<TD>Implement saxon:subsequence-from</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/SubsequenceTestFn.SubsequenceUntilFn.html" title="class in com.saxonica.functions.extfn">SubsequenceTestFn.SubsequenceUntilFn</A></B></TD>
<TD>Implement saxon:subsequence-until</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../com/saxonica/functions/extfn/TransformFn.html" title="class in com.saxonica.functions.extfn">TransformFn</A></B></TD>
<TD>This class implements the saxon:transform() extension function</TD>
</TR>
</TABLE>
<P>
<A NAME="package_description"><!-- --></A><H2>
Package com.saxonica.functions.extfn Description
</H2>
<P>
<p>The package <code>com.saxonica.extfn</code> contains implementations of extension
functions in the Saxon namespace.</p>
<p>It also contains the class <code>ExtraFunctionLibrary</code> which acts as a factory class for
generating instances of these extension functions</p>
<p>Most of these classes are implemented using the new "integrated extension function" mechanism
introduced in Saxon 9.2. A few still use the reflection mechanism, these are in class
<code>com.saxonica.extfn.Extensions</code>.</p>
<p align="center"><i>Michael H. Kay<br/>
Saxonica Limited<br/>
12 June 2009</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="../../../../com/saxonica/functions/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../com/saxonica/functions/hof/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/saxonica/functions/extfn/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>
