Google Git
Sign in
apache / xalan-site / 4279effacee2ebacf30f00b46c22db2aacb59b72 / . / old / xalan-c / apiDocs / classProblemListener.html
blob: 011eb382290d5aacd0e180af59027ce9f3bdd260 [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ProblemListener Class Reference</h1>This is the abstract class that the XSL processor uses when it has a problem of some kind, that requires a message, an error or a warning.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="ProblemListener_8hpp-source.html">ProblemListener.hpp</a>&gt;</code>
<p>
Inheritance diagram for ProblemListener:<p><center><img src="classProblemListener__inherit__graph.gif" border="0" usemap="#ProblemListener_inherit_map" alt="Inheritance graph"></center>
<map name="ProblemListener_inherit_map">
<area href="classProblemListenerDefault.html" shape="rect" coords="7,117,159,93">
<area href="classXalanTransformerProblemListener.html" shape="rect" coords="183,117,398,93">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classProblemListener-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>enum <a class="el" href="classProblemListener.html#s6">eProblemSource</a> { <a class="el" href="classProblemListener.html#s6s0">eXMLPARSER</a> = 1,
<a class="el" href="classProblemListener.html#s6s1">eXSLPROCESSOR</a> = 2,
<a class="el" href="classProblemListener.html#s6s2">eXPATH</a> = 3
}
<dl class="el"><dd><font size=-1><em>Sources of problem.</em> <a href="#s6">More...</a><em><br><br></em></font></dl><li>enum <a class="el" href="classProblemListener.html#s7">eClassification</a> { <a class="el" href="classProblemListener.html#s7s3">eMESSAGE</a> = 0,
<a class="el" href="classProblemListener.html#s7s4">eWARNING</a> = 1,
<a class="el" href="classProblemListener.html#s7s5">eERROR</a> = 2
}
<dl class="el"><dd><font size=-1><em>Severity of problem.</em> <a href="#s7">More...</a><em><br><br></em></font></dl></ul>
<h2>Public Methods</h2>
<ul>
<li><a class="el" href="classProblemListener.html#a0">ProblemListener</a> ()
<li>virtual <a class="el" href="classProblemListener.html#a1">~ProblemListener</a> ()
<li>virtual void <a class="el" href="classProblemListener.html#a2">setPrintWriter</a> (<a class="el" href="classPrintWriter.html">PrintWriter</a> *pw)=0
<dl class="el"><dd><font size=-1><em>Set the print writer to which the problem is reported.</em> <a href="#a2">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classProblemListener.html#a3">problem</a> (<a class="el" href="classProblemListener.html#s6">eProblemSource</a> where, <a class="el" href="classProblemListener.html#s7">eClassification</a> classification, const <a class="el" href="classXalanNode.html">XalanNode</a> *sourceNode, const <a class="el" href="classElemTemplateElement.html">ElemTemplateElement</a> *styleNode, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;msg, const XalanDOMChar *uri, int lineNo, int charOffset)=0
<dl class="el"><dd><font size=-1><em><a class="el" href="classFunction.html">Function</a> that is called when a problem event occurs.</em> <a href="#a3">More...</a><em><br><br></em></font></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is the abstract class that the XSL processor uses when it has a problem of some kind, that requires a message, an error or a warning.
<p>
Users should ask the <a class="el" href="classXSLTProcessor.html">XSLTProcessor</a> class to setProblemListener if they wish an object instance to be called when a problem event occurs.
<p>
<hr><h2>Member Enumeration Documentation</h2>
<a name="s7" doxytag="ProblemListener::eClassification"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
enum ProblemListener::eClassification
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Severity of problem.
<p>
<dl compact><dt>
<b>Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><a name="s7s3" doxytag="eMESSAGE"></a><em>eMESSAGE</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s7s4" doxytag="eWARNING"></a><em>eWARNING</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s7s5" doxytag="eERROR"></a><em>eERROR</em>
&nbsp;</td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="s6" doxytag="ProblemListener::eProblemSource"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
enum ProblemListener::eProblemSource
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Sources of problem.
<p>
<dl compact><dt>
<b>Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><a name="s6s0" doxytag="eXMLPARSER"></a><em>eXMLPARSER</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s6s1" doxytag="eXSLPROCESSOR"></a><em>eXSLPROCESSOR</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s6s2" doxytag="eXPATH"></a><em>eXPATH</em>
&nbsp;</td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="ProblemListener::ProblemListener"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
ProblemListener::ProblemListener (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="ProblemListener::~ProblemListener"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
ProblemListener::~ProblemListener (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="ProblemListener::problem"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void ProblemListener::problem (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classProblemListener.html#s6">eProblemSource</a> <em>where</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classProblemListener.html#s7">eClassification</a> <em>classification</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanNode.html">XalanNode</a> * <em>sourceNode</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classElemTemplateElement.html">ElemTemplateElement</a> * <em>styleNode</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>msg</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const XalanDOMChar * <em>uri</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>lineNo</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int <em>charOffset</em>&nbsp;)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<a class="el" href="classFunction.html">Function</a> that is called when a problem event occurs.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>where</em>
&nbsp;</td><td>
either in XMLPARSER, XSLPROCESSOR, or QUERYENGINE </td></tr>
<tr><td valign=top><em>classification</em>
&nbsp;</td><td>
either MESSAGE, ERROR or WARNING </td></tr>
<tr><td valign=top><em>sourceNode</em>
&nbsp;</td><td>
source tree node where the problem occurred (may be 0) </td></tr>
<tr><td valign=top><em>styleNode</em>
&nbsp;</td><td>
style tree node where the problem occurred (may be 0) </td></tr>
<tr><td valign=top><em>msg</em>
&nbsp;</td><td>
string message explaining the problem. </td></tr>
<tr><td valign=top><em>uri</em>
&nbsp;</td><td>
the URI of the document where the problem occurred. May be 0. </td></tr>
<tr><td valign=top><em>lineNo</em>
&nbsp;</td><td>
line number where the problem occurred. </td></tr>
<tr><td valign=top><em>charOffset</em>
&nbsp;</td><td>
character offset where the problem. </td></tr>
</table>
</dl>
<p>
Reimplemented in <a class="el" href="classXalanTransformerProblemListener.html#a3">XalanTransformerProblemListener</a>, and <a class="el" href="classProblemListenerDefault.html#a3">ProblemListenerDefault</a>. </td>
</tr>
</table>
<a name="a2" doxytag="ProblemListener::setPrintWriter"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void ProblemListener::setPrintWriter (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classPrintWriter.html">PrintWriter</a> * <em>pw</em>&nbsp;)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the print writer to which the problem is reported.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pw</em>
&nbsp;</td><td>
writer to receive messages </td></tr>
</table>
</dl>
<p>
Reimplemented in <a class="el" href="classXalanTransformerProblemListener.html#a2">XalanTransformerProblemListener</a>, and <a class="el" href="classProblemListenerDefault.html#a2">ProblemListenerDefault</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ProblemListener_8hpp-source.html">ProblemListener.hpp</a></ul>
<p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">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="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<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.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>