blob: 00bfbd80ac07641c23fd147558533d11238c0b1d [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Xalan-C++ API : Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
<body>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
<hr/>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>XalanDocumentBuilder Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="XalanDocumentBuilder" --><!-- doxytag: inherits="XalanParsedSource" -->
<p>This is abstract base class designed to allow a XalanTranfomer object to use a document that is build dynamically by a user.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="XalanDocumentBuilder_8hpp_source.html">XalanDocumentBuilder.hpp</a>&gt;</code></p>
<p>Inherits <a class="el" href="classXalanParsedSource.html">XalanParsedSource</a>.</p>
<p>Inherited by <a class="el" href="classXalanDefaultDocumentBuilder.html">XalanDefaultDocumentBuilder</a>.</p>
<div class="dynheader">
Collaboration diagram for XalanDocumentBuilder:</div>
<div class="dyncontent">
<div class="center"><img src="classXalanDocumentBuilder__coll__graph.png" border="0" usemap="#XalanDocumentBuilder_coll__map" alt="Collaboration graph"/></div>
<map name="XalanDocumentBuilder_coll__map" id="XalanDocumentBuilder_coll__map">
<area shape="rect" id="node2" href="classXalanParsedSource.html" title="This is abstract base class designed to allow a XalanTranfomer object to reuse a parsed document..." alt="" coords="17,5,164,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classXalanDocumentBuilder-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li>virtual <a class="el" href="classXalanDocumentBuilder.html#adb2f35a89fdcc9f7521b4ab0f1957916">~XalanDocumentBuilder</a> ()
<li>virtual <a class="el" href="classXalanDocument.html">XalanDocument</a> * <a class="el" href="classXalanDocumentBuilder.html#a42fac9c8e61b01de8fdebcb1005abea1">getDocument</a> () const =0
<dl class="el"><dd class="mdescRight">Get a pointer to the <a class="el" href="classXalanDocument.html">XalanDocument</a> instance for the source document. <a href="#a42fac9c8e61b01de8fdebcb1005abea1"></a><br/></dl><li>virtual <a class="el" href="classXalanParsedSourceHelper.html">XalanParsedSourceHelper</a> * <a class="el" href="classXalanDocumentBuilder.html#af3990eb275f94568a7370f95c6d71dc8">createHelper</a> (MemoryManager &amp;theManager=XalanMemMgrs::getDefaultXercesMemMgr()) const =0
<dl class="el"><dd class="mdescRight">Create the appropriate <a class="el" href="classXalanParsedSourceHelper.html">XalanParsedSourceHelper</a> instance to use for transforming with the instance. <a href="#af3990eb275f94568a7370f95c6d71dc8"></a><br/></dl><li>virtual const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <a class="el" href="classXalanDocumentBuilder.html#a3cdc1e7151b3af7f85e97baf84273749">getURI</a> () const =0
<dl class="el"><dd class="mdescRight">Get the URI for the parsed source, if any. <a href="#a3cdc1e7151b3af7f85e97baf84273749"></a><br/></dl><li>virtual <a class="el" href="XalanSourceTreeContentHandler_8hpp.html#a351ef962c5ad92470b7b738e076fab0d">ContentHandlerType</a> * <a class="el" href="classXalanDocumentBuilder.html#a230e5d038ff0f3ef97082e03bed46fc5">getContentHandler</a> ()=0
<li>virtual <a class="el" href="XalanSourceTreeContentHandler_8hpp.html#a5918519b41f420895042c28deb6377cb">DTDHandlerType</a> * <a class="el" href="classXalanDocumentBuilder.html#a1ea46b8e51df61c0852dd29ab42ff7e2">getDTDHandler</a> ()=0
<li>virtual <a class="el" href="XalanSourceTreeContentHandler_8hpp.html#ab0b8f7602fb055023de4b7ebb3c9f085">LexicalHandlerType</a> * <a class="el" href="classXalanDocumentBuilder.html#a5d5ee4ce6eb1c91383f53b8b84cd8466">getLexicalHandler</a> ()=0
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This is abstract base class designed to allow a XalanTranfomer object to use a document that is build dynamically by a user. </p>
<p>Definition at line <a class="el" href="XalanDocumentBuilder_8hpp_source.html#l00060">60</a> of file <a class="el" href="XalanDocumentBuilder_8hpp_source.html">XalanDocumentBuilder.hpp</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="adb2f35a89fdcc9f7521b4ab0f1957916"></a><!-- doxytag: member="XalanDocumentBuilder::~XalanDocumentBuilder" ref="adb2f35a89fdcc9f7521b4ab0f1957916" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual XalanDocumentBuilder::~XalanDocumentBuilder </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XalanDocumentBuilder_8hpp_source.html#l00065">65</a> of file <a class="el" href="XalanDocumentBuilder_8hpp_source.html">XalanDocumentBuilder.hpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af3990eb275f94568a7370f95c6d71dc8"></a><!-- doxytag: member="XalanDocumentBuilder::createHelper" ref="af3990eb275f94568a7370f95c6d71dc8" args="(MemoryManager &amp;theManager=XalanMemMgrs::getDefaultXercesMemMgr()) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXalanParsedSourceHelper.html">XalanParsedSourceHelper</a>* XalanDocumentBuilder::createHelper </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em> = <code>XalanMemMgrs::getDefaultXercesMemMgr()</code></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create the appropriate <a class="el" href="classXalanParsedSourceHelper.html">XalanParsedSourceHelper</a> instance to use for transforming with the instance. </p>
<p>The caller is responsible for deleting the object when finished.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to a <a class="el" href="classXalanParsedSourceHelper.html">XalanParsedSourceHelper</a> instance. </dd></dl>
<p>Implements <a class="el" href="classXalanParsedSource.html#a5c90753ed59f26fc40076522ea5eb516">XalanParsedSource</a>.</p>
<p>Implemented in <a class="el" href="classXalanDefaultDocumentBuilder.html#a75fd2d329f6c8c3a1d28ef7c7d647b1a">XalanDefaultDocumentBuilder</a>.</p>
</div>
</div>
<a class="anchor" id="a230e5d038ff0f3ef97082e03bed46fc5"></a><!-- doxytag: member="XalanDocumentBuilder::getContentHandler" ref="a230e5d038ff0f3ef97082e03bed46fc5" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="XalanSourceTreeContentHandler_8hpp.html#a351ef962c5ad92470b7b738e076fab0d">ContentHandlerType</a>* XalanDocumentBuilder::getContentHandler </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implemented in <a class="el" href="classXalanDefaultDocumentBuilder.html#af90aa816060acab1b4579b025733aee2">XalanDefaultDocumentBuilder</a>.</p>
</div>
</div>
<a class="anchor" id="a42fac9c8e61b01de8fdebcb1005abea1"></a><!-- doxytag: member="XalanDocumentBuilder::getDocument" ref="a42fac9c8e61b01de8fdebcb1005abea1" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXalanDocument.html">XalanDocument</a>* XalanDocumentBuilder::getDocument </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a pointer to the <a class="el" href="classXalanDocument.html">XalanDocument</a> instance for the source document. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to a <a class="el" href="classXalanDocument.html">XalanDocument</a> instance. </dd></dl>
<p>Implements <a class="el" href="classXalanParsedSource.html#ac6303b0eb9aab58f4c801f379c34bc16">XalanParsedSource</a>.</p>
<p>Implemented in <a class="el" href="classXalanDefaultDocumentBuilder.html#a328d5c40d2b58b644b81d75aa06ae928">XalanDefaultDocumentBuilder</a>.</p>
</div>
</div>
<a class="anchor" id="a1ea46b8e51df61c0852dd29ab42ff7e2"></a><!-- doxytag: member="XalanDocumentBuilder::getDTDHandler" ref="a1ea46b8e51df61c0852dd29ab42ff7e2" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="XalanSourceTreeContentHandler_8hpp.html#a5918519b41f420895042c28deb6377cb">DTDHandlerType</a>* XalanDocumentBuilder::getDTDHandler </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implemented in <a class="el" href="classXalanDefaultDocumentBuilder.html#a494d8ad95fd72084def3706300bc486a">XalanDefaultDocumentBuilder</a>.</p>
</div>
</div>
<a class="anchor" id="a5d5ee4ce6eb1c91383f53b8b84cd8466"></a><!-- doxytag: member="XalanDocumentBuilder::getLexicalHandler" ref="a5d5ee4ce6eb1c91383f53b8b84cd8466" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="XalanSourceTreeContentHandler_8hpp.html#ab0b8f7602fb055023de4b7ebb3c9f085">LexicalHandlerType</a>* XalanDocumentBuilder::getLexicalHandler </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implemented in <a class="el" href="classXalanDefaultDocumentBuilder.html#ad49da6d5174e80065fe2dba104471cba">XalanDefaultDocumentBuilder</a>.</p>
</div>
</div>
<a class="anchor" id="a3cdc1e7151b3af7f85e97baf84273749"></a><!-- doxytag: member="XalanDocumentBuilder::getURI" ref="a3cdc1e7151b3af7f85e97baf84273749" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>&amp; XalanDocumentBuilder::getURI </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the URI for the parsed source, if any. </p>
<p>use for transforming with the instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A const reference to a string containing the URI </dd></dl>
<p>Implements <a class="el" href="classXalanParsedSource.html#a912e81606260833506206cf60eed9c44">XalanParsedSource</a>.</p>
<p>Implemented in <a class="el" href="classXalanDefaultDocumentBuilder.html#a296f895d77405d5bb4609c9bbcc58715">XalanDefaultDocumentBuilder</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XalanDocumentBuilder_8hpp_source.html">XalanDocumentBuilder.hpp</a></li>
</ul>
</div>
<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><a href="http://www.doxygen.org/">Doxygen</a> and
<a href="http://www.graphviz.org/">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="80%">
<tr>
<td width="80%" valign="top">
<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
All Rights Reserved.</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
</td>
</tr>
</table>
</body>
</html>