Sophie

Sophie

distrib > Mageia > 5 > x86_64 > media > core-release > by-pkgid > 553d1e1391b9f1acad517c925f34ae45 > files > 261

lib64xmltooling-devel-1.5.3-5.mga5.x86_64.rpm

<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>xmltooling: xmltooling::ParserPool Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">xmltooling
   &#160;<span id="projectnumber">1.5.3</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</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 id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('a00062.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="a00275.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">xmltooling::ParserPool Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A thread-safe pool of DOMBuilders that share characteristics.  
 <a href="a00062.html#details">More...</a></p>

<p><code>#include &lt;xmltooling/util/ParserPool.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for xmltooling::ParserPool:</div>
<div class="dyncontent">
 <div class="center">
  <img src="a00062.png" usemap="#xmltooling::ParserPool_map" alt=""/>
  <map id="xmltooling::ParserPool_map" name="xmltooling::ParserPool_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aca3c09d237ffdd42c59b4f21470861c8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00062.html#aca3c09d237ffdd42c59b4f21470861c8">ParserPool</a> (bool namespaceAware=true, bool schemaAware=false)</td></tr>
<tr class="memdesc:aca3c09d237ffdd42c59b4f21470861c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new pool.  <a href="#aca3c09d237ffdd42c59b4f21470861c8">More...</a><br /></td></tr>
<tr class="separator:aca3c09d237ffdd42c59b4f21470861c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82251bb1bf77cc8316b5ca9bf128e5d7"><td class="memItemLeft" align="right" valign="top">xercesc::DOMDocument *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00062.html#a82251bb1bf77cc8316b5ca9bf128e5d7">newDocument</a> ()</td></tr>
<tr class="memdesc:a82251bb1bf77cc8316b5ca9bf128e5d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new document using a parser from this pool.  <a href="#a82251bb1bf77cc8316b5ca9bf128e5d7">More...</a><br /></td></tr>
<tr class="separator:a82251bb1bf77cc8316b5ca9bf128e5d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad6274aca808983be1e501fe809f0314"><td class="memItemLeft" align="right" valign="top">xercesc::DOMDocument *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00062.html#aad6274aca808983be1e501fe809f0314">parse</a> (xercesc::DOMInputSource &amp;domsrc)</td></tr>
<tr class="memdesc:aad6274aca808983be1e501fe809f0314"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses a document using a pooled parser with the proper settings.  <a href="#aad6274aca808983be1e501fe809f0314">More...</a><br /></td></tr>
<tr class="separator:aad6274aca808983be1e501fe809f0314"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2368f59df71ad113a2998c03ef94d6b"><td class="memItemLeft" align="right" valign="top">xercesc::DOMDocument *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00062.html#ab2368f59df71ad113a2998c03ef94d6b">parse</a> (std::istream &amp;is)</td></tr>
<tr class="memdesc:ab2368f59df71ad113a2998c03ef94d6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses a document using a pooled parser with the proper settings.  <a href="#ab2368f59df71ad113a2998c03ef94d6b">More...</a><br /></td></tr>
<tr class="separator:ab2368f59df71ad113a2998c03ef94d6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03ed92df548d316e2aba077bd9c60824"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00062.html#a03ed92df548d316e2aba077bd9c60824">loadCatalogs</a> (const char *pathnames)</td></tr>
<tr class="memdesc:a03ed92df548d316e2aba077bd9c60824"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load OASIS catalog files to map schema namespace URIs to filenames.  <a href="#a03ed92df548d316e2aba077bd9c60824">More...</a><br /></td></tr>
<tr class="separator:a03ed92df548d316e2aba077bd9c60824"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2dd9cf4befc0fbd08bf461e0e9cc58ee"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00062.html#a2dd9cf4befc0fbd08bf461e0e9cc58ee">loadCatalog</a> (const char *pathnames)</td></tr>
<tr class="memdesc:a2dd9cf4befc0fbd08bf461e0e9cc58ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load an OASIS catalog file to map schema namespace URIs to filenames.  <a href="#a2dd9cf4befc0fbd08bf461e0e9cc58ee">More...</a><br /></td></tr>
<tr class="separator:a2dd9cf4befc0fbd08bf461e0e9cc58ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66e37d10700435f9c6b5affe6af48a2f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00062.html#a66e37d10700435f9c6b5affe6af48a2f">loadCatalog</a> (const XMLCh *pathname)</td></tr>
<tr class="memdesc:a66e37d10700435f9c6b5affe6af48a2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load an OASIS catalog file to map schema namespace URIs to filenames.  <a href="#a66e37d10700435f9c6b5affe6af48a2f">More...</a><br /></td></tr>
<tr class="separator:a66e37d10700435f9c6b5affe6af48a2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1053da6e58d23602ea2b214fc20cf63"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00062.html#aa1053da6e58d23602ea2b214fc20cf63">loadSchema</a> (const XMLCh *nsURI, const XMLCh *pathname)</td></tr>
<tr class="memdesc:aa1053da6e58d23602ea2b214fc20cf63"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load a schema explicitly from a local file.  <a href="#aa1053da6e58d23602ea2b214fc20cf63">More...</a><br /></td></tr>
<tr class="separator:aa1053da6e58d23602ea2b214fc20cf63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e323a9c9fd10416ea3dc51b05409ac6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e323a9c9fd10416ea3dc51b05409ac6"></a>
xercesc::DOMInputSource *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00062.html#a8e323a9c9fd10416ea3dc51b05409ac6">resolveEntity</a> (const XMLCh *const publicId, const XMLCh *const systemId, const XMLCh *const baseURI)</td></tr>
<tr class="memdesc:a8e323a9c9fd10416ea3dc51b05409ac6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Supplies all external entities (primarily schemas) to the parser. <br /></td></tr>
<tr class="separator:a8e323a9c9fd10416ea3dc51b05409ac6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A thread-safe pool of DOMBuilders that share characteristics. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aca3c09d237ffdd42c59b4f21470861c8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">xmltooling::ParserPool::ParserPool </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>namespaceAware</em> = <code>true</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>schemaAware</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructs a new pool. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">namespaceAware</td><td>indicates whether parsers should be namespace-aware or not </td></tr>
    <tr><td class="paramname">schemaAware</td><td>indicates whether parsers should be schema-validating or not </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a2dd9cf4befc0fbd08bf461e0e9cc58ee"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool xmltooling::ParserPool::loadCatalog </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>pathnames</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Load an OASIS catalog file to map schema namespace URIs to filenames. </p>
<p>This does not provide real catalog support; only the &lt;uri&gt; element is supported to map from a namespace URI to a relative path or <a href="file://">file://</a> URI.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pathname</td><td>path to a catalog file </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff the catalog was successfully processed </dd></dl>

</div>
</div>
<a class="anchor" id="a66e37d10700435f9c6b5affe6af48a2f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool xmltooling::ParserPool::loadCatalog </td>
          <td>(</td>
          <td class="paramtype">const XMLCh *&#160;</td>
          <td class="paramname"><em>pathname</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Load an OASIS catalog file to map schema namespace URIs to filenames. </p>
<p>This does not provide real catalog support; only the &lt;uri&gt; element is supported to map from a namespace URI to a relative path or <a href="file://">file://</a> URI.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pathname</td><td>path to a catalog file </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff the catalog was successfully processed </dd></dl>

</div>
</div>
<a class="anchor" id="a03ed92df548d316e2aba077bd9c60824"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool xmltooling::ParserPool::loadCatalogs </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>pathnames</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Load OASIS catalog files to map schema namespace URIs to filenames. </p>
<p>This does not provide real catalog support; only the &lt;uri&gt; element is supported to map from a namespace URI to a relative path or <a href="file://">file://</a> URI.</p>
<p>Multiple files can be specified using a platform-specific path delimiter.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pathname</td><td>path to one or more catalog files </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff the catalogs were successfully processed </dd></dl>

</div>
</div>
<a class="anchor" id="aa1053da6e58d23602ea2b214fc20cf63"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool xmltooling::ParserPool::loadSchema </td>
          <td>(</td>
          <td class="paramtype">const XMLCh *&#160;</td>
          <td class="paramname"><em>nsURI</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const XMLCh *&#160;</td>
          <td class="paramname"><em>pathname</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Load a schema explicitly from a local file. </p>
<p>Note that "successful processing" does not imply that the schema is valid, only that a reference to it was successfully registered with the pool.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">nsURI</td><td>XML namespace to load </td></tr>
    <tr><td class="paramname">pathname</td><td>path to schema file </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff the schema was successfully processed </dd></dl>

</div>
</div>
<a class="anchor" id="a82251bb1bf77cc8316b5ca9bf128e5d7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">xercesc::DOMDocument* xmltooling::ParserPool::newDocument </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a new document using a parser from this pool. </p>
<dl class="section return"><dt>Returns</dt><dd>new XML document </dd></dl>

</div>
</div>
<a class="anchor" id="aad6274aca808983be1e501fe809f0314"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">xercesc::DOMDocument* xmltooling::ParserPool::parse </td>
          <td>(</td>
          <td class="paramtype">xercesc::DOMInputSource &amp;&#160;</td>
          <td class="paramname"><em>domsrc</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Parses a document using a pooled parser with the proper settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">domsrc</td><td>An input source containing the content to be parsed </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The DOM document resulting from the parse </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="a00111.html" title="Exceptions related to XML parsing. ">XMLParserException</a></td><td>thrown if there was a problem reading, parsing, or validating the XML </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ab2368f59df71ad113a2998c03ef94d6b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">xercesc::DOMDocument* xmltooling::ParserPool::parse </td>
          <td>(</td>
          <td class="paramtype">std::istream &amp;&#160;</td>
          <td class="paramname"><em>is</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Parses a document using a pooled parser with the proper settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">is</td><td>An input stream containing the content to be parsed </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The DOM document resulting from the parse </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="a00111.html" title="Exceptions related to XML parsing. ">XMLParserException</a></td><td>thrown if there was a problem reading, parsing, or validating the XML </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xmltooling/util/<a class="el" href="a00183.html">ParserPool.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="a00206.html">xmltooling</a></li><li class="navelem"><a class="el" href="a00062.html">ParserPool</a></li>
    <li class="footer">Generated on Fri Oct 17 2014 12:44:58 for xmltooling by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
  </ul>
</div>
</body>
</html>