mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/simple-api/classxercesc_1_1LocalFileInputSource.html
King_DuckZ 8c48174b5b v2.0.0
2020-02-17 22:12:51 +01:00

312 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla Simple API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</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 class="nav">
<a class="el" href="namespacexercesc.html">xercesc</a>::<a class="el" href="classxercesc_1_1LocalFileInputSource.html">LocalFileInputSource</a></div>
<h1>xercesc::LocalFileInputSource Class Reference</h1><!-- doxytag: class="xercesc::LocalFileInputSource" --><!-- doxytag: inherits="xercesc::InputSource" -->This class is a derivative of the standard <a class="el" href="classxercesc_1_1InputSource.html">InputSource</a> class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="LocalFileInputSource_8hpp-source.html">LocalFileInputSource.hpp</a>&gt;</code>
<p>
Inheritance diagram for xercesc::LocalFileInputSource:<p><center><img src="classxercesc_1_1LocalFileInputSource__inherit__graph.png" border="0" usemap="#xercesc_1_1LocalFileInputSource__inherit__map" alt="Inheritance graph"></center>
<map name="xercesc_1_1LocalFileInputSource__inherit__map">
<area href="classxercesc_1_1InputSource.html" shape="rect" coords="35,82,197,106" alt="">
<area href="classxercesc_1_1XMemory.html" shape="rect" coords="43,7,189,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classxercesc_1_1LocalFileInputSource-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Virtual methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual BinInputStream *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1LocalFileInputSource.html#b080ba29fdbc0825da80cdce64f38007">makeStream</a> () const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method will return a binary input stream derivative that will parse from the local file indicatedby the system id. <a href="#b080ba29fdbc0825da80cdce64f38007"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class is a derivative of the standard <a class="el" href="classxercesc_1_1InputSource.html">InputSource</a> class.
<p>
It provides for the parser access to data which is referenced via a local file path, as apposed to remote file or URL. This is the most efficacious mechanism by which local files can be parsed, since the parse knows that it refers to a local file and will make no other attempts to interpret the passed path.<p>
The path provided can either be a fully qualified path or a relative path. If relative, it will be completed either relative to a passed base path or relative to the current working directory of the process.<p>
As with all <a class="el" href="classxercesc_1_1InputSource.html">InputSource</a> derivatives. The primary objective of an input source is to create an input stream via which the parser can spool in data from the referenced source.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="f68596ec4e95a0ce50fa6f7de611da63"></a><!-- doxytag: member="xercesc::LocalFileInputSource::LocalFileInputSource" ref="f68596ec4e95a0ce50fa6f7de611da63" args="(const XMLCh *const basePath, const XMLCh *const relativePath, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::LocalFileInputSource::LocalFileInputSource </td>
<td>(</td>
<td class="paramtype">const XMLCh *const&nbsp;</td>
<td class="paramname"> <em>basePath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *const&nbsp;</td>
<td class="paramname"> <em>relativePath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const &nbsp;</td>
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A local file input source requires a path to the file to load.
<p>
This can be provided either as a fully qualified path, a path relative to the current working directly, or a path relative to a provided base path.<p>
The completed path will become the system id of this input source. The constructors don't take any public id for local files, but you still set them via the parent class' <a class="el" href="classxercesc_1_1InputSource.html#d88b92735d82dcadf39496ca83357aec">setPublicId()</a> method of course.<p>
This constructor takes an explicit base path and a possibly relative path. If the relative path is seen to be fully qualified, it is used as is. Otherwise, it is made relative to the passed base path.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>basePath</em>&nbsp;</td><td>The base path from which the passed relative path will be based, if the relative part is indeed relative.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>relativePath</em>&nbsp;</td><td>The relative part of the path. It can actually be fully qualified, in which case it is taken as is.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>manager</em>&nbsp;</td><td>Pointer to the memory manager to be used to allocate objects.</td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XMLException</em>&nbsp;</td><td>If the path is relative and doesn't properly resolve to a file. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="37c16c37af1412902ebbb8db81e4d053"></a><!-- doxytag: member="xercesc::LocalFileInputSource::LocalFileInputSource" ref="37c16c37af1412902ebbb8db81e4d053" args="(const XMLCh *const filePath, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::LocalFileInputSource::LocalFileInputSource </td>
<td>(</td>
<td class="paramtype">const XMLCh *const&nbsp;</td>
<td class="paramname"> <em>filePath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const &nbsp;</td>
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This constructor takes a single parameter which is the fully qualified or relative path.
<p>
If it is fully qualified, it is taken as is. If it is relative, then it is completed relative to the current working directory (or the equivalent on the local host machine.)<p>
The completed path will become the system id of this input source. The constructors don't take any public id for local files, but you still set them via the parent class' <a class="el" href="classxercesc_1_1InputSource.html#d88b92735d82dcadf39496ca83357aec">setPublicId()</a> method of course.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filePath</em>&nbsp;</td><td>The relative or fully qualified path.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>manager</em>&nbsp;</td><td>Pointer to the memory manager to be used to allocate objects.</td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XMLException</em>&nbsp;</td><td>If the path is relative and doesn't properly resolve to a file. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6f494df557d4e426fcade88f5d2fb5f9"></a><!-- doxytag: member="xercesc::LocalFileInputSource::~LocalFileInputSource" ref="6f494df557d4e426fcade88f5d2fb5f9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::LocalFileInputSource::~LocalFileInputSource </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="f68596ec4e95a0ce50fa6f7de611da63"></a><!-- doxytag: member="xercesc::LocalFileInputSource::LocalFileInputSource" ref="f68596ec4e95a0ce50fa6f7de611da63" args="(const XMLCh *const basePath, const XMLCh *const relativePath, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::LocalFileInputSource::LocalFileInputSource </td>
<td>(</td>
<td class="paramtype">const XMLCh *const&nbsp;</td>
<td class="paramname"> <em>basePath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *const&nbsp;</td>
<td class="paramname"> <em>relativePath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const &nbsp;</td>
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A local file input source requires a path to the file to load.
<p>
This can be provided either as a fully qualified path, a path relative to the current working directly, or a path relative to a provided base path.<p>
The completed path will become the system id of this input source. The constructors don't take any public id for local files, but you still set them via the parent class' <a class="el" href="classxercesc_1_1InputSource.html#d88b92735d82dcadf39496ca83357aec">setPublicId()</a> method of course.<p>
This constructor takes an explicit base path and a possibly relative path. If the relative path is seen to be fully qualified, it is used as is. Otherwise, it is made relative to the passed base path.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>basePath</em>&nbsp;</td><td>The base path from which the passed relative path will be based, if the relative part is indeed relative.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>relativePath</em>&nbsp;</td><td>The relative part of the path. It can actually be fully qualified, in which case it is taken as is.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>manager</em>&nbsp;</td><td>Pointer to the memory manager to be used to allocate objects.</td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XMLException</em>&nbsp;</td><td>If the path is relative and doesn't properly resolve to a file. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="37c16c37af1412902ebbb8db81e4d053"></a><!-- doxytag: member="xercesc::LocalFileInputSource::LocalFileInputSource" ref="37c16c37af1412902ebbb8db81e4d053" args="(const XMLCh *const filePath, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::LocalFileInputSource::LocalFileInputSource </td>
<td>(</td>
<td class="paramtype">const XMLCh *const&nbsp;</td>
<td class="paramname"> <em>filePath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *const &nbsp;</td>
<td class="paramname"> <em>manager</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">XMLPlatformUtils::fgMemoryManager</a></code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This constructor takes a single parameter which is the fully qualified or relative path.
<p>
If it is fully qualified, it is taken as is. If it is relative, then it is completed relative to the current working directory (or the equivalent on the local host machine.)<p>
The completed path will become the system id of this input source. The constructors don't take any public id for local files, but you still set them via the parent class' <a class="el" href="classxercesc_1_1InputSource.html#d88b92735d82dcadf39496ca83357aec">setPublicId()</a> method of course.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filePath</em>&nbsp;</td><td>The relative or fully qualified path.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>manager</em>&nbsp;</td><td>Pointer to the memory manager to be used to allocate objects.</td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XMLException</em>&nbsp;</td><td>If the path is relative and doesn't properly resolve to a file. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6f494df557d4e426fcade88f5d2fb5f9"></a><!-- doxytag: member="xercesc::LocalFileInputSource::~LocalFileInputSource" ref="6f494df557d4e426fcade88f5d2fb5f9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xercesc::LocalFileInputSource::~LocalFileInputSource </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b080ba29fdbc0825da80cdce64f38007"></a><!-- doxytag: member="xercesc::LocalFileInputSource::makeStream" ref="b080ba29fdbc0825da80cdce64f38007" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual BinInputStream* xercesc::LocalFileInputSource::makeStream </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This method will return a binary input stream derivative that will parse from the local file indicatedby the system id.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A dynamically allocated binary input stream derivative that can parse from the file indicated by the system id. </dd></dl>
<p>
Implements <a class="el" href="classxercesc_1_1InputSource.html#58559673267865caf4090fcb881e9f2f">xercesc::InputSource</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="LocalFileInputSource_8hpp-source.html">LocalFileInputSource.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 12 20:17:02 2007 for XQilla Simple API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink