source: NonGTP/Xerces/xerces/doc/html/apiDocs/classXMLEntityDecl.html @ 358

Revision 358, 52.6 KB checked in by bittner, 19 years ago (diff)

xerces added
Line 
1<HTML><HEAD><SCRIPT language="JavaScript" src="../resources/script.js" type="text/javascript"></SCRIPT><TITLE>XMLEntityDecl class Reference</TITLE><link href="XercesApi.css" rel="stylesheet" type="text/css"></HEAD><BODY alink="#ff0000" bgcolor="#ffffff" leftmargin="4" link="#0000ff" marginheight="4" marginwidth="4" text="#000000" topmargin="4" vlink="#0000aa"><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" height="60" rowspan="3" valign="top" width="135"><IMG border="0" height="60" hspace="0" src="../resources/logo.gif" vspace="0" width="135"></TD><TD align="left" colspan="4" height="5" valign="top" width="456"><IMG border="0" height="5" hspace="0" src="../resources/line.gif" vspace="0" width="456"></TD><TD align="left" height="60" rowspan="3" valign="top" width="29"><IMG border="0" height="60" hspace="0" src="../resources/right.gif" vspace="0" width="29"></TD></TR><TR><TD align="left" bgcolor="#0086b2" colspan="4" height="35" valign="top" width="456"><IMG alt="" border="0" height="35" hspace="0" src="../graphics/api-header.jpg" vspace="0" width="456"></TD></TR><TR><TD align="left" height="20" valign="top" width="168"><IMG border="0" height="20" hspace="0" src="../resources/bottom.gif" vspace="0" width="168"></TD><TD align="left" height="20" valign="top" width="96"><A href="http://xml.apache.org/" onMouseOut="rolloverOff('xml');" onMouseOver="rolloverOn('xml');" target="new"><IMG alt="http://xml.apache.org/" border="0" height="20" hspace="0" name="xml" onLoad="rolloverLoad('xml','../resources/button-xml-hi.gif','../resources/button-xml-lo.gif');" src="../resources/button-xml-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.apache.org/" onMouseOut="rolloverOff('asf');" onMouseOver="rolloverOn('asf');" target="new"><IMG alt="http://www.apache.org/" border="0" height="20" hspace="0" name="asf" onLoad="rolloverLoad('asf','../resources/button-asf-hi.gif','../resources/button-asf-lo.gif');" src="../resources/button-asf-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.w3.org/" onMouseOut="rolloverOff('w3c');" onMouseOver="rolloverOn('w3c');" target="new"><IMG alt="http://www.w3.org/" border="0" height="20" hspace="0" name="w3c" onLoad="rolloverLoad('w3c','../resources/button-w3c-hi.gif','../resources/button-w3c-lo.gif');" src="../resources/button-w3c-lo.gif" vspace="0" width="96"></A></TD></TR></TABLE><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" valign="top" width="120"><IMG border="0" height="14" hspace="0" src="../resources/join.gif" vspace="0" width="120"><BR>
2  <A href="../../index.html" onMouseOut="rolloverOff('side-ext-2');" onMouseOver="rolloverOn('side-ext-2');"><IMG alt="Home" border="0" height="12" hspace="0" name="side-ext-2" onLoad="rolloverLoad('side-ext-2','../graphics/ext-2-label-2.jpg','../graphics/ext-2-label-3.jpg');" src="../graphics/ext-2-label-3.jpg" vspace="0" width="120"></A><BR>
3
4  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
5
6  <A href="../index.html" onMouseOut="rolloverOff('side-index');" onMouseOver="rolloverOn('side-index');"><IMG alt="Readme" border="0" height="12" hspace="0" name="side-index" onLoad="rolloverLoad('side-index','../graphics/index-label-2.jpg','../graphics/index-label-3.jpg');" src="../graphics/index-label-3.jpg" vspace="0" width="120"></A><BR>
7  <A href="../releases.html" onMouseOut="rolloverOff('side-releases');" onMouseOver="rolloverOn('side-releases');"><IMG alt="Release Info" border="0" height="12" hspace="0" name="side-releases" onLoad="rolloverLoad('side-releases','../graphics/releases-label-2.jpg','../graphics/releases-label-3.jpg');" src="../graphics/releases-label-3.jpg" vspace="0" width="120"></A><BR>
8  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
9  <A href="../install.html" onMouseOut="rolloverOff('side-install');" onMouseOver="rolloverOn('side-install');"><IMG alt="Installation" border="0" height="12" hspace="0" name="side-install" onLoad="rolloverLoad('side-install','../graphics/install-label-2.jpg','../graphics/install-label-3.jpg');" src="../graphics/install-label-3.jpg" vspace="0" width="120"></A><BR>
10  <A href="http://xml.apache.org/dist/xerces-c/" onMouseOut="rolloverOff('side-ext-18');" onMouseOver="rolloverOn('side-ext-18');"><IMG alt="Download" border="0" height="12" hspace="0" name="side-ext-18" onLoad="rolloverLoad('side-ext-18','../graphics/ext-18-label-2.jpg','../graphics/ext-18-label-3.jpg');" src="../graphics/ext-18-label-3.jpg" vspace="0" width="120"></A><BR>
11  <A href="../build.html" onMouseOut="rolloverOff('side-build');" onMouseOver="rolloverOn('side-build');"><IMG alt="Build" border="0" height="12" hspace="0" name="side-build" onLoad="rolloverLoad('side-build','../graphics/build-label-2.jpg','../graphics/build-label-3.jpg');" src="../graphics/build-label-3.jpg" vspace="0" width="120"></A><BR>
12
13  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
14  <A href="../faqs.html" onMouseOut="rolloverOff('side-faqs');" onMouseOver="rolloverOn('side-faqs');"><IMG alt="FAQs" border="0" height="12" hspace="0" name="side-faqs" onLoad="rolloverLoad('side-faqs','../graphics/faqs-label-2.jpg','../graphics/faqs-label-3.jpg');" src="../graphics/faqs-label-3.jpg" vspace="0" width="120"></A><BR> 
15  <A href="../samples.html" onMouseOut="rolloverOff('side-samples');" onMouseOver="rolloverOn('side-samples');"><IMG alt="Samples" border="0" height="12" hspace="0" name="side-samples" onLoad="rolloverLoad('side-samples','../graphics/samples-label-2.jpg','../graphics/samples-label-3.jpg');" src="../graphics/samples-label-3.jpg" vspace="0" width="120"></A><BR>
16  <A href="../api.html" onMouseOut="rolloverOff('side-api');" onMouseOver="rolloverOn('side-api');"><IMG alt="API Docs" border="0" height="12" hspace="0" name="side-api" onLoad="rolloverLoad('side-api','../graphics/api-label-2.jpg','../graphics/api-label-3.jpg');" src="../graphics/api-label-3.jpg" vspace="0" width="120"></A><BR> 
17
18  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> 
19  <A href="../ApacheDOMC++Binding.html" onMouseOut="rolloverOff('side-ext-68');" onMouseOver="rolloverOn('side-ext-68');"><IMG alt="DOM C++ Binding" border="0" height="12" hspace="0" name="side-ext-68" onLoad="rolloverLoad('side-ext-68','../graphics/ext-68-label-2.jpg','../graphics/ext-68-label-3.jpg');" src="../graphics/ext-68-label-3.jpg" vspace="0" width="120"></A><BR>
20
21  <A href="../program.html" onMouseOut="rolloverOff('side-program');" onMouseOver="rolloverOn('side-program');"><IMG alt="Programming" border="0" height="12" hspace="0" name="side-program" onLoad="rolloverLoad('side-program','../graphics/program-label-2.jpg','../graphics/program-label-3.jpg');" src="../graphics/program-label-3.jpg" vspace="0" width="120"></A><BR>
22  <A href="../migrate.html" onMouseOut="rolloverOff('side-migrate');" onMouseOver="rolloverOn('side-migrate');"><IMG alt="Migration Guide" border="0" height="12" hspace="0" name="side-migrate" onLoad="rolloverLoad('side-migrate','../graphics/migrate-label-2.jpg','../graphics/migrate-label-3.jpg');" src="../graphics/migrate-label-3.jpg" vspace="0" width="120"></A><BR>
23
24  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
25
26  <A href="../feedback.html" onMouseOut="rolloverOff('side-feedback');" onMouseOver="rolloverOn('side-feedback');"><IMG alt="Feedback" border="0" height="12" hspace="0" name="side-feedback" onLoad="rolloverLoad('side-feedback','../graphics/feedback-label-2.jpg','../graphics/feedback-label-3.jpg');" src="../graphics/feedback-label-3.jpg" vspace="0" width="120"></A><BR>
27  <A href="../bug-report.html" onMouseOut="rolloverOff('side-bug-report');" onMouseOver="rolloverOn('side-bug-report');"><IMG alt="Bug-Reporting" border="0" height="12" hspace="0" name="side-bug-report" onLoad="rolloverLoad('side-bug-report','../graphics/bug-report-label-2.jpg','../graphics/bug-report-label-3.jpg');" src="../graphics/bug-report-label-3.jpg" vspace="0" width="120"></A><BR> 
28  <A href="../pdf.html" onMouseOut="rolloverOff('side-pdf');" onMouseOver="rolloverOn('side-pdf');"><IMG alt="PDF Document" border="0" height="12" hspace="0" name="side-pdf" onLoad="rolloverLoad('side-pdf','../graphics/pdf-label-2.jpg','../graphics/pdf-label-3.jpg');" src="../graphics/pdf-label-3.jpg" vspace="0" width="120"></A><BR>
29
30  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
31
32  <A href="http://xml.apache.org/websrc/cvsweb.cgi/xml-xerces/c/" onMouseOut="rolloverOff('side-ext-100');" onMouseOver="rolloverOn('side-ext-100');"><IMG alt="CVS Repository" border="0" height="12" hspace="0" name="side-ext-100" onLoad="rolloverLoad('side-ext-100','../graphics/ext-100-label-2.jpg','../graphics/ext-100-label-3.jpg');" src="../graphics/ext-100-label-3.jpg" vspace="0" width="120"></A><BR>
33
34  <A href="http://marc.theaimsgroup.com/?l=xerces-c-dev" onMouseOut="rolloverOff('side-ext-102');" onMouseOver="rolloverOn('side-ext-102');"><IMG alt="Mail Archive" border="0" height="12" hspace="0" name="side-ext-102" onLoad="rolloverLoad('side-ext-102','../graphics/ext-102-label-2.jpg','../graphics/ext-102-label-3.jpg');" src="../graphics/ext-102-label-3.jpg" vspace="0" width="120"></A><BR>
35
36
37<IMG border="0" height="14" hspace="0" src="../resources/close.gif" vspace="0" width="120"><BR></TD><TD align="left" valign="top" width="500"><TABLE border="0" cellpadding="3" cellspacing="0"><TR><TD>
38    <TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#FFFFFF" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="../resources/void.gif" vspace="0" width="2"><B>API Docs for SAX and DOM</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
39
40            <P>
41<!-- Generated by Doxygen 1.2.14 -->
42<center>
43<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>
44<hr><h1>XMLEntityDecl  Class Reference</h1>This class defines that core information that defines an XML entity, no matter what validator is used.
45<a href="#_details">More...</a>
46<p>
47Inheritance diagram for XMLEntityDecl:<p><center><img src="classXMLEntityDecl__inherit__graph.gif" border="0" usemap="#XMLEntityDecl__inherit__map" alt="Inheritance graph"></center>
48<map name="XMLEntityDecl__inherit__map">
49<area href="classXMemory.html" shape="rect" coords="23,36,92,17" alt="">
50</map>
51<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XMLEntityDecl:<p><center><img src="classXMLEntityDecl__coll__graph.gif" border="0" usemap="#XMLEntityDecl__coll__map" alt="Collaboration graph"></center>
52<map name="XMLEntityDecl__coll__map">
53<area href="classXMemory.html" shape="rect" coords="7,36,76,17" alt="">
54<area href="classMemoryManager.html" shape="rect" coords="100,36,209,17" alt="">
55</map>
56<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXMLEntityDecl-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
57<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
58<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#a0">setId</a> (const unsigned int newId)</td></tr>
59<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
60<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z267_0">XMLEntityDecl</a> (<a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
61<tr><td>&nbsp;</td><td><font size=-1><em>Deafult Constructor.</em> <a href="#z267_0">More...</a><em></em></font><br><br></td></tr>
62<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z267_1">XMLEntityDecl</a> (const XMLCh *const entName, <a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
63<tr><td>&nbsp;</td><td><font size=-1><em>Constructor with a const entity name.</em> <a href="#z267_1">More...</a><em></em></font><br><br></td></tr>
64<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z267_2">XMLEntityDecl</a> (const XMLCh *const entName, const XMLCh *const value, <a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
65<tr><td>&nbsp;</td><td><font size=-1><em>Constructor with a const entity name and value.</em> <a href="#z267_2">More...</a><em></em></font><br><br></td></tr>
66<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z267_3">XMLEntityDecl</a> (const XMLCh *const entName, const XMLCh value, <a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
67<tr><td>&nbsp;</td><td><font size=-1><em>Constructor with a const entity name and single XMLCh value.</em> <a href="#z267_3">More...</a><em></em></font><br><br></td></tr>
68<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
69<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z268_0">~XMLEntityDecl</a> ()</td></tr>
70<tr><td>&nbsp;</td><td><font size=-1><em>Default destructor.</em> <a href="#z268_0">More...</a><em></em></font><br><br></td></tr>
71<tr><td colspan="2"><div class="groupHeader">The pure virtual methods in this interface.</div></td></tr>
72<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z269_0">getDeclaredInIntSubset</a> () const=0</td></tr>
73<tr><td>&nbsp;</td><td><font size=-1><em>Get the 'declared in internal subset' flag.</em> <a href="#z269_0">More...</a><em></em></font><br><br></td></tr>
74<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z269_1">getIsParameter</a> () const=0</td></tr>
75<tr><td>&nbsp;</td><td><font size=-1><em>Get the 'is parameter entity' flag.</em> <a href="#z269_1">More...</a><em></em></font><br><br></td></tr>
76<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z269_2">getIsSpecialChar</a> () const=0</td></tr>
77<tr><td>&nbsp;</td><td><font size=-1><em>Get the 'is special char entity' flag.</em> <a href="#z269_2">More...</a><em></em></font><br><br></td></tr>
78<tr><td colspan="2"><div class="groupHeader">Getter methods</div></td></tr>
79<tr><td nowrap align=right valign=top>unsigned int&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z270_0">getId</a> () const</td></tr>
80<tr><td>&nbsp;</td><td><font size=-1><em>Gets the pool id of this entity.</em> <a href="#z270_0">More...</a><em></em></font><br><br></td></tr>
81<tr><td nowrap align=right valign=top>const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z270_1">getName</a> () const</td></tr>
82<tr><td>&nbsp;</td><td><font size=-1><em>Returns a const pointer to the name of this entity decl.</em> <a href="#z270_1">More...</a><em></em></font><br><br></td></tr>
83<tr><td nowrap align=right valign=top>const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z270_2">getNotationName</a> () const</td></tr>
84<tr><td>&nbsp;</td><td><font size=-1><em>Gets the notation name, if any, declared for this entity.</em> <a href="#z270_2">More...</a><em></em></font><br><br></td></tr>
85<tr><td nowrap align=right valign=top>const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z270_3">getPublicId</a> () const</td></tr>
86<tr><td>&nbsp;</td><td><font size=-1><em>Gets the public id declared for this entity.</em> <a href="#z270_3">More...</a><em></em></font><br><br></td></tr>
87<tr><td nowrap align=right valign=top>const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z270_4">getSystemId</a> () const</td></tr>
88<tr><td>&nbsp;</td><td><font size=-1><em>Gets the system id declared for this entity.</em> <a href="#z270_4">More...</a><em></em></font><br><br></td></tr>
89<tr><td nowrap align=right valign=top>const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z270_5">getBaseURI</a> () const</td></tr>
90<tr><td>&nbsp;</td><td><font size=-1><em>Gets the base URI for this entity.</em> <a href="#z270_5">More...</a><em></em></font><br><br></td></tr>
91<tr><td nowrap align=right valign=top>const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z270_6">getValue</a> () const</td></tr>
92<tr><td>&nbsp;</td><td><font size=-1><em>This method returns the value of an internal entity.</em> <a href="#z270_6">More...</a><em></em></font><br><br></td></tr>
93<tr><td nowrap align=right valign=top>unsigned int&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z270_7">getValueLen</a> () const</td></tr>
94<tr><td>&nbsp;</td><td><font size=-1><em>This method returns the number of characters in the value returned by <a class="el" href="classXMLEntityDecl.html#z270_6">getValue</a>().</em> <a href="#z270_7">More...</a><em></em></font><br><br></td></tr>
95<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z270_8">isExternal</a> () const</td></tr>
96<tr><td>&nbsp;</td><td><font size=-1><em>Indicates that this entity is an external entity.</em> <a href="#z270_8">More...</a><em></em></font><br><br></td></tr>
97<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z270_9">isUnparsed</a> () const</td></tr>
98<tr><td>&nbsp;</td><td><font size=-1><em>Indicates whether this entity is unparsed.</em> <a href="#z270_9">More...</a><em></em></font><br><br></td></tr>
99<tr><td nowrap align=right valign=top><a class="el" href="classMemoryManager.html">MemoryManager</a> *&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z270_10">getMemoryManager</a> () const</td></tr>
100<tr><td>&nbsp;</td><td><font size=-1><em>Get the plugged-in memory manager.</em> <a href="#z270_10">More...</a><em></em></font><br><br></td></tr>
101<tr><td colspan="2"><div class="groupHeader">Setter methods</div></td></tr>
102<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z271_0">setName</a> (const XMLCh *const entName)</td></tr>
103<tr><td>&nbsp;</td><td><font size=-1><em>This method will set the entity name.</em> <a href="#z271_0">More...</a><em></em></font><br><br></td></tr>
104<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z271_1">setNotationName</a> (const XMLCh *const newName)</td></tr>
105<tr><td>&nbsp;</td><td><font size=-1><em>This method will set the notation name for this entity.</em> <a href="#z271_1">More...</a><em></em></font><br><br></td></tr>
106<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z271_2">setPublicId</a> (const XMLCh *const newId)</td></tr>
107<tr><td>&nbsp;</td><td><font size=-1><em>This method will set a new public id on this entity.</em> <a href="#z271_2">More...</a><em></em></font><br><br></td></tr>
108<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z271_3">setSystemId</a> (const XMLCh *const newId)</td></tr>
109<tr><td>&nbsp;</td><td><font size=-1><em>This method will set a new sysetm id on this entity.</em> <a href="#z271_3">More...</a><em></em></font><br><br></td></tr>
110<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z271_4">setBaseURI</a> (const XMLCh *const newId)</td></tr>
111<tr><td>&nbsp;</td><td><font size=-1><em>This method will set a new baseURI on this entity.</em> <a href="#z271_4">More...</a><em></em></font><br><br></td></tr>
112<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z271_5">setValue</a> (const XMLCh *const newValue)</td></tr>
113<tr><td>&nbsp;</td><td><font size=-1><em>This method will set a new value for this entity.</em> <a href="#z271_5">More...</a><em></em></font><br><br></td></tr>
114<tr><td colspan="2"><div class="groupHeader">Setter methods</div></td></tr>
115<tr><td nowrap align=right valign=top>const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classXMLEntityDecl.html#z272_0">getKey</a> () const</td></tr>
116<tr><td>&nbsp;</td><td><font size=-1><em>This method allows objects of this class to be used within a standard keyed collection used commonly within the parser system.</em> <a href="#z272_0">More...</a><em></em></font><br><br></td></tr>
117</table>
118<hr><a name="_details"></a><h2>Detailed Description</h2>
119This class defines that core information that defines an XML entity, no matter what validator is used.
120<p>
121Each validator will create a derivative of this class which adds any extra information it requires.
122<p>
123This class supports keyed collection semantics via the <a class="el" href="classXMLEntityDecl.html#z272_0">getKey</a>() method which extracts the key field, the entity name in this case. The name will have whatever form is deemed appropriate for the type of validator in use.
124<p>
125When setting the fields of this class, you must make sure that you do not set conflicting values. For instance, an internal entity cannot have a notation name. And an external entity cannot have a value string. These rules are defined by the XML specification. In most cases, these objects are created by validator objects as they parse a DTD or Schema or whatever, at which time they confirm the correctness of the data before creating the entity decl object.
126<p>
127<hr><h2>Constructor &amp; Destructor Documentation</h2>
128<a name="z267_0" doxytag="XMLEntityDecl::XMLEntityDecl"></a><p>
129<table width="100%" cellpadding="2" cellspacing="0" border="0">
130  <tr>
131    <td class="md">
132      <table cellpadding="0" cellspacing="0" border="0">
133        <tr>
134          <td class="md" nowrap valign="top"> XMLEntityDecl::XMLEntityDecl </td>
135          <td class="md" valign="top">(&nbsp;</td>
136          <td class="md" nowrap valign="top"><a class="el" href="classMemoryManager.html">MemoryManager</a> *const&nbsp;</td>
137          <td class="mdname1" valign="top" nowrap>&nbsp; <em>manager</em> = <a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a>          </td>
138          <td class="md" valign="top">)&nbsp;</td>
139          <td class="md" nowrap></td>
140        </tr>
141
142      </table>
143    </td>
144  </tr>
145</table>
146<table cellspacing=5 cellpadding=0 border=0>
147  <tr>
148    <td>
149      &nbsp;
150    </td>
151    <td>
152
153<p>
154Deafult Constructor.
155<p>
156    </td>
157  </tr>
158</table>
159<a name="z267_1" doxytag="XMLEntityDecl::XMLEntityDecl"></a><p>
160<table width="100%" cellpadding="2" cellspacing="0" border="0">
161  <tr>
162    <td class="md">
163      <table cellpadding="0" cellspacing="0" border="0">
164        <tr>
165          <td class="md" nowrap valign="top"> XMLEntityDecl::XMLEntityDecl </td>
166          <td class="md" valign="top">(&nbsp;</td>
167          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
168          <td class="mdname" nowrap>&nbsp; <em>entName</em>, </td>
169        </tr>
170        <tr>
171          <td></td>
172          <td></td>
173          <td class="md" nowrap><a class="el" href="classMemoryManager.html">MemoryManager</a> *const&nbsp;</td>
174          <td class="mdname" nowrap>&nbsp; <em>manager</em> = <a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a></td>
175        </tr>
176        <tr>
177          <td></td>
178          <td class="md">)&nbsp;</td>
179          <td class="md" colspan="2"></td>
180        </tr>
181
182      </table>
183    </td>
184  </tr>
185</table>
186<table cellspacing=5 cellpadding=0 border=0>
187  <tr>
188    <td>
189      &nbsp;
190    </td>
191    <td>
192
193<p>
194Constructor with a const entity name.
195<p>
196<dl compact><dt><b>
197Parameters: </b><dd>
198<table border=0 cellspacing=2 cellpadding=0>
199<tr><td valign=top><em>entName</em>&nbsp;</td><td>
200The new name to give to this entity. </td></tr>
201<tr><td valign=top><em>manager</em>&nbsp;</td><td>
202Pointer to the memory manager to be used to allocate objects. </td></tr>
203</table>
204</dl>    </td>
205  </tr>
206</table>
207<a name="z267_2" doxytag="XMLEntityDecl::XMLEntityDecl"></a><p>
208<table width="100%" cellpadding="2" cellspacing="0" border="0">
209  <tr>
210    <td class="md">
211      <table cellpadding="0" cellspacing="0" border="0">
212        <tr>
213          <td class="md" nowrap valign="top"> XMLEntityDecl::XMLEntityDecl </td>
214          <td class="md" valign="top">(&nbsp;</td>
215          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
216          <td class="mdname" nowrap>&nbsp; <em>entName</em>, </td>
217        </tr>
218        <tr>
219          <td></td>
220          <td></td>
221          <td class="md" nowrap>const XMLCh *const&nbsp;</td>
222          <td class="mdname" nowrap>&nbsp; <em>value</em>, </td>
223        </tr>
224        <tr>
225          <td></td>
226          <td></td>
227          <td class="md" nowrap><a class="el" href="classMemoryManager.html">MemoryManager</a> *const&nbsp;</td>
228          <td class="mdname" nowrap>&nbsp; <em>manager</em> = <a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a></td>
229        </tr>
230        <tr>
231          <td></td>
232          <td class="md">)&nbsp;</td>
233          <td class="md" colspan="2"></td>
234        </tr>
235
236      </table>
237    </td>
238  </tr>
239</table>
240<table cellspacing=5 cellpadding=0 border=0>
241  <tr>
242    <td>
243      &nbsp;
244    </td>
245    <td>
246
247<p>
248Constructor with a const entity name and value.
249<p>
250<dl compact><dt><b>
251Parameters: </b><dd>
252<table border=0 cellspacing=2 cellpadding=0>
253<tr><td valign=top><em>entName</em>&nbsp;</td><td>
254The new name to give to this entity. </td></tr>
255<tr><td valign=top><em>value</em>&nbsp;</td><td>
256The new value to give to this entity name. </td></tr>
257<tr><td valign=top><em>manager</em>&nbsp;</td><td>
258Pointer to the memory manager to be used to allocate objects. </td></tr>
259</table>
260</dl>    </td>
261  </tr>
262</table>
263<a name="z267_3" doxytag="XMLEntityDecl::XMLEntityDecl"></a><p>
264<table width="100%" cellpadding="2" cellspacing="0" border="0">
265  <tr>
266    <td class="md">
267      <table cellpadding="0" cellspacing="0" border="0">
268        <tr>
269          <td class="md" nowrap valign="top"> XMLEntityDecl::XMLEntityDecl </td>
270          <td class="md" valign="top">(&nbsp;</td>
271          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
272          <td class="mdname" nowrap>&nbsp; <em>entName</em>, </td>
273        </tr>
274        <tr>
275          <td></td>
276          <td></td>
277          <td class="md" nowrap>const XMLCh&nbsp;</td>
278          <td class="mdname" nowrap>&nbsp; <em>value</em>, </td>
279        </tr>
280        <tr>
281          <td></td>
282          <td></td>
283          <td class="md" nowrap><a class="el" href="classMemoryManager.html">MemoryManager</a> *const&nbsp;</td>
284          <td class="mdname" nowrap>&nbsp; <em>manager</em> = <a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a></td>
285        </tr>
286        <tr>
287          <td></td>
288          <td class="md">)&nbsp;</td>
289          <td class="md" colspan="2"></td>
290        </tr>
291
292      </table>
293    </td>
294  </tr>
295</table>
296<table cellspacing=5 cellpadding=0 border=0>
297  <tr>
298    <td>
299      &nbsp;
300    </td>
301    <td>
302
303<p>
304Constructor with a const entity name and single XMLCh value.
305<p>
306<dl compact><dt><b>
307Parameters: </b><dd>
308<table border=0 cellspacing=2 cellpadding=0>
309<tr><td valign=top><em>entName</em>&nbsp;</td><td>
310The new name to give to this entity. </td></tr>
311<tr><td valign=top><em>value</em>&nbsp;</td><td>
312The new value to give to this entity name. </td></tr>
313<tr><td valign=top><em>manager</em>&nbsp;</td><td>
314Pointer to the memory manager to be used to allocate objects. </td></tr>
315</table>
316</dl>    </td>
317  </tr>
318</table>
319<a name="z268_0" doxytag="XMLEntityDecl::~XMLEntityDecl"></a><p>
320<table width="100%" cellpadding="2" cellspacing="0" border="0">
321  <tr>
322    <td class="md">
323      <table cellpadding="0" cellspacing="0" border="0">
324        <tr>
325          <td class="md" nowrap valign="top"> virtual XMLEntityDecl::~XMLEntityDecl </td>
326          <td class="md" valign="top">(&nbsp;</td>
327          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
328          <td class="md" valign="top">)&nbsp;</td>
329          <td class="md" nowrap><code> [virtual]</code></td>
330        </tr>
331
332      </table>
333    </td>
334  </tr>
335</table>
336<table cellspacing=5 cellpadding=0 border=0>
337  <tr>
338    <td>
339      &nbsp;
340    </td>
341    <td>
342
343<p>
344Default destructor.
345<p>
346    </td>
347  </tr>
348</table>
349<hr><h2>Member Function Documentation</h2>
350<a name="z270_5" doxytag="XMLEntityDecl::getBaseURI"></a><p>
351<table width="100%" cellpadding="2" cellspacing="0" border="0">
352  <tr>
353    <td class="md">
354      <table cellpadding="0" cellspacing="0" border="0">
355        <tr>
356          <td class="md" nowrap valign="top"> const XMLCh * XMLEntityDecl::getBaseURI </td>
357          <td class="md" valign="top">(&nbsp;</td>
358          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
359          <td class="md" valign="top">)&nbsp;</td>
360          <td class="md" nowrap> const</td>
361        </tr>
362
363      </table>
364    </td>
365  </tr>
366</table>
367<table cellspacing=5 cellpadding=0 border=0>
368  <tr>
369    <td>
370      &nbsp;
371    </td>
372    <td>
373
374<p>
375Gets the base URI for this entity.
376<p>
377    </td>
378  </tr>
379</table>
380<a name="z269_0" doxytag="XMLEntityDecl::getDeclaredInIntSubset"></a><p>
381<table width="100%" cellpadding="2" cellspacing="0" border="0">
382  <tr>
383    <td class="md">
384      <table cellpadding="0" cellspacing="0" border="0">
385        <tr>
386          <td class="md" nowrap valign="top"> virtual bool XMLEntityDecl::getDeclaredInIntSubset </td>
387          <td class="md" valign="top">(&nbsp;</td>
388          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
389          <td class="md" valign="top">)&nbsp;</td>
390          <td class="md" nowrap> const<code> [pure virtual]</code></td>
391        </tr>
392
393      </table>
394    </td>
395  </tr>
396</table>
397<table cellspacing=5 cellpadding=0 border=0>
398  <tr>
399    <td>
400      &nbsp;
401    </td>
402    <td>
403
404<p>
405Get the 'declared in internal subset' flag.
406<p>
407Gets the state of the flag which indicates whether the entity was declared in the internal or external subset. Some structural description languages might not have an internal subset concept, in which case this will always return false.     </td>
408  </tr>
409</table>
410<a name="z270_0" doxytag="XMLEntityDecl::getId"></a><p>
411<table width="100%" cellpadding="2" cellspacing="0" border="0">
412  <tr>
413    <td class="md">
414      <table cellpadding="0" cellspacing="0" border="0">
415        <tr>
416          <td class="md" nowrap valign="top"> unsigned int XMLEntityDecl::getId </td>
417          <td class="md" valign="top">(&nbsp;</td>
418          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
419          <td class="md" valign="top">)&nbsp;</td>
420          <td class="md" nowrap> const</td>
421        </tr>
422
423      </table>
424    </td>
425  </tr>
426</table>
427<table cellspacing=5 cellpadding=0 border=0>
428  <tr>
429    <td>
430      &nbsp;
431    </td>
432    <td>
433
434<p>
435Gets the pool id of this entity.
436<p>
437Validators maintain all decls in pools, from which they can be quickly extracted via id.     </td>
438  </tr>
439</table>
440<a name="z269_1" doxytag="XMLEntityDecl::getIsParameter"></a><p>
441<table width="100%" cellpadding="2" cellspacing="0" border="0">
442  <tr>
443    <td class="md">
444      <table cellpadding="0" cellspacing="0" border="0">
445        <tr>
446          <td class="md" nowrap valign="top"> virtual bool XMLEntityDecl::getIsParameter </td>
447          <td class="md" valign="top">(&nbsp;</td>
448          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
449          <td class="md" valign="top">)&nbsp;</td>
450          <td class="md" nowrap> const<code> [pure virtual]</code></td>
451        </tr>
452
453      </table>
454    </td>
455  </tr>
456</table>
457<table cellspacing=5 cellpadding=0 border=0>
458  <tr>
459    <td>
460      &nbsp;
461    </td>
462    <td>
463
464<p>
465Get the 'is parameter entity' flag.
466<p>
467Gets the state of the flag which indicates whether this entity is a parameter entity. If not, then its a general entity.     </td>
468  </tr>
469</table>
470<a name="z269_2" doxytag="XMLEntityDecl::getIsSpecialChar"></a><p>
471<table width="100%" cellpadding="2" cellspacing="0" border="0">
472  <tr>
473    <td class="md">
474      <table cellpadding="0" cellspacing="0" border="0">
475        <tr>
476          <td class="md" nowrap valign="top"> virtual bool XMLEntityDecl::getIsSpecialChar </td>
477          <td class="md" valign="top">(&nbsp;</td>
478          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
479          <td class="md" valign="top">)&nbsp;</td>
480          <td class="md" nowrap> const<code> [pure virtual]</code></td>
481        </tr>
482
483      </table>
484    </td>
485  </tr>
486</table>
487<table cellspacing=5 cellpadding=0 border=0>
488  <tr>
489    <td>
490      &nbsp;
491    </td>
492    <td>
493
494<p>
495Get the 'is special char entity' flag.
496<p>
497Gets the state of the flag that indicates whether this entity is one of the special, intrinsically supported character entities.     </td>
498  </tr>
499</table>
500<a name="z272_0" doxytag="XMLEntityDecl::getKey"></a><p>
501<table width="100%" cellpadding="2" cellspacing="0" border="0">
502  <tr>
503    <td class="md">
504      <table cellpadding="0" cellspacing="0" border="0">
505        <tr>
506          <td class="md" nowrap valign="top"> const XMLCh * XMLEntityDecl::getKey </td>
507          <td class="md" valign="top">(&nbsp;</td>
508          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
509          <td class="md" valign="top">)&nbsp;</td>
510          <td class="md" nowrap> const</td>
511        </tr>
512
513      </table>
514    </td>
515  </tr>
516</table>
517<table cellspacing=5 cellpadding=0 border=0>
518  <tr>
519    <td>
520      &nbsp;
521    </td>
522    <td>
523
524<p>
525This method allows objects of this class to be used within a standard keyed collection used commonly within the parser system.
526<p>
527The collection calls this method to get the key (usually to hash it) by which the object is to be stored.     </td>
528  </tr>
529</table>
530<a name="z270_10" doxytag="XMLEntityDecl::getMemoryManager"></a><p>
531<table width="100%" cellpadding="2" cellspacing="0" border="0">
532  <tr>
533    <td class="md">
534      <table cellpadding="0" cellspacing="0" border="0">
535        <tr>
536          <td class="md" nowrap valign="top"> <a class="el" href="classMemoryManager.html">MemoryManager</a> * XMLEntityDecl::getMemoryManager </td>
537          <td class="md" valign="top">(&nbsp;</td>
538          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
539          <td class="md" valign="top">)&nbsp;</td>
540          <td class="md" nowrap> const</td>
541        </tr>
542
543      </table>
544    </td>
545  </tr>
546</table>
547<table cellspacing=5 cellpadding=0 border=0>
548  <tr>
549    <td>
550      &nbsp;
551    </td>
552    <td>
553
554<p>
555Get the plugged-in memory manager.
556<p>
557This method returns the plugged-in memory manager user for dynamic memory allocation/deallocation.
558<p>
559<dl compact><dt><b>
560Returns: </b><dd>
561the plugged-in memory manager </dl>    </td>
562  </tr>
563</table>
564<a name="z270_1" doxytag="XMLEntityDecl::getName"></a><p>
565<table width="100%" cellpadding="2" cellspacing="0" border="0">
566  <tr>
567    <td class="md">
568      <table cellpadding="0" cellspacing="0" border="0">
569        <tr>
570          <td class="md" nowrap valign="top"> const XMLCh * XMLEntityDecl::getName </td>
571          <td class="md" valign="top">(&nbsp;</td>
572          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
573          <td class="md" valign="top">)&nbsp;</td>
574          <td class="md" nowrap> const</td>
575        </tr>
576
577      </table>
578    </td>
579  </tr>
580</table>
581<table cellspacing=5 cellpadding=0 border=0>
582  <tr>
583    <td>
584      &nbsp;
585    </td>
586    <td>
587
588<p>
589Returns a const pointer to the name of this entity decl.
590<p>
591This name will be in whatever format is appropriate for the type of validator in use.     </td>
592  </tr>
593</table>
594<a name="z270_2" doxytag="XMLEntityDecl::getNotationName"></a><p>
595<table width="100%" cellpadding="2" cellspacing="0" border="0">
596  <tr>
597    <td class="md">
598      <table cellpadding="0" cellspacing="0" border="0">
599        <tr>
600          <td class="md" nowrap valign="top"> const XMLCh * XMLEntityDecl::getNotationName </td>
601          <td class="md" valign="top">(&nbsp;</td>
602          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
603          <td class="md" valign="top">)&nbsp;</td>
604          <td class="md" nowrap> const</td>
605        </tr>
606
607      </table>
608    </td>
609  </tr>
610</table>
611<table cellspacing=5 cellpadding=0 border=0>
612  <tr>
613    <td>
614      &nbsp;
615    </td>
616    <td>
617
618<p>
619Gets the notation name, if any, declared for this entity.
620<p>
621If this entity is not a notation type entity, it will be a null pointer.     </td>
622  </tr>
623</table>
624<a name="z270_3" doxytag="XMLEntityDecl::getPublicId"></a><p>
625<table width="100%" cellpadding="2" cellspacing="0" border="0">
626  <tr>
627    <td class="md">
628      <table cellpadding="0" cellspacing="0" border="0">
629        <tr>
630          <td class="md" nowrap valign="top"> const XMLCh * XMLEntityDecl::getPublicId </td>
631          <td class="md" valign="top">(&nbsp;</td>
632          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
633          <td class="md" valign="top">)&nbsp;</td>
634          <td class="md" nowrap> const</td>
635        </tr>
636
637      </table>
638    </td>
639  </tr>
640</table>
641<table cellspacing=5 cellpadding=0 border=0>
642  <tr>
643    <td>
644      &nbsp;
645    </td>
646    <td>
647
648<p>
649Gets the public id declared for this entity.
650<p>
651Public ids are optional so it can be a null pointer.     </td>
652  </tr>
653</table>
654<a name="z270_4" doxytag="XMLEntityDecl::getSystemId"></a><p>
655<table width="100%" cellpadding="2" cellspacing="0" border="0">
656  <tr>
657    <td class="md">
658      <table cellpadding="0" cellspacing="0" border="0">
659        <tr>
660          <td class="md" nowrap valign="top"> const XMLCh * XMLEntityDecl::getSystemId </td>
661          <td class="md" valign="top">(&nbsp;</td>
662          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
663          <td class="md" valign="top">)&nbsp;</td>
664          <td class="md" nowrap> const</td>
665        </tr>
666
667      </table>
668    </td>
669  </tr>
670</table>
671<table cellspacing=5 cellpadding=0 border=0>
672  <tr>
673    <td>
674      &nbsp;
675    </td>
676    <td>
677
678<p>
679Gets the system id declared for this entity.
680<p>
681The system id is required so this method should never return a null pointers.     </td>
682  </tr>
683</table>
684<a name="z270_6" doxytag="XMLEntityDecl::getValue"></a><p>
685<table width="100%" cellpadding="2" cellspacing="0" border="0">
686  <tr>
687    <td class="md">
688      <table cellpadding="0" cellspacing="0" border="0">
689        <tr>
690          <td class="md" nowrap valign="top"> const XMLCh * XMLEntityDecl::getValue </td>
691          <td class="md" valign="top">(&nbsp;</td>
692          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
693          <td class="md" valign="top">)&nbsp;</td>
694          <td class="md" nowrap> const</td>
695        </tr>
696
697      </table>
698    </td>
699  </tr>
700</table>
701<table cellspacing=5 cellpadding=0 border=0>
702  <tr>
703    <td>
704      &nbsp;
705    </td>
706    <td>
707
708<p>
709This method returns the value of an internal entity.
710<p>
711If this is not an internal entity (i.e. its external), then this will be a null pointer.     </td>
712  </tr>
713</table>
714<a name="z270_7" doxytag="XMLEntityDecl::getValueLen"></a><p>
715<table width="100%" cellpadding="2" cellspacing="0" border="0">
716  <tr>
717    <td class="md">
718      <table cellpadding="0" cellspacing="0" border="0">
719        <tr>
720          <td class="md" nowrap valign="top"> unsigned int XMLEntityDecl::getValueLen </td>
721          <td class="md" valign="top">(&nbsp;</td>
722          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
723          <td class="md" valign="top">)&nbsp;</td>
724          <td class="md" nowrap> const</td>
725        </tr>
726
727      </table>
728    </td>
729  </tr>
730</table>
731<table cellspacing=5 cellpadding=0 border=0>
732  <tr>
733    <td>
734      &nbsp;
735    </td>
736    <td>
737
738<p>
739This method returns the number of characters in the value returned by <a class="el" href="classXMLEntityDecl.html#z270_6">getValue</a>().
740<p>
741If this entity is external, this will be zero since an external entity has no internal value.     </td>
742  </tr>
743</table>
744<a name="z270_8" doxytag="XMLEntityDecl::isExternal"></a><p>
745<table width="100%" cellpadding="2" cellspacing="0" border="0">
746  <tr>
747    <td class="md">
748      <table cellpadding="0" cellspacing="0" border="0">
749        <tr>
750          <td class="md" nowrap valign="top"> bool XMLEntityDecl::isExternal </td>
751          <td class="md" valign="top">(&nbsp;</td>
752          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
753          <td class="md" valign="top">)&nbsp;</td>
754          <td class="md" nowrap> const</td>
755        </tr>
756
757      </table>
758    </td>
759  </tr>
760</table>
761<table cellspacing=5 cellpadding=0 border=0>
762  <tr>
763    <td>
764      &nbsp;
765    </td>
766    <td>
767
768<p>
769Indicates that this entity is an external entity.
770<p>
771If not, then it is assumed to be an internal entity, suprise.     </td>
772  </tr>
773</table>
774<a name="z270_9" doxytag="XMLEntityDecl::isUnparsed"></a><p>
775<table width="100%" cellpadding="2" cellspacing="0" border="0">
776  <tr>
777    <td class="md">
778      <table cellpadding="0" cellspacing="0" border="0">
779        <tr>
780          <td class="md" nowrap valign="top"> bool XMLEntityDecl::isUnparsed </td>
781          <td class="md" valign="top">(&nbsp;</td>
782          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
783          <td class="md" valign="top">)&nbsp;</td>
784          <td class="md" nowrap> const</td>
785        </tr>
786
787      </table>
788    </td>
789  </tr>
790</table>
791<table cellspacing=5 cellpadding=0 border=0>
792  <tr>
793    <td>
794      &nbsp;
795    </td>
796    <td>
797
798<p>
799Indicates whether this entity is unparsed.
800<p>
801This is meaningless for internal entities. Some external entities are unparsed in that they refer to something other than XML source.     </td>
802  </tr>
803</table>
804<a name="z271_4" doxytag="XMLEntityDecl::setBaseURI"></a><p>
805<table width="100%" cellpadding="2" cellspacing="0" border="0">
806  <tr>
807    <td class="md">
808      <table cellpadding="0" cellspacing="0" border="0">
809        <tr>
810          <td class="md" nowrap valign="top"> void XMLEntityDecl::setBaseURI </td>
811          <td class="md" valign="top">(&nbsp;</td>
812          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
813          <td class="mdname1" valign="top" nowrap>&nbsp; <em>newId</em>          </td>
814          <td class="md" valign="top">)&nbsp;</td>
815          <td class="md" nowrap></td>
816        </tr>
817
818      </table>
819    </td>
820  </tr>
821</table>
822<table cellspacing=5 cellpadding=0 border=0>
823  <tr>
824    <td>
825      &nbsp;
826    </td>
827    <td>
828
829<p>
830This method will set a new baseURI on this entity.
831<p>
832This will then control the URI used to resolve the relative system Id.<dl compact><dt><b>
833Parameters: </b><dd>
834<table border=0 cellspacing=2 cellpadding=0>
835<tr><td valign=top><em>newId</em>&nbsp;</td><td>
836The new base URI to give to the entity. </td></tr>
837</table>
838</dl>    </td>
839  </tr>
840</table>
841<a name="a0" doxytag="XMLEntityDecl::setId"></a><p>
842<table width="100%" cellpadding="2" cellspacing="0" border="0">
843  <tr>
844    <td class="md">
845      <table cellpadding="0" cellspacing="0" border="0">
846        <tr>
847          <td class="md" nowrap valign="top"> void XMLEntityDecl::setId </td>
848          <td class="md" valign="top">(&nbsp;</td>
849          <td class="md" nowrap valign="top">const unsigned int&nbsp;</td>
850          <td class="mdname1" valign="top" nowrap>&nbsp; <em>newId</em>          </td>
851          <td class="md" valign="top">)&nbsp;</td>
852          <td class="md" nowrap></td>
853        </tr>
854
855      </table>
856    </td>
857  </tr>
858</table>
859<table cellspacing=5 cellpadding=0 border=0>
860  <tr>
861    <td>
862      &nbsp;
863    </td>
864    <td>
865
866<p>
867    </td>
868  </tr>
869</table>
870<a name="z271_0" doxytag="XMLEntityDecl::setName"></a><p>
871<table width="100%" cellpadding="2" cellspacing="0" border="0">
872  <tr>
873    <td class="md">
874      <table cellpadding="0" cellspacing="0" border="0">
875        <tr>
876          <td class="md" nowrap valign="top"> void XMLEntityDecl::setName </td>
877          <td class="md" valign="top">(&nbsp;</td>
878          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
879          <td class="mdname1" valign="top" nowrap>&nbsp; <em>entName</em>          </td>
880          <td class="md" valign="top">)&nbsp;</td>
881          <td class="md" nowrap></td>
882        </tr>
883
884      </table>
885    </td>
886  </tr>
887</table>
888<table cellspacing=5 cellpadding=0 border=0>
889  <tr>
890    <td>
891      &nbsp;
892    </td>
893    <td>
894
895<p>
896This method will set the entity name.
897<p>
898The format of this name is defined by the particular validator in use, since it will be the one who creates entity definitions as it parses the DTD, Schema, ect...<dl compact><dt><b>
899Parameters: </b><dd>
900<table border=0 cellspacing=2 cellpadding=0>
901<tr><td valign=top><em>entName</em>&nbsp;</td><td>
902The new name to give to this entity. </td></tr>
903</table>
904</dl>    </td>
905  </tr>
906</table>
907<a name="z271_1" doxytag="XMLEntityDecl::setNotationName"></a><p>
908<table width="100%" cellpadding="2" cellspacing="0" border="0">
909  <tr>
910    <td class="md">
911      <table cellpadding="0" cellspacing="0" border="0">
912        <tr>
913          <td class="md" nowrap valign="top"> void XMLEntityDecl::setNotationName </td>
914          <td class="md" valign="top">(&nbsp;</td>
915          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
916          <td class="mdname1" valign="top" nowrap>&nbsp; <em>newName</em>          </td>
917          <td class="md" valign="top">)&nbsp;</td>
918          <td class="md" nowrap></td>
919        </tr>
920
921      </table>
922    </td>
923  </tr>
924</table>
925<table cellspacing=5 cellpadding=0 border=0>
926  <tr>
927    <td>
928      &nbsp;
929    </td>
930    <td>
931
932<p>
933This method will set the notation name for this entity.
934<p>
935By setting this, you are indicating that this is an unparsed external entity.<dl compact><dt><b>
936Parameters: </b><dd>
937<table border=0 cellspacing=2 cellpadding=0>
938<tr><td valign=top><em>newName</em>&nbsp;</td><td>
939The new notation name to give to this entity. </td></tr>
940</table>
941</dl>    </td>
942  </tr>
943</table>
944<a name="z271_2" doxytag="XMLEntityDecl::setPublicId"></a><p>
945<table width="100%" cellpadding="2" cellspacing="0" border="0">
946  <tr>
947    <td class="md">
948      <table cellpadding="0" cellspacing="0" border="0">
949        <tr>
950          <td class="md" nowrap valign="top"> void XMLEntityDecl::setPublicId </td>
951          <td class="md" valign="top">(&nbsp;</td>
952          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
953          <td class="mdname1" valign="top" nowrap>&nbsp; <em>newId</em>          </td>
954          <td class="md" valign="top">)&nbsp;</td>
955          <td class="md" nowrap></td>
956        </tr>
957
958      </table>
959    </td>
960  </tr>
961</table>
962<table cellspacing=5 cellpadding=0 border=0>
963  <tr>
964    <td>
965      &nbsp;
966    </td>
967    <td>
968
969<p>
970This method will set a new public id on this entity.
971<p>
972The public id has no particular form and is purely for client consumption.<dl compact><dt><b>
973Parameters: </b><dd>
974<table border=0 cellspacing=2 cellpadding=0>
975<tr><td valign=top><em>newId</em>&nbsp;</td><td>
976The new public id to give to this entity. </td></tr>
977</table>
978</dl>    </td>
979  </tr>
980</table>
981<a name="z271_3" doxytag="XMLEntityDecl::setSystemId"></a><p>
982<table width="100%" cellpadding="2" cellspacing="0" border="0">
983  <tr>
984    <td class="md">
985      <table cellpadding="0" cellspacing="0" border="0">
986        <tr>
987          <td class="md" nowrap valign="top"> void XMLEntityDecl::setSystemId </td>
988          <td class="md" valign="top">(&nbsp;</td>
989          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
990          <td class="mdname1" valign="top" nowrap>&nbsp; <em>newId</em>          </td>
991          <td class="md" valign="top">)&nbsp;</td>
992          <td class="md" nowrap></td>
993        </tr>
994
995      </table>
996    </td>
997  </tr>
998</table>
999<table cellspacing=5 cellpadding=0 border=0>
1000  <tr>
1001    <td>
1002      &nbsp;
1003    </td>
1004    <td>
1005
1006<p>
1007This method will set a new sysetm id on this entity.
1008<p>
1009This will then control where the source for this entity lives. If it is an internal entity, then the system id is only for bookkeeping purposes, and to allow any external entities referenced from within the entity to be correctly resolved.<dl compact><dt><b>
1010Parameters: </b><dd>
1011<table border=0 cellspacing=2 cellpadding=0>
1012<tr><td valign=top><em>newId</em>&nbsp;</td><td>
1013The new system id to give to the entity. </td></tr>
1014</table>
1015</dl>    </td>
1016  </tr>
1017</table>
1018<a name="z271_5" doxytag="XMLEntityDecl::setValue"></a><p>
1019<table width="100%" cellpadding="2" cellspacing="0" border="0">
1020  <tr>
1021    <td class="md">
1022      <table cellpadding="0" cellspacing="0" border="0">
1023        <tr>
1024          <td class="md" nowrap valign="top"> void XMLEntityDecl::setValue </td>
1025          <td class="md" valign="top">(&nbsp;</td>
1026          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
1027          <td class="mdname1" valign="top" nowrap>&nbsp; <em>newValue</em>          </td>
1028          <td class="md" valign="top">)&nbsp;</td>
1029          <td class="md" nowrap></td>
1030        </tr>
1031
1032      </table>
1033    </td>
1034  </tr>
1035</table>
1036<table cellspacing=5 cellpadding=0 border=0>
1037  <tr>
1038    <td>
1039      &nbsp;
1040    </td>
1041    <td>
1042
1043<p>
1044This method will set a new value for this entity.
1045<p>
1046This is only valid if the entity is to be an internal entity. By setting this field, you are indicating that the entity is internal.<dl compact><dt><b>
1047Parameters: </b><dd>
1048<table border=0 cellspacing=2 cellpadding=0>
1049<tr><td valign=top><em>newValue</em>&nbsp;</td><td>
1050The new value to give to this entity. </td></tr>
1051</table>
1052</dl>    </td>
1053  </tr>
1054</table>
1055<hr>The documentation for this class was generated from the following file:<ul>
1056<li><a class="el" href="XMLEntityDecl_8hpp-source.html">XMLEntityDecl.hpp</a></ul>
1057    </FONT></TD></TR></TABLE><BR>
1058</TD></TR></TABLE></TD></TR></TABLE><BR><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD bgcolor="#0086b2"><IMG height="1" src="images/dot.gif" width="1" alt=""></TD></TR><TR><TD align="center"><FONT color="#0086b2" size="-1"><I>
1059              Copyright &copy; 1994-2004 The Apache Software Foundation.
1060              All Rights Reserved.
1061            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.