<!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:18 GMT 2011 --> <TITLE> StandardFunction </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="StandardFunction"; } } </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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></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/functions/Rounding.html" title="class in net.sf.saxon.functions"><B>PREV CLASS</B></A> <A HREF="../../../../net/sf/saxon/functions/StandardFunction.Entry.html" title="class in net.sf.saxon.functions"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/saxon/functions/StandardFunction.html" target="_top"><B>FRAMES</B></A> <A HREF="StandardFunction.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> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> net.sf.saxon.functions</FONT> <BR> Class StandardFunction</H2> <PRE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.saxon.functions.StandardFunction</B> </PRE> <HR> <DL> <DT><PRE>public abstract class <B>StandardFunction</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL> </PRE> <P> This class contains static data tables defining the properties of standard functions. "Standard functions" here means the XPath 2.0 functions, the XSLT 2.0 functions, and a few selected extension functions which need special recognition. <P> <P> <HR> <P> <!-- ======== NESTED CLASS SUMMARY ======== --> <A NAME="nested_class_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Nested Class Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static class</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.Entry.html" title="class in net.sf.saxon.functions">StandardFunction.Entry</A></B></CODE> <BR> An entry in the table describing the properties of a function</TD> </TR> </TABLE> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Field Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.html#CORE">CORE</A></B></CODE> <BR> Categories of functions, bit significant</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.html#EMPTY">EMPTY</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.html#INTERNAL">INTERNAL</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected static <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.html#SAME_AS_FIRST_ARGUMENT">SAME_AS_FIRST_ARGUMENT</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.html#USE_WHEN">USE_WHEN</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.html#XPATH30">XPATH30</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.html#XQUPDATE">XQUPDATE</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.html#XSLT">XSLT</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.html#XSLT30">XSLT30</A></B></CODE> <BR> </TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.html#arg(net.sf.saxon.functions.StandardFunction.Entry, int, net.sf.saxon.type.ItemType, int, net.sf.saxon.value.Value)">arg</A></B>(<A HREF="../../../../net/sf/saxon/functions/StandardFunction.Entry.html" title="class in net.sf.saxon.functions">StandardFunction.Entry</A> e, int a, <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A> type, int cardinality, <A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A> resultIfEmpty)</CODE> <BR> Add information to a function entry about the argument types of the function</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../net/sf/saxon/functions/StandardFunction.Entry.html" title="class in net.sf.saxon.functions">StandardFunction.Entry</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.html#getFunction(java.lang.String, int)">getFunction</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, int arity)</CODE> <BR> Get the table entry for the function with a given name</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../net/sf/saxon/functions/StandardFunction.Entry.html" title="class in net.sf.saxon.functions">StandardFunction.Entry</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.html#makeEntry(java.lang.String, java.lang.Class, int, int, int, net.sf.saxon.type.ItemType, int, int)">makeEntry</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> implementationClass, int opcode, int minArguments, int maxArguments, <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A> itemType, int cardinality, int applicability)</CODE> <BR> Make a table entry describing the signature of a function, with a reference to the implementation class.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="../../../../net/sf/saxon/functions/StandardFunction.Entry.html" title="class in net.sf.saxon.functions">StandardFunction.Entry</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/functions/StandardFunction.html#register(java.lang.String, java.lang.Class, int, int, int, net.sf.saxon.type.ItemType, int, int)">register</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> implementationClass, int opcode, int minArguments, int maxArguments, <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A> itemType, int cardinality, int applicability)</CODE> <BR> Register a system function in the table of function details.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <A NAME="field_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Field Detail</B></FONT></TH> </TR> </TABLE> <A NAME="EMPTY"><!-- --></A><H3> EMPTY</H3> <PRE> public static <A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A> <B>EMPTY</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="CORE"><!-- --></A><H3> CORE</H3> <PRE> public static final int <B>CORE</B></PRE> <DL> <DD>Categories of functions, bit significant <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.functions.StandardFunction.CORE">Constant Field Values</A></DL> </DL> <HR> <A NAME="XSLT"><!-- --></A><H3> XSLT</H3> <PRE> public static final int <B>XSLT</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.functions.StandardFunction.XSLT">Constant Field Values</A></DL> </DL> <HR> <A NAME="USE_WHEN"><!-- --></A><H3> USE_WHEN</H3> <PRE> public static final int <B>USE_WHEN</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.functions.StandardFunction.USE_WHEN">Constant Field Values</A></DL> </DL> <HR> <A NAME="XQUPDATE"><!-- --></A><H3> XQUPDATE</H3> <PRE> public static final int <B>XQUPDATE</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.functions.StandardFunction.XQUPDATE">Constant Field Values</A></DL> </DL> <HR> <A NAME="XPATH30"><!-- --></A><H3> XPATH30</H3> <PRE> public static final int <B>XPATH30</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.functions.StandardFunction.XPATH30">Constant Field Values</A></DL> </DL> <HR> <A NAME="INTERNAL"><!-- --></A><H3> INTERNAL</H3> <PRE> public static final int <B>INTERNAL</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.functions.StandardFunction.INTERNAL">Constant Field Values</A></DL> </DL> <HR> <A NAME="XSLT30"><!-- --></A><H3> XSLT30</H3> <PRE> public static final int <B>XSLT30</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.functions.StandardFunction.XSLT30">Constant Field Values</A></DL> </DL> <HR> <A NAME="SAME_AS_FIRST_ARGUMENT"><!-- --></A><H3> SAME_AS_FIRST_ARGUMENT</H3> <PRE> protected static <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A> <B>SAME_AS_FIRST_ARGUMENT</B></PRE> <DL> <DL> </DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="register(java.lang.String, java.lang.Class, int, int, int, net.sf.saxon.type.ItemType, int, int)"><!-- --></A><H3> register</H3> <PRE> public static <A HREF="../../../../net/sf/saxon/functions/StandardFunction.Entry.html" title="class in net.sf.saxon.functions">StandardFunction.Entry</A> <B>register</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> implementationClass, int opcode, int minArguments, int maxArguments, <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A> itemType, int cardinality, int applicability)</PRE> <DL> <DD>Register a system function in the table of function details. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>name</CODE> - the function name<DD><CODE>implementationClass</CODE> - the class used to implement the function<DD><CODE>opcode</CODE> - identifies the function when a single class implements several functions<DD><CODE>minArguments</CODE> - the minimum number of arguments required<DD><CODE>maxArguments</CODE> - the maximum number of arguments allowed<DD><CODE>itemType</CODE> - the item type of the result of the function<DD><CODE>cardinality</CODE> - the cardinality of the result of the function<DD><CODE>applicability</CODE> - the host languages (and versions thereof) in which this function is available <DT><B>Returns:</B><DD>the entry describing the function. The entry is incomplete, it does not yet contain information about the function arguments.</DL> </DD> </DL> <HR> <A NAME="makeEntry(java.lang.String, java.lang.Class, int, int, int, net.sf.saxon.type.ItemType, int, int)"><!-- --></A><H3> makeEntry</H3> <PRE> public static <A HREF="../../../../net/sf/saxon/functions/StandardFunction.Entry.html" title="class in net.sf.saxon.functions">StandardFunction.Entry</A> <B>makeEntry</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> implementationClass, int opcode, int minArguments, int maxArguments, <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A> itemType, int cardinality, int applicability)</PRE> <DL> <DD>Make a table entry describing the signature of a function, with a reference to the implementation class. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>name</CODE> - the function name<DD><CODE>implementationClass</CODE> - the class used to implement the function<DD><CODE>opcode</CODE> - identifies the function when a single class implements several functions<DD><CODE>minArguments</CODE> - the minimum number of arguments required<DD><CODE>maxArguments</CODE> - the maximum number of arguments allowed<DD><CODE>itemType</CODE> - the item type of the result of the function<DD><CODE>cardinality</CODE> - the cardinality of the result of the function<DD><CODE>applicability</CODE> - the host languages (and versions of) in which this function is available <DT><B>Returns:</B><DD>the entry describing the function. The entry is incomplete, it does not yet contain information about the function arguments.</DL> </DD> </DL> <HR> <A NAME="arg(net.sf.saxon.functions.StandardFunction.Entry, int, net.sf.saxon.type.ItemType, int, net.sf.saxon.value.Value)"><!-- --></A><H3> arg</H3> <PRE> public static void <B>arg</B>(<A HREF="../../../../net/sf/saxon/functions/StandardFunction.Entry.html" title="class in net.sf.saxon.functions">StandardFunction.Entry</A> e, int a, <A HREF="../../../../net/sf/saxon/type/ItemType.html" title="interface in net.sf.saxon.type">ItemType</A> type, int cardinality, <A HREF="../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A> resultIfEmpty)</PRE> <DL> <DD>Add information to a function entry about the argument types of the function <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>e</CODE> - the entry for the function<DD><CODE>a</CODE> - the position of the argument, counting from zero<DD><CODE>type</CODE> - the item type of the argument<DD><CODE>cardinality</CODE> - the cardinality of the argument<DD><CODE>resultIfEmpty</CODE> - the value returned by the function if an empty sequence appears as the value of this argument, in the case when this result is unaffected by any other arguments. Supply null if this does not apply.</DL> </DD> </DL> <HR> <A NAME="getFunction(java.lang.String, int)"><!-- --></A><H3> getFunction</H3> <PRE> public static <A HREF="../../../../net/sf/saxon/functions/StandardFunction.Entry.html" title="class in net.sf.saxon.functions">StandardFunction.Entry</A> <B>getFunction</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, int arity)</PRE> <DL> <DD>Get the table entry for the function with a given name <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the function. This may be an unprefixed local-name for functions in the system namespace, or may use the conventional prefix "saxon:" in the case of Saxon extension functions that are specially recognized<DD><CODE>arity</CODE> - the number of arguments of the function <DT><B>Returns:</B><DD>if the function name is known, an Entry containing information about the function. Otherwise, null</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></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/functions/Rounding.html" title="class in net.sf.saxon.functions"><B>PREV CLASS</B></A> <A HREF="../../../../net/sf/saxon/functions/StandardFunction.Entry.html" title="class in net.sf.saxon.functions"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/saxon/functions/StandardFunction.html" target="_top"><B>FRAMES</B></A> <A HREF="StandardFunction.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> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></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>