File: Poco.XML.EntityResolver.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (61 lines) | stat: -rw-r--r-- 6,382 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<!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>
<title>Class Poco::XML::EntityResolver</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.XML.html" class="namespace">Poco::XML</a></h1>
<h1 class="symbol">class EntityResolver</h1>
</div>
<div class="body">
<p>
<b>Library:</b> XML<br />
<b>Package:</b> SAX<br />
<b>Header:</b> Poco/SAX/EntityResolver.h</p>
<h2>Description</h2>
<div class="description">
<p>If a SAX application needs to implement customized handling for external entities,  it must implement this interface and register an instance with the SAX driver using  the setEntityResolver method. </p>
<p>The <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> reader will then allow the application to intercept any external entities  (including the external DTD subset and external parameter entities, if any) before  including them. </p>
<p>Many SAX applications will not need to implement this interface, but it will be  especially useful for applications that build <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> documents from databases or other  specialised input sources, or for applications that use <a href="Poco.URI.html" title="class Poco::URI">URI</a> types other than URLs. </p>
<p>The application can also use this interface to redirect system identifiers to local  URIs or to look up replacements in a catalog (possibly by using the public identifier). </p>
</div>
<h2>Inheritance</h2>
<p><b>Known Derived Classes: </b><a href="Poco.XML.DefaultHandler.html" title="class Poco::XML::DefaultHandler">DefaultHandler</a>, <a href="Poco.XML.EntityResolverImpl.html" title="class Poco::XML::EntityResolverImpl">EntityResolverImpl</a>, <a href="Poco.XML.XMLFilterImpl.html" title="class Poco::XML::XMLFilterImpl">XMLFilterImpl</a>, <a href="Poco.XML.WhitespaceFilter.html" title="class Poco::XML::WhitespaceFilter">WhitespaceFilter</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.XML.EntityResolver.html#18970" title="Poco::XML::EntityResolver::releaseInputSource()">releaseInputSource</a>, <a href="Poco.XML.EntityResolver.html#18967" title="Poco::XML::EntityResolver::resolveEntity()">resolveEntity</a></p>
<h2>Destructor</h2>
<h3><a name="18972">~EntityResolver</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual ~<a href="Poco.XML.EntityResolver.html" title="class Poco::XML::EntityResolver">EntityResolver</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Member Functions</h2>
<h3><a name="18970">releaseInputSource</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual void releaseInputSource(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.InputSource.html" title="class Poco::XML::InputSource">InputSource</a> * pSource<br />) = 0;</p>
<div class="description">
<p>This is a non-standard extension to SAX! Called by the parser when the input source returned by ResolveEntity is no longer needed. Should free any resources used by the input source. </p>
</div>
<h3><a name="18967">resolveEntity</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual <a href="Poco.XML.InputSource.html" title="class Poco::XML::InputSource">InputSource</a> * resolveEntity(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> * publicId,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; systemId<br />) = 0;</p>
<div class="description">
<p>Allow the application to resolve external entities. </p>
<p>The parser will call this method before opening any external entity except the  top-level document entity. Such entities include the external DTD subset and  external parameter entities referenced within the DTD (in either case, only  if the parser reads external parameter entities), and external general entities  referenced within the document element (if the parser reads external general entities).  The application may request that the parser locate the entity itself, that it use an  alternative <a href="Poco.URI.html" title="class Poco::URI">URI</a>, or that it use data provided by the application (as a character or  byte input stream). </p>
<p>Application writers can use this method to redirect external system identifiers to  secure and/or local URIs, to look up public identifiers in a catalogue, or to read an  entity from a database or other input source (including, for example, a dialog box).  Neither <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> nor SAX specifies a preferred policy for using public or system IDs to resolve  resources. However, SAX specifies how to interpret any <a href="Poco.XML.InputSource.html" title="class Poco::XML::InputSource">InputSource</a> returned by this method,  and that if none is returned, then the system ID will be dereferenced as a URL. </p>
<p>If the system identifier is a URL, the SAX parser must resolve it fully before reporting it to  the application. </p>
<p>Note that publicId maybe null, therefore we pass a pointer rather than a reference. </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>