| <!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 Page</span></a></li> |
| <li><a href="pages.html"><span>Related Pages</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| </ul> |
| </div> |
| <div class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <div class="header"> |
| <div class="headertitle"> |
| <h1>XMLParserLiaison.hpp</h1> </div> |
| </div> |
| <div class="contents"> |
| <a href="XMLParserLiaison_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> |
| <a name="l00002"></a>00002 <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <a name="l00003"></a>00003 <span class="comment"> * or more contributor license agreements. See the NOTICE file</span> |
| <a name="l00004"></a>00004 <span class="comment"> * distributed with this work for additional information</span> |
| <a name="l00005"></a>00005 <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span> |
| <a name="l00006"></a>00006 <span class="comment"> * to you under the Apache License, Version 2.0 (the "License");</span> |
| <a name="l00007"></a>00007 <span class="comment"> * you may not use this file except in compliance with the License.</span> |
| <a name="l00008"></a>00008 <span class="comment"> * You may obtain a copy of the License at</span> |
| <a name="l00009"></a>00009 <span class="comment"> *</span> |
| <a name="l00010"></a>00010 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <a name="l00011"></a>00011 <span class="comment"> *</span> |
| <a name="l00012"></a>00012 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> |
| <a name="l00013"></a>00013 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <a name="l00014"></a>00014 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <a name="l00015"></a>00015 <span class="comment"> * See the License for the specific language governing permissions and</span> |
| <a name="l00016"></a>00016 <span class="comment"> * limitations under the License.</span> |
| <a name="l00017"></a>00017 <span class="comment"> */</span> |
| <a name="l00018"></a>00018 <span class="preprocessor">#if !defined(XMLPARSERLIAISON_HEADER_GUARD_1357924680)</span> |
| <a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define XMLPARSERLIAISON_HEADER_GUARD_1357924680</span> |
| <a name="l00020"></a>00020 <span class="preprocessor"></span> |
| <a name="l00021"></a>00021 |
| <a name="l00022"></a>00022 |
| <a name="l00023"></a>00023 <span class="comment">// Base include file. Must be first.</span> |
| <a name="l00024"></a>00024 <span class="preprocessor">#include <<a class="code" href="XMLSupportDefinitions_8hpp.html">xalanc/XMLSupport/XMLSupportDefinitions.hpp</a>></span> |
| <a name="l00025"></a>00025 |
| <a name="l00026"></a>00026 |
| <a name="l00027"></a>00027 |
| <a name="l00028"></a>00028 <span class="preprocessor">#include <<a class="code" href="XalanDOMString_8hpp.html">xalanc/XalanDOM/XalanDOMString.hpp</a>></span> |
| <a name="l00029"></a>00029 |
| <a name="l00030"></a>00030 |
| <a name="l00031"></a>00031 |
| <a name="l00032"></a>00032 XALAN_DECLARE_XERCES_CLASS(DocumentHandler) |
| <a name="l00033"></a>00033 XALAN_DECLARE_XERCES_CLASS(EntityResolver) |
| <a name="l00034"></a>00034 XALAN_DECLARE_XERCES_CLASS(ErrorHandler) |
| <a name="l00035"></a>00035 XALAN_DECLARE_XERCES_CLASS(InputSource) |
| <a name="l00036"></a>00036 XALAN_DECLARE_XERCES_CLASS(XMLEntityResolver) |
| <a name="l00037"></a>00037 |
| <a name="l00038"></a>00038 |
| <a name="l00039"></a>00039 |
| <a name="l00040"></a>00040 XALAN_CPP_NAMESPACE_BEGIN |
| <a name="l00041"></a>00041 |
| <a name="l00042"></a>00042 |
| <a name="l00043"></a>00043 |
| <a name="l00044"></a><a class="code" href="XMLParserLiaison_8hpp.html#a439a16ef8bb1bf54f9795363bcec9db3">00044</a> typedef XERCES_CPP_NAMESPACE_QUALIFIER DocumentHandler <a class="code" href="StylesheetConstructionContext_8hpp.html#aba2c9d9ee1baa3319735c4d88214587b">DocumentHandlerType</a>; |
| <a name="l00045"></a><a class="code" href="XMLParserLiaison_8hpp.html#a4b3bc3c5ffa5c9f13ba4772c74e0daa8">00045</a> typedef XERCES_CPP_NAMESPACE_QUALIFIER EntityResolver <a class="code" href="XMLParserLiaison_8hpp.html#a4b3bc3c5ffa5c9f13ba4772c74e0daa8">EntityResolverType</a>; |
| <a name="l00046"></a><a class="code" href="XMLParserLiaison_8hpp.html#abec424e2115bfc3c57b1c7460eeb1608">00046</a> typedef XERCES_CPP_NAMESPACE_QUALIFIER ErrorHandler <a class="code" href="XalanCompiledStylesheetDefault_8hpp.html#abec424e2115bfc3c57b1c7460eeb1608">ErrorHandlerType</a>; |
| <a name="l00047"></a><a class="code" href="XMLParserLiaison_8hpp.html#a82c1777ce952cba839ddfc8c02f6a3c8">00047</a> typedef XERCES_CPP_NAMESPACE_QUALIFIER InputSource <a class="code" href="XSLTInputSource_8hpp.html#a82c1777ce952cba839ddfc8c02f6a3c8">InputSourceType</a>; |
| <a name="l00048"></a>00048 |
| <a name="l00049"></a>00049 <a class="code" href="XSLTProcessor_8hpp.html#a24af2755e58bade5ff0d5965b855e56a">XALAN_USING_XERCES</a>(DocumentHandler) |
| <a name="l00050"></a>00050 <a class="code" href="XSLTProcessor_8hpp.html#a24af2755e58bade5ff0d5965b855e56a">XALAN_USING_XERCES</a>(EntityResolver) |
| <a name="l00051"></a>00051 <a class="code" href="XSLTProcessor_8hpp.html#a24af2755e58bade5ff0d5965b855e56a">XALAN_USING_XERCES</a>(ErrorHandler) |
| <a name="l00052"></a>00052 <a class="code" href="XSLTProcessor_8hpp.html#a24af2755e58bade5ff0d5965b855e56a">XALAN_USING_XERCES</a>(InputSource) |
| <a name="l00053"></a>00053 <a class="code" href="XSLTProcessor_8hpp.html#a24af2755e58bade5ff0d5965b855e56a">XALAN_USING_XERCES</a>(XMLEntityResolver) |
| <a name="l00054"></a>00054 |
| <a name="l00055"></a>00055 |
| <a name="l00056"></a>00056 |
| <a name="l00057"></a>00057 class <a class="code" href="classExecutionContext.html">ExecutionContext</a>; |
| <a name="l00058"></a>00058 class <a class="code" href="classFormatterListener.html" title="A SAX-based formatter interface for the XSL processor.">FormatterListener</a>; |
| <a name="l00059"></a>00059 class <a class="code" href="classXalanAttr.html">XalanAttr</a>; |
| <a name="l00060"></a>00060 class <a class="code" href="classXalanDocument.html">XalanDocument</a>; |
| <a name="l00061"></a>00061 class <a class="code" href="classXalanElement.html">XalanElement</a>; |
| <a name="l00062"></a>00062 |
| <a name="l00063"></a>00063 |
| <a name="l00064"></a>00064 |
| <a name="l00065"></a><a class="code" href="classXMLParserLiaison.html">00065</a> class <a class="code" href="XMLSupportDefinitions_8hpp.html#a355383aef0d5a2c4c67e554c3d947b61">XALAN_XMLSUPPORT_EXPORT</a> <a class="code" href="classXMLParserLiaison.html">XMLParserLiaison</a> |
| <a name="l00066"></a>00066 { |
| <a name="l00067"></a>00067 |
| <a name="l00068"></a>00068 <span class="keyword">public</span>: |
| <a name="l00069"></a>00069 |
| <a name="l00070"></a>00070 XMLParserLiaison(); |
| <a name="l00071"></a>00071 |
| <a name="l00072"></a>00072 <span class="keyword">virtual</span> |
| <a name="l00073"></a>00073 ~XMLParserLiaison(); |
| <a name="l00074"></a>00074 |
| <a name="l00075"></a>00075 |
| <a name="l00076"></a>00076 <span class="comment">// These interfaces are new to XMLParserLiaison</span> |
| <a name="l00077"></a>00077 <span class="comment"></span> |
| <a name="l00078"></a>00078 <span class="comment"> /**</span> |
| <a name="l00079"></a>00079 <span class="comment"> * Reset the instance, freeing any XalanDocument instances created</span> |
| <a name="l00080"></a>00080 <span class="comment"> * through parseXMLStream().</span> |
| <a name="l00081"></a>00081 <span class="comment"> */</span> |
| <a name="l00082"></a>00082 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00083"></a>00083 reset() = 0; |
| <a name="l00084"></a>00084 <span class="comment"></span> |
| <a name="l00085"></a>00085 <span class="comment"> /**</span> |
| <a name="l00086"></a>00086 <span class="comment"> * Get a pointer to the current ExecutionContext instance, which</span> |
| <a name="l00087"></a>00087 <span class="comment"> * may be null.</span> |
| <a name="l00088"></a>00088 <span class="comment"> *</span> |
| <a name="l00089"></a>00089 <span class="comment"> * @return A pointer to the current ExecutionContext, if any.</span> |
| <a name="l00090"></a>00090 <span class="comment"> */</span> |
| <a name="l00091"></a>00091 <span class="keyword">virtual</span> ExecutionContext* |
| <a name="l00092"></a>00092 getExecutionContext() <span class="keyword">const</span> = 0; |
| <a name="l00093"></a>00093 <span class="comment"></span> |
| <a name="l00094"></a>00094 <span class="comment"> /**</span> |
| <a name="l00095"></a>00095 <span class="comment"> * Get a reference to the current MemoryManager instance.</span> |
| <a name="l00096"></a>00096 <span class="comment"> *</span> |
| <a name="l00097"></a>00097 <span class="comment"> * @return A pointer to the current ExecutionContext, if any.</span> |
| <a name="l00098"></a>00098 <span class="comment"> */</span> |
| <a name="l00099"></a>00099 <span class="keyword">virtual</span> MemoryManager& |
| <a name="l00100"></a>00100 getMemoryManager() = 0; |
| <a name="l00101"></a>00101 <span class="comment"></span> |
| <a name="l00102"></a>00102 <span class="comment"> /**</span> |
| <a name="l00103"></a>00103 <span class="comment"> * Set the current ExecutionContext instance.</span> |
| <a name="l00104"></a>00104 <span class="comment"> *</span> |
| <a name="l00105"></a>00105 <span class="comment"> * @parameter theContext A reference to the new ExecutionContext instance.</span> |
| <a name="l00106"></a>00106 <span class="comment"> */</span> |
| <a name="l00107"></a>00107 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00108"></a>00108 setExecutionContext(ExecutionContext& theContext) = 0; |
| <a name="l00109"></a>00109 <span class="comment"></span> |
| <a name="l00110"></a>00110 <span class="comment"> /**</span> |
| <a name="l00111"></a>00111 <span class="comment"> * Parse the text pointed at by the reader as XML, and return a DOM</span> |
| <a name="l00112"></a>00112 <span class="comment"> * Document interface. It is recommended that you pass in some sort of</span> |
| <a name="l00113"></a>00113 <span class="comment"> * recognizable name, such as the filename or URI, with which the reader</span> |
| <a name="l00114"></a>00114 <span class="comment"> * can be recognized if the parse fails.</span> |
| <a name="l00115"></a>00115 <span class="comment"> *</span> |
| <a name="l00116"></a>00116 <span class="comment"> * The liaison owns the XalanDocument instance, and will delete it when</span> |
| <a name="l00117"></a>00117 <span class="comment"> * asked (see DestroyDocument()), or when the liaison is reset, or goes</span> |
| <a name="l00118"></a>00118 <span class="comment"> * out of scope.</span> |
| <a name="l00119"></a>00119 <span class="comment"> *</span> |
| <a name="l00120"></a>00120 <span class="comment"> * This function is not reentrant, so you cannot call it again until</span> |
| <a name="l00121"></a>00121 <span class="comment"> * the current call exits.</span> |
| <a name="l00122"></a>00122 <span class="comment"> *</span> |
| <a name="l00123"></a>00123 <span class="comment"> * @param reader stream that should hold valid XML</span> |
| <a name="l00124"></a>00124 <span class="comment"> * @param identifier used for diagnostic purposes only, some sort of</span> |
| <a name="l00125"></a>00125 <span class="comment"> * identification for error reporting, default an empty</span> |
| <a name="l00126"></a>00126 <span class="comment"> * string</span> |
| <a name="l00127"></a>00127 <span class="comment"> * @return DOM document created</span> |
| <a name="l00128"></a>00128 <span class="comment"> */</span> |
| <a name="l00129"></a>00129 <span class="keyword">virtual</span> XalanDocument* |
| <a name="l00130"></a>00130 parseXMLStream( |
| <a name="l00131"></a>00131 <span class="keyword">const</span> InputSource& inputSource, |
| <a name="l00132"></a>00132 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& identifier) = 0; |
| <a name="l00133"></a>00133 <span class="comment"></span> |
| <a name="l00134"></a>00134 <span class="comment"> /**</span> |
| <a name="l00135"></a>00135 <span class="comment"> * Parse the text pointed at by the reader as XML. It is recommended that</span> |
| <a name="l00136"></a>00136 <span class="comment"> * you pass in some sort of recognizable name, such as the filename or URI,</span> |
| <a name="l00137"></a>00137 <span class="comment"> * with which the reader can be recognized if the parse fails.</span> |
| <a name="l00138"></a>00138 <span class="comment"> *</span> |
| <a name="l00139"></a>00139 <span class="comment"> * This function is reentrant, so you can call it again before any</span> |
| <a name="l00140"></a>00140 <span class="comment"> * other call exits. However, it is not thread-safe.</span> |
| <a name="l00141"></a>00141 <span class="comment"> *</span> |
| <a name="l00142"></a>00142 <span class="comment"> * @param inputSource input source that should hold valid XML</span> |
| <a name="l00143"></a>00143 <span class="comment"> * @param handler instance of a DocumentHandler</span> |
| <a name="l00144"></a>00144 <span class="comment"> * @param identifier used for diagnostic purposes only, some sort of</span> |
| <a name="l00145"></a>00145 <span class="comment"> * identification for error reporting, default an</span> |
| <a name="l00146"></a>00146 <span class="comment"> * empty string</span> |
| <a name="l00147"></a>00147 <span class="comment"> */</span> |
| <a name="l00148"></a>00148 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00149"></a>00149 parseXMLStream( |
| <a name="l00150"></a>00150 <span class="keyword">const</span> InputSource& inputSource, |
| <a name="l00151"></a>00151 DocumentHandler& handler, |
| <a name="l00152"></a>00152 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& identifier) = 0; |
| <a name="l00153"></a>00153 <span class="comment"></span> |
| <a name="l00154"></a>00154 <span class="comment"> /**</span> |
| <a name="l00155"></a>00155 <span class="comment"> * Destroy the supplied XalanDocument instance. It must be an instance that</span> |
| <a name="l00156"></a>00156 <span class="comment"> * was created by a previous call to parseXMLStream().</span> |
| <a name="l00157"></a>00157 <span class="comment"> *</span> |
| <a name="l00158"></a>00158 <span class="comment"> * @param theDocument The XalanDocument instance to destroy.</span> |
| <a name="l00159"></a>00159 <span class="comment"> */</span> |
| <a name="l00160"></a>00160 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00161"></a>00161 destroyDocument(XalanDocument* theDocument) = 0; |
| <a name="l00162"></a>00162 <span class="comment"></span> |
| <a name="l00163"></a>00163 <span class="comment"> /**</span> |
| <a name="l00164"></a>00164 <span class="comment"> * Get the amount to indent when indent-result="yes".</span> |
| <a name="l00165"></a>00165 <span class="comment"> *</span> |
| <a name="l00166"></a>00166 <span class="comment"> * @deprecated</span> |
| <a name="l00167"></a>00167 <span class="comment"> *</span> |
| <a name="l00168"></a>00168 <span class="comment"> * @return number of characters to indent</span> |
| <a name="l00169"></a>00169 <span class="comment"> */</span> |
| <a name="l00170"></a>00170 <span class="keyword">virtual</span> <span class="keywordtype">int</span> |
| <a name="l00171"></a>00171 getIndent() <span class="keyword">const</span> = 0; |
| <a name="l00172"></a>00172 <span class="comment"></span> |
| <a name="l00173"></a>00173 <span class="comment"> /**</span> |
| <a name="l00174"></a>00174 <span class="comment"> * Set the amount to indent when indent-result="yes".</span> |
| <a name="l00175"></a>00175 <span class="comment"> *</span> |
| <a name="l00176"></a>00176 <span class="comment"> * @deprecated</span> |
| <a name="l00177"></a>00177 <span class="comment"> *</span> |
| <a name="l00178"></a>00178 <span class="comment"> * @param i number of characters to indent</span> |
| <a name="l00179"></a>00179 <span class="comment"> */</span> |
| <a name="l00180"></a>00180 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00181"></a>00181 setIndent(<span class="keywordtype">int</span> i) = 0; |
| <a name="l00182"></a>00182 <span class="comment"></span> |
| <a name="l00183"></a>00183 <span class="comment"> /**</span> |
| <a name="l00184"></a>00184 <span class="comment"> * Get whether or not validation will be performed. Validation is off by</span> |
| <a name="l00185"></a>00185 <span class="comment"> * default.</span> |
| <a name="l00186"></a>00186 <span class="comment"> *</span> |
| <a name="l00187"></a>00187 <span class="comment"> * @return true to perform validation</span> |
| <a name="l00188"></a>00188 <span class="comment"> */</span> |
| <a name="l00189"></a>00189 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> |
| <a name="l00190"></a>00190 getUseValidation() <span class="keyword">const</span> = 0; |
| <a name="l00191"></a>00191 <span class="comment"></span> |
| <a name="l00192"></a>00192 <span class="comment"> /**</span> |
| <a name="l00193"></a>00193 <span class="comment"> * If set to true, validation will be performed. Validation is off by</span> |
| <a name="l00194"></a>00194 <span class="comment"> * default.</span> |
| <a name="l00195"></a>00195 <span class="comment"> *</span> |
| <a name="l00196"></a>00196 <span class="comment"> * @param b true to perform validation</span> |
| <a name="l00197"></a>00197 <span class="comment"> */</span> |
| <a name="l00198"></a>00198 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00199"></a>00199 setUseValidation(<span class="keywordtype">bool</span> b) = 0; |
| <a name="l00200"></a>00200 <span class="comment"></span> |
| <a name="l00201"></a>00201 <span class="comment"> /**</span> |
| <a name="l00202"></a>00202 <span class="comment"> * Return a string suitable for telling the user what parser is being used.</span> |
| <a name="l00203"></a>00203 <span class="comment"> *</span> |
| <a name="l00204"></a>00204 <span class="comment"> * @return string describing parser</span> |
| <a name="l00205"></a>00205 <span class="comment"> */</span> |
| <a name="l00206"></a>00206 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& |
| <a name="l00207"></a>00207 getParserDescription(<a class="code" href="classXalanDOMString.html">XalanDOMString</a>& <a class="code" href="XalanDOMString_8hpp.html#ad0987a2085caff760532b7f16b5c6f2e">theResult</a>) <span class="keyword">const</span> = 0; |
| <a name="l00208"></a>00208 <span class="comment"></span> |
| <a name="l00209"></a>00209 <span class="comment"> /**</span> |
| <a name="l00210"></a>00210 <span class="comment"> * This method returns the installed EntityResolver.</span> |
| <a name="l00211"></a>00211 <span class="comment"> *</span> |
| <a name="l00212"></a>00212 <span class="comment"> * @return The pointer to the installed EntityResolver object.</span> |
| <a name="l00213"></a>00213 <span class="comment"> */</span> |
| <a name="l00214"></a>00214 <span class="keyword">virtual</span> EntityResolver* |
| <a name="l00215"></a>00215 getEntityResolver() <span class="keyword">const</span> = 0; |
| <a name="l00216"></a>00216 <span class="comment"></span> |
| <a name="l00217"></a>00217 <span class="comment"> /**</span> |
| <a name="l00218"></a>00218 <span class="comment"> * This method installs the user-specified EntityResolver on the</span> |
| <a name="l00219"></a>00219 <span class="comment"> * parser. It allows applications to trap and redirect calls to</span> |
| <a name="l00220"></a>00220 <span class="comment"> * external entities.</span> |
| <a name="l00221"></a>00221 <span class="comment"> *</span> |
| <a name="l00222"></a>00222 <span class="comment"> * A call to setEntityResolver with a non-null pointer will</span> |
| <a name="l00223"></a>00223 <span class="comment"> * uninstall any XMLEntityResolver previously installed.</span> |
| <a name="l00224"></a>00224 <span class="comment"> *</span> |
| <a name="l00225"></a>00225 <span class="comment"> * @param handler A pointer to the EntityResolver to be called</span> |
| <a name="l00226"></a>00226 <span class="comment"> * when the parser encounters references to</span> |
| <a name="l00227"></a>00227 <span class="comment"> * external entities.</span> |
| <a name="l00228"></a>00228 <span class="comment"> */</span> |
| <a name="l00229"></a>00229 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00230"></a>00230 setEntityResolver(EntityResolver* resolver) = 0; |
| <a name="l00231"></a>00231 <span class="comment"></span> |
| <a name="l00232"></a>00232 <span class="comment"> /**</span> |
| <a name="l00233"></a>00233 <span class="comment"> * This method returns the installed XMLEntityResolver.</span> |
| <a name="l00234"></a>00234 <span class="comment"> *</span> |
| <a name="l00235"></a>00235 <span class="comment"> * @return The pointer to the installed XMLEntityResolver object.</span> |
| <a name="l00236"></a>00236 <span class="comment"> */</span> |
| <a name="l00237"></a>00237 <span class="keyword">virtual</span> XMLEntityResolver* |
| <a name="l00238"></a>00238 getXMLEntityResolver() <span class="keyword">const</span> = 0; |
| <a name="l00239"></a>00239 <span class="comment"></span> |
| <a name="l00240"></a>00240 <span class="comment"> /**</span> |
| <a name="l00241"></a>00241 <span class="comment"> * This method installs the user-specified XMLEntityResolver on the</span> |
| <a name="l00242"></a>00242 <span class="comment"> * parser. It allows applications to trap and redirect calls to</span> |
| <a name="l00243"></a>00243 <span class="comment"> * external entities.</span> |
| <a name="l00244"></a>00244 <span class="comment"> *</span> |
| <a name="l00245"></a>00245 <span class="comment"> * A call to setXMLEntityResolver with a non-null pointer will</span> |
| <a name="l00246"></a>00246 <span class="comment"> * uninstall any EntityResolver previously installed.</span> |
| <a name="l00247"></a>00247 <span class="comment"> *</span> |
| <a name="l00248"></a>00248 <span class="comment"> * @param handler A pointer to the entity resolver to be called</span> |
| <a name="l00249"></a>00249 <span class="comment"> * when the parser encounters references to</span> |
| <a name="l00250"></a>00250 <span class="comment"> * external entities.</span> |
| <a name="l00251"></a>00251 <span class="comment"> */</span> |
| <a name="l00252"></a>00252 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00253"></a>00253 setXMLEntityResolver(XMLEntityResolver* resolver) = 0; |
| <a name="l00254"></a>00254 <span class="comment"></span> |
| <a name="l00255"></a>00255 <span class="comment"> /**</span> |
| <a name="l00256"></a>00256 <span class="comment"> * This method returns the installed error handler.</span> |
| <a name="l00257"></a>00257 <span class="comment"> *</span> |
| <a name="l00258"></a>00258 <span class="comment"> * @return The pointer to the installed error handler object.</span> |
| <a name="l00259"></a>00259 <span class="comment"> */</span> |
| <a name="l00260"></a>00260 <span class="keyword">virtual</span> ErrorHandler* |
| <a name="l00261"></a>00261 getErrorHandler() <span class="keyword">const</span> = 0; |
| <a name="l00262"></a>00262 <span class="comment"></span> |
| <a name="l00263"></a>00263 <span class="comment"> /**</span> |
| <a name="l00264"></a>00264 <span class="comment"> * This method installs the user-specified error handler.</span> |
| <a name="l00265"></a>00265 <span class="comment"> *</span> |
| <a name="l00266"></a>00266 <span class="comment"> * @param handler A pointer to the error handler to be called upon error.</span> |
| <a name="l00267"></a>00267 <span class="comment"> */</span> |
| <a name="l00268"></a>00268 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00269"></a>00269 setErrorHandler(ErrorHandler* handler) = 0; |
| <a name="l00270"></a>00270 |
| <a name="l00271"></a>00271 <span class="comment">// A utility class for classes to use.</span> |
| <a name="l00272"></a><a class="code" href="classXMLParserLiaison_1_1EnsureResetErrorHandler.html">00272</a> <span class="keyword">class </span><a class="code" href="classXMLParserLiaison_1_1EnsureResetErrorHandler.html">EnsureResetErrorHandler</a> |
| <a name="l00273"></a>00273 { |
| <a name="l00274"></a>00274 <span class="keyword">public</span>: |
| <a name="l00275"></a>00275 |
| <a name="l00276"></a><a class="code" href="classXMLParserLiaison_1_1EnsureResetErrorHandler.html#ab889c3f6405dbb4eb3fe4264b1534515">00276</a> <a class="code" href="classXMLParserLiaison_1_1EnsureResetErrorHandler.html">EnsureResetErrorHandler</a>( |
| <a name="l00277"></a>00277 XMLParserLiaison* theLiaison = 0, |
| <a name="l00278"></a>00278 ErrorHandler* theErrorHandler = 0) : |
| <a name="l00279"></a>00279 m_liaison(theLiaison), |
| <a name="l00280"></a>00280 m_errorHandler(theErrorHandler) |
| <a name="l00281"></a>00281 { |
| <a name="l00282"></a>00282 <span class="keywordflow">if</span> (theLiaison != 0) |
| <a name="l00283"></a>00283 { |
| <a name="l00284"></a>00284 theLiaison->setErrorHandler(theErrorHandler); |
| <a name="l00285"></a>00285 } |
| <a name="l00286"></a>00286 } |
| <a name="l00287"></a>00287 |
| <a name="l00288"></a><a class="code" href="classXMLParserLiaison_1_1EnsureResetErrorHandler.html#a453c57b1759a0ca7c9cdd19548690f30">00288</a> ~<a class="code" href="classXMLParserLiaison_1_1EnsureResetErrorHandler.html">EnsureResetErrorHandler</a>() |
| <a name="l00289"></a>00289 { |
| <a name="l00290"></a>00290 <span class="keywordflow">if</span> (m_liaison != 0) |
| <a name="l00291"></a>00291 { |
| <a name="l00292"></a>00292 m_liaison->setErrorHandler(m_errorHandler); |
| <a name="l00293"></a>00293 } |
| <a name="l00294"></a>00294 } |
| <a name="l00295"></a>00295 |
| <a name="l00296"></a>00296 <span class="keywordtype">void</span> |
| <a name="l00297"></a><a class="code" href="classXMLParserLiaison_1_1EnsureResetErrorHandler.html#a1b0b9bb2cd5c833ae55618660250bbd4">00297</a> <span class="keyword">set</span>( |
| <a name="l00298"></a>00298 XMLParserLiaison* theLiaison, |
| <a name="l00299"></a>00299 ErrorHandler* theErrorHandler) |
| <a name="l00300"></a>00300 { |
| <a name="l00301"></a>00301 m_liaison = theLiaison; |
| <a name="l00302"></a>00302 |
| <a name="l00303"></a>00303 m_errorHandler = theErrorHandler; |
| <a name="l00304"></a>00304 |
| <a name="l00305"></a>00305 <span class="keywordflow">if</span> (theLiaison != 0) |
| <a name="l00306"></a>00306 { |
| <a name="l00307"></a>00307 theLiaison->setErrorHandler(theErrorHandler); |
| <a name="l00308"></a>00308 } |
| <a name="l00309"></a>00309 } |
| <a name="l00310"></a>00310 |
| <a name="l00311"></a>00311 <span class="keyword">private</span>: |
| <a name="l00312"></a>00312 |
| <a name="l00313"></a>00313 XMLParserLiaison* m_liaison; |
| <a name="l00314"></a>00314 |
| <a name="l00315"></a>00315 ErrorHandler* m_errorHandler; |
| <a name="l00316"></a>00316 }; |
| <a name="l00317"></a>00317 |
| <a name="l00318"></a>00318 <span class="keyword">protected</span>: |
| <a name="l00319"></a>00319 |
| <a name="l00320"></a>00320 <span class="comment">// A utility class for derived classes to use.</span> |
| <a name="l00321"></a><a class="code" href="classXMLParserLiaison_1_1EnsureDestroyDocument.html">00321</a> <span class="keyword">class </span><a class="code" href="classXMLParserLiaison_1_1EnsureDestroyDocument.html">EnsureDestroyDocument</a> |
| <a name="l00322"></a>00322 { |
| <a name="l00323"></a>00323 <span class="keyword">public</span>: |
| <a name="l00324"></a>00324 |
| <a name="l00325"></a><a class="code" href="classXMLParserLiaison_1_1EnsureDestroyDocument.html#aa13dbe22e7241e7b788fcc0c12a69e66">00325</a> <a class="code" href="classXMLParserLiaison_1_1EnsureDestroyDocument.html">EnsureDestroyDocument</a>( |
| <a name="l00326"></a>00326 XMLParserLiaison& theLiaison, |
| <a name="l00327"></a>00327 XalanDocument* theDocument) : |
| <a name="l00328"></a>00328 m_liaison(theLiaison), |
| <a name="l00329"></a>00329 m_document(theDocument) |
| <a name="l00330"></a>00330 { |
| <a name="l00331"></a>00331 } |
| <a name="l00332"></a>00332 |
| <a name="l00333"></a><a class="code" href="classXMLParserLiaison_1_1EnsureDestroyDocument.html#ab11533e3483becd2ba64b7721fcb117c">00333</a> ~<a class="code" href="classXMLParserLiaison_1_1EnsureDestroyDocument.html">EnsureDestroyDocument</a>() |
| <a name="l00334"></a>00334 { |
| <a name="l00335"></a>00335 <span class="keywordflow">if</span> (m_document != 0) |
| <a name="l00336"></a>00336 { |
| <a name="l00337"></a>00337 m_liaison.destroyDocument(m_document); |
| <a name="l00338"></a>00338 } |
| <a name="l00339"></a>00339 } |
| <a name="l00340"></a>00340 |
| <a name="l00341"></a>00341 XalanDocument* |
| <a name="l00342"></a><a class="code" href="classXMLParserLiaison_1_1EnsureDestroyDocument.html#a73714cf4f7d499d1b0bb943886b89669">00342</a> <span class="keyword">get</span>() <span class="keyword">const</span> |
| <a name="l00343"></a>00343 { |
| <a name="l00344"></a>00344 <span class="keywordflow">return</span> m_document; |
| <a name="l00345"></a>00345 } |
| <a name="l00346"></a>00346 |
| <a name="l00347"></a>00347 XalanDocument* |
| <a name="l00348"></a><a class="code" href="classXMLParserLiaison_1_1EnsureDestroyDocument.html#ab9669c45fbaa95956c65f63a78e4f920">00348</a> release() |
| <a name="l00349"></a>00349 { |
| <a name="l00350"></a>00350 XalanDocument* theDocument = m_document; |
| <a name="l00351"></a>00351 |
| <a name="l00352"></a>00352 m_document = 0; |
| <a name="l00353"></a>00353 |
| <a name="l00354"></a>00354 <span class="keywordflow">return</span> theDocument; |
| <a name="l00355"></a>00355 } |
| <a name="l00356"></a>00356 |
| <a name="l00357"></a>00357 <span class="keyword">private</span>: |
| <a name="l00358"></a>00358 |
| <a name="l00359"></a>00359 XMLParserLiaison& m_liaison; |
| <a name="l00360"></a>00360 |
| <a name="l00361"></a>00361 XalanDocument* m_document; |
| <a name="l00362"></a>00362 }; |
| <a name="l00363"></a>00363 |
| <a name="l00364"></a>00364 <span class="keyword">private</span>: |
| <a name="l00365"></a>00365 |
| <a name="l00366"></a>00366 <span class="comment">// Not implemented</span> |
| <a name="l00367"></a>00367 XMLParserLiaison(<span class="keyword">const</span> XMLParserLiaison&); |
| <a name="l00368"></a>00368 |
| <a name="l00369"></a>00369 XMLParserLiaison& |
| <a name="l00370"></a>00370 operator=(<span class="keyword">const</span> XMLParserLiaison&); |
| <a name="l00371"></a>00371 }; |
| <a name="l00372"></a>00372 |
| <a name="l00373"></a>00373 |
| <a name="l00374"></a>00374 |
| <a name="l00375"></a>00375 XALAN_CPP_NAMESPACE_END |
| <a name="l00376"></a>00376 |
| <a name="l00377"></a>00377 |
| <a name="l00378"></a>00378 |
| <a name="l00379"></a>00379 <span class="preprocessor">#endif // XMLPARSERLIAISON_HEADER_GUARD_1357924680</span> |
| </pre></div></div> |
| </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 © 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> |
