\section{DOM::Entity Class Reference}
\label{classDOM_1_1Entity}\index{DOM::Entity@{DOM::Entity}}
This interface represents an entity, either parsed or unparsed, in an XML document.  


{\tt \#include $<$dom\_\-xml.h$>$}

Inheritance diagram for DOM::Entity:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=53pt]{classDOM_1_1Entity__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for DOM::Entity:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=53pt]{classDOM_1_1Entity__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Entity} (const {\bf Entity} \&other)\label{classDOM_1_1Entity_a1}

\item 
{\bf Entity} (const {\bf Node} \&other)\label{classDOM_1_1Entity_a2}

\item 
{\bf Entity} \& {\bf operator=} (const {\bf Node} \&other)\label{classDOM_1_1Entity_a3}

\item 
{\bf Entity} \& {\bf operator=} (const {\bf Entity} \&other)\label{classDOM_1_1Entity_a4}

\item 
{\bf DOMString} {\bf public\-Id} () const 
\item 
{\bf DOMString} {\bf system\-Id} () const 
\item 
{\bf DOMString} {\bf notation\-Name} () const 
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
{\bf Entity} (Entity\-Impl $\ast$i)\label{classDOM_1_1Entity_b0}

\end{CompactItemize}


\subsection{Detailed Description}
This interface represents an entity, either parsed or unparsed, in an XML document. 

Note that this models the entity itself not the entity declaration. {\tt {\bf Entity}{\rm (p.\,\pageref{classDOM_1_1Entity})}} declaration modeling has been left for a later Level of the {\bf DOM}{\rm (p.\,\pageref{namespaceDOM})} specification.

The {\tt node\-Name} attribute that is inherited from {\tt {\bf Node}{\rm (p.\,\pageref{classDOM_1_1Node})}} contains the name of the entity.

An XML processor may choose to completely expand entities before the structure model is passed to the {\bf DOM}{\rm (p.\,\pageref{namespaceDOM})}; in this case there will be no {\tt {\bf Entity\-Reference}{\rm (p.\,\pageref{classDOM_1_1EntityReference})}} nodes in the document tree.

XML does not mandate that a non-validating XML processor read and process entity declarations made in the external subset or declared in external parameter entities. This means that parsed entities declared in the external subset need not be expanded by some classes of applications, and that the replacement value of the entity may not be available. When the replacement value is available, the corresponding {\tt {\bf Entity}{\rm (p.\,\pageref{classDOM_1_1Entity})}} node's child list represents the structure of that replacement text. Otherwise, the child list is empty.

The resolution of the children of the {\tt {\bf Entity}{\rm (p.\,\pageref{classDOM_1_1Entity})}} (the replacement value) may be lazily evaluated; actions by the user (such as calling the {\tt child\-Nodes} method on the {\tt {\bf Entity}{\rm (p.\,\pageref{classDOM_1_1Entity})}} {\bf Node}{\rm (p.\,\pageref{classDOM_1_1Node})}) are assumed to trigger the evaluation.

The {\bf DOM}{\rm (p.\,\pageref{namespaceDOM})} Level 1 does not support editing {\tt {\bf Entity}{\rm (p.\,\pageref{classDOM_1_1Entity})}} nodes; if a user wants to make changes to the contents of an {\tt {\bf Entity}{\rm (p.\,\pageref{classDOM_1_1Entity})}} , every related {\tt {\bf Entity\-Reference}{\rm (p.\,\pageref{classDOM_1_1EntityReference})}} node has to be replaced in the structure model by a clone of the {\tt {\bf Entity}{\rm (p.\,\pageref{classDOM_1_1Entity})}} 's contents, and then the desired changes must be made to each of those clones instead. All the descendants of an {\tt {\bf Entity}{\rm (p.\,\pageref{classDOM_1_1Entity})}} node are readonly.

An {\tt {\bf Entity}{\rm (p.\,\pageref{classDOM_1_1Entity})}} node does not have any parent. 



Definition at line 124 of file dom\_\-xml.h.

\subsection{Member Function Documentation}
\index{DOM::Entity@{DOM::Entity}!publicId@{publicId}}
\index{publicId@{publicId}!DOM::Entity@{DOM::Entity}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf DOMString} Entity::public\-Id () const}\label{classDOM_1_1Entity_a6}


The public identifier associated with the entity, if specified. 

If the public identifier was not specified, this is {\tt null} . 

Definition at line 100 of file dom\_\-xml.cpp.\index{DOM::Entity@{DOM::Entity}!systemId@{systemId}}
\index{systemId@{systemId}!DOM::Entity@{DOM::Entity}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf DOMString} Entity::system\-Id () const}\label{classDOM_1_1Entity_a7}


The system identifier associated with the entity, if specified. 

If the system identifier was not specified, this is {\tt null} . 

Definition at line 108 of file dom\_\-xml.cpp.\index{DOM::Entity@{DOM::Entity}!notationName@{notationName}}
\index{notationName@{notationName}!DOM::Entity@{DOM::Entity}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf DOMString} Entity::notation\-Name () const}\label{classDOM_1_1Entity_a8}


For unparsed entities, the name of the notation for the entity. 

For parsed entities, this is {\tt null} . 

Definition at line 116 of file dom\_\-xml.cpp.

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
dom\_\-xml.h\item 
dom\_\-xml.cpp\end{CompactItemize}
