Google Git
Sign in
apache / xalan-site / 4279effacee2ebacf30f00b46c22db2aacb59b72 / . / old / xalan-c / apiDocs / classExtensionNSHandler.html
blob: d6fe449a5d9fa12844ad0e684fdec87bb87d8b51 [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ExtensionNSHandler Class Reference</h1><code>#include &lt;<a class="el" href="ExtensionNSHandler_8hpp-source.html">ExtensionNSHandler.hpp</a>&gt;</code>
<p>
Inheritance diagram for ExtensionNSHandler:<p><center><img src="classExtensionNSHandler__inherit__graph.gif" border="0" usemap="#ExtensionNSHandler_inherit_map" alt="Inheritance graph"></center>
<map name="ExtensionNSHandler_inherit_map">
<area href="classExtensionFunctionHandler.html" shape="rect" coords="6,42,172,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for ExtensionNSHandler:<p><center><img src="classExtensionNSHandler__coll__graph.gif" border="0" usemap="#ExtensionNSHandler_coll_map" alt="Collaboration graph"></center>
<map name="ExtensionNSHandler_coll_map">
<area href="classExtensionFunctionHandler.html" shape="rect" coords="194,474,360,450">
<area href="classXalanSet.html" shape="rect" coords="6,341,201,317">
<area href="classXalanMap.html" shape="rect" coords="6,250,201,226">
<area href="classXalanList.html" shape="rect" coords="41,146,166,122">
<area href="structXalanList_1_1Node.html" shape="rect" coords="52,42,156,18">
<area href="classXalanDOMString.html" shape="rect" coords="225,341,342,317">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classExtensionNSHandler-members.html">List of all members.</a><h2>Public Methods</h2>
<ul>
<li><a class="el" href="classExtensionNSHandler.html#a0">ExtensionNSHandler</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;namespaceUri, <a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager)
<dl class="el"><dd><font size=-1><em>Construct a new extension namespace handler for a given extension NS.</em> <a href="#a0">More...</a><em><br><br></em></font></dl><li><a class="el" href="classExtensionNSHandler.html#a1">ExtensionNSHandler</a> (<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;namespaceUri, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;elemNames, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;funcNames, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;lang, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;srcURL, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;src)
<dl class="el"><dd><font size=-1><em>Construct a new extension namespace handler given all the information needed.</em> <a href="#a1">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classExtensionNSHandler.html#a2">setFunctions</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;funcNames)
<dl class="el"><dd><font size=-1><em>Set function local parts of extension NS.</em> <a href="#a2">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classExtensionNSHandler.html#a3">setScript</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;lang, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;srcURL, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;scriptSrc)
<dl class="el"><dd><font size=-1><em>Set the script data for this extension NS.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classExtensionNSHandler.html#a4">setElements</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;elemNames)
<dl class="el"><dd><font size=-1><em>Set element local parts of extension NS.</em> <a href="#a4">More...</a><em><br><br></em></font></dl><li>bool <a class="el" href="classExtensionNSHandler.html#a5">isElementAvailable</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;element) const
<dl class="el"><dd><font size=-1><em>Tests whether a certain element name is known within this namespace.</em> <a href="#a5">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classExtensionNSHandler.html#a6">processElement</a> (<a class="el" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a> &amp;executionContext, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;localPart, const <a class="el" href="classXalanElement.html">XalanElement</a> *element, <a class="el" href="ExtensionNSHandler_8hpp.html#a1">Stylesheet</a> &amp;stylesheetTree, const <a class="el" href="classXalanNode.html">XalanNode</a> *sourceTree, const <a class="el" href="classXalanNode.html">XalanNode</a> *sourceNode, const <a class="el" href="classXalanQName.html">XalanQName</a> &amp;mode)
<dl class="el"><dd><font size=-1><em>Process a call to this extension namespace via an element.</em> <a href="#a6">More...</a><em><br><br></em></font></dl></ul>
<h2>Static Public Methods</h2>
<ul>
<li>ExtensionNSHandler* <a class="el" href="classExtensionNSHandler.html#d0">create</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;namespaceUri, <a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager)
</ul>
<h2>Protected Methods</h2>
<ul>
<li>virtual void <a class="el" href="classExtensionNSHandler.html#b0">startupComponent</a> ()
<dl class="el"><dd><font size=-1><em>Start the component up by executing any script that needs to run at startup time.</em> <a href="#b0">More...</a><em><br><br></em></font></dl></ul>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="ExtensionNSHandler::ExtensionNSHandler"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
ExtensionNSHandler::ExtensionNSHandler (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>namespaceUri</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Construct a new extension namespace handler for a given extension NS.
<p>
This doesn't do anything - just hang on to the namespace URI.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>namespaceUri</em>
&nbsp;</td><td>
extension namespace URI being implemented </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="ExtensionNSHandler::ExtensionNSHandler"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
ExtensionNSHandler::ExtensionNSHandler (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>namespaceUri</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>elemNames</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>funcNames</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>lang</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>srcURL</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>src</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Construct a new extension namespace handler given all the information needed.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>namespaceUri</em>
&nbsp;</td><td>
extension namespace URI being implemented </td></tr>
<tr><td valign=top><em>elemNames</em>
&nbsp;</td><td>
string containing list of elements of extension NS </td></tr>
<tr><td valign=top><em>funcNames</em>
&nbsp;</td><td>
string containing list of functions of extension NS </td></tr>
<tr><td valign=top><em>lang</em>
&nbsp;</td><td>
language of code implementing the extension </td></tr>
<tr><td valign=top><em>srcURL</em>
&nbsp;</td><td>
value of src attribute (if any) - treated as a URL or a classname depending on the value of lang. If srcURL is not null, then scriptSrc is ignored. </td></tr>
<tr><td valign=top><em>scriptSrc</em>
&nbsp;</td><td>
the actual script code (if any) </td></tr>
</table>
</dl> </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="d0" doxytag="ExtensionNSHandler::create"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
ExtensionNSHandler * ExtensionNSHandler::create (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>namespaceUri</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>&nbsp;)<code> [static]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a5" doxytag="ExtensionNSHandler::isElementAvailable"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool ExtensionNSHandler::isElementAvailable (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>element</em>&nbsp;) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Tests whether a certain element name is known within this namespace.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>element</em>
&nbsp;</td><td>
name of the element being tested </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if known, false if not </dl> </td>
</tr>
</table>
<a name="a6" doxytag="ExtensionNSHandler::processElement"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void ExtensionNSHandler::processElement (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a> &amp; <em>executionContext</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>localPart</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanElement.html">XalanElement</a> * <em>element</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="ExtensionNSHandler_8hpp.html#a1">Stylesheet</a> &amp; <em>stylesheetTree</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanNode.html">XalanNode</a> * <em>sourceTree</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanNode.html">XalanNode</a> * <em>sourceNode</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanQName.html">XalanQName</a> &amp; <em>mode</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Process a call to this extension namespace via an element.
<p>
As a side effect, the results are sent to the <a class="el" href="classXSLTProcessor.html">XSLTProcessor</a>'s result tree.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>localPart</em>
&nbsp;</td><td>
element name's local part </td></tr>
<tr><td valign=top><em>element</em>
&nbsp;</td><td>
extension element being processed </td></tr>
<tr><td valign=top><em>stylesheetTree</em>
&nbsp;</td><td>
compiled stylesheet tree </td></tr>
<tr><td valign=top><em>mode</em>
&nbsp;</td><td>
current mode </td></tr>
<tr><td valign=top><em>sourceTree</em>
&nbsp;</td><td>
root of the source tree (but don't assume it's a document) </td></tr>
<tr><td valign=top><em>sourceNode</em>
&nbsp;</td><td>
current context node </td></tr>
</table>
</dl><dl compact><dt>
<b>Exceptions: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>XSLProcessorException</em>
&nbsp;</td><td>
thrown if something goes wrong while running the extension handler </td></tr>
<tr><td valign=top><em>MalformedURLException</em>
&nbsp;</td><td>
if loading trouble </td></tr>
<tr><td valign=top><em>FileNotFoundException</em>
&nbsp;</td><td>
if loading trouble </td></tr>
<tr><td valign=top><em>IOException</em>
&nbsp;</td><td>
if loading trouble </td></tr>
<tr><td valign=top><em>SAXException</em>
&nbsp;</td><td>
if parsing trouble </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a4" doxytag="ExtensionNSHandler::setElements"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void ExtensionNSHandler::setElements (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>elemNames</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set element local parts of extension NS.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>elemNames</em>
&nbsp;</td><td>
whitespace separated list of element names defined by this extension namespace </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a2" doxytag="ExtensionNSHandler::setFunctions"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void ExtensionNSHandler::setFunctions (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>funcNames</em>&nbsp;)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set function local parts of extension NS.
<p>
Super does the work; I just record that a component desc has been loaded.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>functions</em>
&nbsp;</td><td>
whitespace separated list of function names defined by this extension namespace </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classExtensionFunctionHandler.html#a4">ExtensionFunctionHandler</a>. </td>
</tr>
</table>
<a name="a3" doxytag="ExtensionNSHandler::setScript"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void ExtensionNSHandler::setScript (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>lang</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>srcURL</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>scriptSrc</em>&nbsp;)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the script data for this extension NS.
<p>
Deferred to super for actual work - only record that a component desc has been loaded.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>lang</em>
&nbsp;</td><td>
language of the script </td></tr>
<tr><td valign=top><em>srcURL</em>
&nbsp;</td><td>
value of src attribute (if any) - treated as a URL or a classname depending on the value of lang. If srcURL is not null, then scriptSrc is ignored. </td></tr>
<tr><td valign=top><em>scriptSrc</em>
&nbsp;</td><td>
the actual script code (if any) </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classExtensionFunctionHandler.html#a5">ExtensionFunctionHandler</a>. </td>
</tr>
</table>
<a name="b0" doxytag="ExtensionNSHandler::startupComponent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void ExtensionNSHandler::startupComponent (
</b></td>
<td valign="bottom"><b>
)<code> [protected, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Start the component up by executing any script that needs to run at startup time.
<p>
This needs to happen before any functions can be called on the component.
<p>
Reimplemented from <a class="el" href="classExtensionFunctionHandler.html#b0">ExtensionFunctionHandler</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ExtensionNSHandler_8hpp-source.html">ExtensionNSHandler.hpp</a></ul>
<p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">GraphViz</A> are used to generate this API documentation from the Xalan-C header files.</I></FONT></p>
<TABLE border="0" cellpadding="0" cellspacing="0" width="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="80%">
<TR>
<TD WIDTH="80%" VALIGN="TOP">
<P ALIGN="CENTER"><B>Xalan-C++ XSLT Processor Version 1.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>