<!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:36 GMT 2011 --> <TITLE> XPathStaticContext </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="XPathStaticContext"; } } </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/sxpath/XPathExpression.html" title="class in net.sf.saxon.sxpath"><B>PREV CLASS</B></A> <A HREF="../../../../net/sf/saxon/sxpath/XPathVariable.html" title="class in net.sf.saxon.sxpath"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/saxon/sxpath/XPathStaticContext.html" target="_top"><B>FRAMES</B></A> <A HREF="XPathStaticContext.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | 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.sxpath</FONT> <BR> Interface XPathStaticContext</H2> <DL> <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../net/sf/saxon/expr/StaticContext.html" title="interface in net.sf.saxon.expr">StaticContext</A></DD> </DL> <DL> <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../net/sf/saxon/sxpath/DedicatedStaticContext.html" title="class in net.sf.saxon.sxpath">DedicatedStaticContext</A>, <A HREF="../../../../net/sf/saxon/sxpath/IndependentContext.html" title="class in net.sf.saxon.sxpath">IndependentContext</A>, <A HREF="../../../../com/saxonica/schema/sdoc/SchemaElement.XPathStaticContext.html" title="class in com.saxonica.schema.sdoc">SchemaElement.XPathStaticContext</A></DD> </DL> <HR> <DL> <DT><PRE>public interface <B>XPathStaticContext</B><DT>extends <A HREF="../../../../net/sf/saxon/expr/StaticContext.html" title="interface in net.sf.saxon.expr">StaticContext</A></DL> </PRE> <P> This interface defines methods that must be provided when Saxon's free-standing XPath API is used. The default implementation of this interface is <A HREF="../../../../net/sf/saxon/sxpath/IndependentContext.html" title="class in net.sf.saxon.sxpath"><CODE>IndependentContext</CODE></A>, and that implementation should be adequate for most purposes; but for extra customization, a user-written implementation of this interface may be used instead. <P> <P> <HR> <P> <!-- ========== 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> <A HREF="../../../../net/sf/saxon/sxpath/XPathVariable.html" title="class in net.sf.saxon.sxpath">XPathVariable</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/sxpath/XPathStaticContext.html#declareVariable(net.sf.saxon.value.QNameValue)">declareVariable</A></B>(<A HREF="../../../../net/sf/saxon/value/QNameValue.html" title="class in net.sf.saxon.value">QNameValue</A> qname)</CODE> <BR> Declare a variable.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/sxpath/XPathVariable.html" title="class in net.sf.saxon.sxpath">XPathVariable</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/sxpath/XPathStaticContext.html#declareVariable(java.lang.String, java.lang.String)">declareVariable</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> namespaceURI, <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> localName)</CODE> <BR> Declare a variable.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/expr/instruct/SlotManager.html" title="class in net.sf.saxon.expr.instruct">SlotManager</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/sxpath/XPathStaticContext.html#getStackFrameMap()">getStackFrameMap</A></B>()</CODE> <BR> Get a Stack Frame Map containing definitions of all the declared variables.</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="../../../../net/sf/saxon/sxpath/XPathStaticContext.html#setDefaultElementNamespace(java.lang.String)">setDefaultElementNamespace</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> uri)</CODE> <BR> Set the default namespace for elements and types</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="../../../../net/sf/saxon/sxpath/XPathStaticContext.html#setNamespaceResolver(net.sf.saxon.om.NamespaceResolver)">setNamespaceResolver</A></B>(<A HREF="../../../../net/sf/saxon/om/NamespaceResolver.html" title="interface in net.sf.saxon.om">NamespaceResolver</A> resolver)</CODE> <BR> Set an external namespace resolver.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_net.sf.saxon.expr.StaticContext"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from interface net.sf.saxon.expr.<A HREF="../../../../net/sf/saxon/expr/StaticContext.html" title="interface in net.sf.saxon.expr">StaticContext</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../net/sf/saxon/expr/StaticContext.html#bindVariable(net.sf.saxon.om.StructuredQName)">bindVariable</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getBaseURI()">getBaseURI</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getCollation(java.lang.String)">getCollation</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getConfiguration()">getConfiguration</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getDecimalFormatManager()">getDecimalFormatManager</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getDefaultCollationName()">getDefaultCollationName</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getDefaultElementNamespace()">getDefaultElementNamespace</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getDefaultFunctionNamespace()">getDefaultFunctionNamespace</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getFunctionLibrary()">getFunctionLibrary</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getImportedSchemaNamespaces()">getImportedSchemaNamespaces</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getLineNumber()">getLineNumber</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getLocationMap()">getLocationMap</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getNamePool()">getNamePool</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getNamespaceResolver()">getNamespaceResolver</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getRequiredContextItemType()">getRequiredContextItemType</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getSystemId()">getSystemId</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getURIForPrefix(java.lang.String)">getURIForPrefix</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#getXPathLanguageLevel()">getXPathLanguageLevel</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#isAllowedBuiltInType(net.sf.saxon.type.BuiltInAtomicType)">isAllowedBuiltInType</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#isImportedSchema(java.lang.String)">isImportedSchema</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#isInBackwardsCompatibleMode()">isInBackwardsCompatibleMode</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#isSchemaAware()">isSchemaAware</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#issueWarning(java.lang.String, javax.xml.transform.SourceLocator)">issueWarning</A>, <A HREF="../../../../net/sf/saxon/expr/StaticContext.html#makeEarlyEvaluationContext()">makeEarlyEvaluationContext</A></CODE></TD> </TR> </TABLE> <P> <!-- ============ 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="setDefaultElementNamespace(java.lang.String)"><!-- --></A><H3> setDefaultElementNamespace</H3> <PRE> void <B>setDefaultElementNamespace</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> uri)</PRE> <DL> <DD>Set the default namespace for elements and types <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>uri</CODE> - The namespace to be used to qualify unprefixed element names and type names appearing in the XPath expression.</DL> </DD> </DL> <HR> <A NAME="setNamespaceResolver(net.sf.saxon.om.NamespaceResolver)"><!-- --></A><H3> setNamespaceResolver</H3> <PRE> void <B>setNamespaceResolver</B>(<A HREF="../../../../net/sf/saxon/om/NamespaceResolver.html" title="interface in net.sf.saxon.om">NamespaceResolver</A> resolver)</PRE> <DL> <DD>Set an external namespace resolver. If this is set, then all resolution of namespace prefixes is delegated to the external namespace resolver, and namespaces declared individually on this IndependentContext object are ignored. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>resolver</CODE> - the external namespace resolver</DL> </DD> </DL> <HR> <A NAME="declareVariable(net.sf.saxon.value.QNameValue)"><!-- --></A><H3> declareVariable</H3> <PRE> <A HREF="../../../../net/sf/saxon/sxpath/XPathVariable.html" title="class in net.sf.saxon.sxpath">XPathVariable</A> <B>declareVariable</B>(<A HREF="../../../../net/sf/saxon/value/QNameValue.html" title="class in net.sf.saxon.value">QNameValue</A> qname)</PRE> <DL> <DD>Declare a variable. A variable must be declared before an expression referring to it is compiled. The initial value of the variable will be the empty sequence. This method backs up the <A HREF="../../../../net/sf/saxon/sxpath/XPathEvaluator.html#declareVariable(java.lang.String, java.lang.String)"><CODE>XPathEvaluator.declareVariable(java.lang.String, java.lang.String)</CODE></A> method. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>qname</CODE> - The name of the variable <DT><B>Returns:</B><DD>a Variable object representing information about the variable that has been declared.</DL> </DD> </DL> <HR> <A NAME="declareVariable(java.lang.String, java.lang.String)"><!-- --></A><H3> declareVariable</H3> <PRE> <A HREF="../../../../net/sf/saxon/sxpath/XPathVariable.html" title="class in net.sf.saxon.sxpath">XPathVariable</A> <B>declareVariable</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> namespaceURI, <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> localName)</PRE> <DL> <DD>Declare a variable. A variable must be declared before an expression referring to it is compiled. The initial value of the variable will be the empty sequence. This method backs up the <A HREF="../../../../net/sf/saxon/sxpath/XPathEvaluator.html#declareVariable(java.lang.String, java.lang.String)"><CODE>XPathEvaluator.declareVariable(java.lang.String, java.lang.String)</CODE></A> method. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>namespaceURI</CODE> - The namespace URI of the name of the variable. Supply "" to represent names in no namespace (null is also accepted)<DD><CODE>localName</CODE> - The local part of the name of the variable (an NCName) <DT><B>Returns:</B><DD>an XPathVariable object representing information about the variable that has been declared.</DL> </DD> </DL> <HR> <A NAME="getStackFrameMap()"><!-- --></A><H3> getStackFrameMap</H3> <PRE> <A HREF="../../../../net/sf/saxon/expr/instruct/SlotManager.html" title="class in net.sf.saxon.expr.instruct">SlotManager</A> <B>getStackFrameMap</B>()</PRE> <DL> <DD>Get a Stack Frame Map containing definitions of all the declared variables. This will return a newly created object that the caller is free to modify by adding additional variables, without affecting the static context itself. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a SlotManager object holding details of the allocation of variables on the stack frame.</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/sxpath/XPathExpression.html" title="class in net.sf.saxon.sxpath"><B>PREV CLASS</B></A> <A HREF="../../../../net/sf/saxon/sxpath/XPathVariable.html" title="class in net.sf.saxon.sxpath"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/saxon/sxpath/XPathStaticContext.html" target="_top"><B>FRAMES</B></A> <A HREF="XPathStaticContext.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | 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>