<!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:47:43 GMT 2011 --> <TITLE> CoercedFunction </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="CoercedFunction"; } } </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="../../../../com/saxonica/functions/hof/AbstractFunctionItem.html" title="class in com.saxonica.functions.hof"><B>PREV CLASS</B></A> <A HREF="../../../../com/saxonica/functions/hof/CurriedFunction.html" title="class in com.saxonica.functions.hof"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/saxonica/functions/hof/CoercedFunction.html" target="_top"><B>FRAMES</B></A> <A HREF="CoercedFunction.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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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"> com.saxonica.functions.hof</FONT> <BR> Class CoercedFunction</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 "><A HREF="../../../../com/saxonica/functions/hof/AbstractFunctionItem.html" title="class in com.saxonica.functions.hof">com.saxonica.functions.hof.AbstractFunctionItem</A> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.saxonica.functions.hof.CoercedFunction</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../net/sf/saxon/evpull/PullEvent.html" title="interface in net.sf.saxon.evpull">PullEvent</A>, <A HREF="../../../../net/sf/saxon/om/FunctionItem.html" title="interface in net.sf.saxon.om">FunctionItem</A>, <A HREF="../../../../net/sf/saxon/om/Item.html" title="interface in net.sf.saxon.om">Item</A>, <A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A></DD> </DL> <HR> <DL> <DT><PRE>public class <B>CoercedFunction</B><DT>extends <A HREF="../../../../com/saxonica/functions/hof/AbstractFunctionItem.html" title="class in com.saxonica.functions.hof">AbstractFunctionItem</A></DL> </PRE> <P> A function item obtained by coercing a supplied function; this adds a wrapper to perform dynamic type checking of the arguments in any call, and type checking of the result. <P> <P> <HR> <P> <!-- =========== 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> </TABLE> <A NAME="fields_inherited_from_class_net.sf.saxon.om.ValueRepresentation"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Fields inherited from interface net.sf.saxon.om.<A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html" title="interface in net.sf.saxon.om">ValueRepresentation</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../net/sf/saxon/om/ValueRepresentation.html#EMPTY_VALUE_ARRAY">EMPTY_VALUE_ARRAY</A></CODE></TD> </TR> </TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_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>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/hof/CoercedFunction.html#CoercedFunction(net.sf.saxon.om.FunctionItem)">CoercedFunction</A></B>(<A HREF="../../../../net/sf/saxon/om/FunctionItem.html" title="interface in net.sf.saxon.om">FunctionItem</A> targetFunction)</CODE> <BR> Create a CoercedFunction as a wrapper around a target function</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 <A HREF="../../../../com/saxonica/functions/hof/CoercedFunction.html" title="class in com.saxonica.functions.hof">CoercedFunction</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/hof/CoercedFunction.html#coerce(net.sf.saxon.om.FunctionItem, com.saxonica.functions.hof.FunctionType, net.sf.saxon.expr.parser.RoleLocator, net.sf.saxon.TypeCheckerEnvironment)">coerce</A></B>(<A HREF="../../../../net/sf/saxon/om/FunctionItem.html" title="interface in net.sf.saxon.om">FunctionItem</A> suppliedFunction, <A HREF="../../../../com/saxonica/functions/hof/FunctionType.html" title="class in com.saxonica.functions.hof">FunctionType</A> requiredType, <A HREF="../../../../net/sf/saxon/expr/parser/RoleLocator.html" title="class in net.sf.saxon.expr.parser">RoleLocator</A> role, <A HREF="../../../../net/sf/saxon/TypeCheckerEnvironment.html" title="interface in net.sf.saxon">TypeCheckerEnvironment</A> visitor)</CODE> <BR> Factory method to create a CoercedFunction with a given type, for a given targetFunction.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/hof/CoercedFunction.html#getArity()">getArity</A></B>()</CODE> <BR> Get the arity of the function</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/type/FunctionItemType.html" title="interface in net.sf.saxon.type">FunctionItemType</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/hof/CoercedFunction.html#getFunctionItemType(net.sf.saxon.type.TypeHierarchy)">getFunctionItemType</A></B>(<A HREF="../../../../net/sf/saxon/type/TypeHierarchy.html" title="class in net.sf.saxon.type">TypeHierarchy</A> th)</CODE> <BR> Get the item type of the function item</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/om/StructuredQName.html" title="class in net.sf.saxon.om">StructuredQName</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/hof/CoercedFunction.html#getFunctionName()">getFunctionName</A></B>()</CODE> <BR> Get the name of the function, or null if it is anonymous</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/om/SequenceIterator.html" title="interface in net.sf.saxon.om">SequenceIterator</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/hof/CoercedFunction.html#invoke(net.sf.saxon.om.SequenceIterator[], net.sf.saxon.expr.XPathContext)">invoke</A></B>(<A HREF="../../../../net/sf/saxon/om/SequenceIterator.html" title="interface in net.sf.saxon.om">SequenceIterator</A>[] args, <A HREF="../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context)</CODE> <BR> Invoke the function</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/hof/CoercedFunction.html#setArgumentConverter(int, net.sf.saxon.expr.Expression)">setArgumentConverter</A></B>(int arg, <A HREF="../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> converter)</CODE> <BR> Set the argument converter for one argument</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/hof/CoercedFunction.html#setResultConverter(net.sf.saxon.expr.Expression)">setResultConverter</A></B>(<A HREF="../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> converter)</CODE> <BR> Set the converter used to process the returned value</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../com/saxonica/functions/hof/CoercedFunction.html#setStackFrameMap(net.sf.saxon.expr.instruct.SlotManager)">setStackFrameMap</A></B>(<A HREF="../../../../net/sf/saxon/expr/instruct/SlotManager.html" title="class in net.sf.saxon.expr.instruct">SlotManager</A> stackFrame)</CODE> <BR> Set the stack frame map identifying the arguments for conversion</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_com.saxonica.functions.hof.AbstractFunctionItem"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class com.saxonica.functions.hof.<A HREF="../../../../com/saxonica/functions/hof/AbstractFunctionItem.html" title="class in com.saxonica.functions.hof">AbstractFunctionItem</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../com/saxonica/functions/hof/AbstractFunctionItem.html#bind(net.sf.saxon.om.StructuredQName, int, net.sf.saxon.expr.StaticContext, net.sf.saxon.expr.Container)">bind</A>, <A HREF="../../../../com/saxonica/functions/hof/AbstractFunctionItem.html#curry(net.sf.saxon.om.ValueRepresentation[])">curry</A>, <A HREF="../../../../com/saxonica/functions/hof/AbstractFunctionItem.html#deepEquals(net.sf.saxon.om.FunctionItem, net.sf.saxon.expr.XPathContext, net.sf.saxon.expr.sort.GenericAtomicComparer, int)">deepEquals</A>, <A HREF="../../../../com/saxonica/functions/hof/AbstractFunctionItem.html#explain(net.sf.saxon.trace.ExpressionPresenter)">explain</A>, <A HREF="../../../../com/saxonica/functions/hof/AbstractFunctionItem.html#getStringValue()">getStringValue</A>, <A HREF="../../../../com/saxonica/functions/hof/AbstractFunctionItem.html#getStringValueCS()">getStringValueCS</A>, <A HREF="../../../../com/saxonica/functions/hof/AbstractFunctionItem.html#getTypedValue()">getTypedValue</A>, <A HREF="../../../../com/saxonica/functions/hof/AbstractFunctionItem.html#optimize(net.sf.saxon.expr.parser.ExpressionVisitor, net.sf.saxon.expr.parser.ExpressionVisitor.ContextItemType)">optimize</A>, <A HREF="../../../../com/saxonica/functions/hof/AbstractFunctionItem.html#simplify(net.sf.saxon.expr.parser.ExpressionVisitor)">simplify</A>, <A HREF="../../../../com/saxonica/functions/hof/AbstractFunctionItem.html#typeCheck(net.sf.saxon.expr.parser.ExpressionVisitor, net.sf.saxon.expr.parser.ExpressionVisitor.ContextItemType)">typeCheck</A></CODE></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> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_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>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="CoercedFunction(net.sf.saxon.om.FunctionItem)"><!-- --></A><H3> CoercedFunction</H3> <PRE> public <B>CoercedFunction</B>(<A HREF="../../../../net/sf/saxon/om/FunctionItem.html" title="interface in net.sf.saxon.om">FunctionItem</A> targetFunction)</PRE> <DL> <DD>Create a CoercedFunction as a wrapper around a target function <P> <DL> <DT><B>Parameters:</B><DD><CODE>targetFunction</CODE> - the function to be wrapped by a type-checking layer</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="setArgumentConverter(int, net.sf.saxon.expr.Expression)"><!-- --></A><H3> setArgumentConverter</H3> <PRE> public void <B>setArgumentConverter</B>(int arg, <A HREF="../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> converter)</PRE> <DL> <DD>Set the argument converter for one argument <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>arg</CODE> - identifies the argument to be converted<DD><CODE>converter</CODE> - the expression used to perform the conversion</DL> </DD> </DL> <HR> <A NAME="setResultConverter(net.sf.saxon.expr.Expression)"><!-- --></A><H3> setResultConverter</H3> <PRE> public void <B>setResultConverter</B>(<A HREF="../../../../net/sf/saxon/expr/Expression.html" title="class in net.sf.saxon.expr">Expression</A> converter)</PRE> <DL> <DD>Set the converter used to process the returned value <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>converter</CODE> - the expression used to perform the conversion</DL> </DD> </DL> <HR> <A NAME="setStackFrameMap(net.sf.saxon.expr.instruct.SlotManager)"><!-- --></A><H3> setStackFrameMap</H3> <PRE> public void <B>setStackFrameMap</B>(<A HREF="../../../../net/sf/saxon/expr/instruct/SlotManager.html" title="class in net.sf.saxon.expr.instruct">SlotManager</A> stackFrame)</PRE> <DL> <DD>Set the stack frame map identifying the arguments for conversion <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>stackFrame</CODE> - </DL> </DD> </DL> <HR> <A NAME="getFunctionItemType(net.sf.saxon.type.TypeHierarchy)"><!-- --></A><H3> getFunctionItemType</H3> <PRE> public <A HREF="../../../../net/sf/saxon/type/FunctionItemType.html" title="interface in net.sf.saxon.type">FunctionItemType</A> <B>getFunctionItemType</B>(<A HREF="../../../../net/sf/saxon/type/TypeHierarchy.html" title="class in net.sf.saxon.type">TypeHierarchy</A> th)</PRE> <DL> <DD>Get the item type of the function item <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>th</CODE> - <DT><B>Returns:</B><DD>the function item's type</DL> </DD> </DL> <HR> <A NAME="getFunctionName()"><!-- --></A><H3> getFunctionName</H3> <PRE> public <A HREF="../../../../net/sf/saxon/om/StructuredQName.html" title="class in net.sf.saxon.om">StructuredQName</A> <B>getFunctionName</B>()</PRE> <DL> <DD>Get the name of the function, or null if it is anonymous <P> <DD><DL> <DT><B>Returns:</B><DD>null indicating that this is an anonymous inline function</DL> </DD> </DL> <HR> <A NAME="getArity()"><!-- --></A><H3> getArity</H3> <PRE> public int <B>getArity</B>()</PRE> <DL> <DD>Get the arity of the function <P> <DD><DL> <DT><B>Returns:</B><DD>the number of arguments in the function signature</DL> </DD> </DL> <HR> <A NAME="invoke(net.sf.saxon.om.SequenceIterator[], net.sf.saxon.expr.XPathContext)"><!-- --></A><H3> invoke</H3> <PRE> public <A HREF="../../../../net/sf/saxon/om/SequenceIterator.html" title="interface in net.sf.saxon.om">SequenceIterator</A> <B>invoke</B>(<A HREF="../../../../net/sf/saxon/om/SequenceIterator.html" title="interface in net.sf.saxon.om">SequenceIterator</A>[] args, <A HREF="../../../../net/sf/saxon/expr/XPathContext.html" title="interface in net.sf.saxon.expr">XPathContext</A> context) throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Invoke the function <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>args</CODE> - the actual arguments to be supplied<DD><CODE>context</CODE> - the XPath dynamic evaluation context <DT><B>Returns:</B><DD>the result of invoking the function <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE></DL> </DD> </DL> <HR> <A NAME="coerce(net.sf.saxon.om.FunctionItem, com.saxonica.functions.hof.FunctionType, net.sf.saxon.expr.parser.RoleLocator, net.sf.saxon.TypeCheckerEnvironment)"><!-- --></A><H3> coerce</H3> <PRE> public static <A HREF="../../../../com/saxonica/functions/hof/CoercedFunction.html" title="class in com.saxonica.functions.hof">CoercedFunction</A> <B>coerce</B>(<A HREF="../../../../net/sf/saxon/om/FunctionItem.html" title="interface in net.sf.saxon.om">FunctionItem</A> suppliedFunction, <A HREF="../../../../com/saxonica/functions/hof/FunctionType.html" title="class in com.saxonica.functions.hof">FunctionType</A> requiredType, <A HREF="../../../../net/sf/saxon/expr/parser/RoleLocator.html" title="class in net.sf.saxon.expr.parser">RoleLocator</A> role, <A HREF="../../../../net/sf/saxon/TypeCheckerEnvironment.html" title="interface in net.sf.saxon">TypeCheckerEnvironment</A> visitor) throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Factory method to create a CoercedFunction with a given type, for a given targetFunction. It is assumed that we have already established that coercion is needed <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE></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="../../../../com/saxonica/functions/hof/AbstractFunctionItem.html" title="class in com.saxonica.functions.hof"><B>PREV CLASS</B></A> <A HREF="../../../../com/saxonica/functions/hof/CurriedFunction.html" title="class in com.saxonica.functions.hof"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/saxonica/functions/hof/CoercedFunction.html" target="_top"><B>FRAMES</B></A> <A HREF="CoercedFunction.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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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>