xmldompulldom.tex 1.52 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
\section{\module{xml.dom.pulldom} ---
         Support for building partial DOM trees}

\declaremodule{standard}{xml.dom.pulldom}
\modulesynopsis{Support for building partial DOM trees from SAX events.}
\moduleauthor{Paul Prescod}{paul@prescod.net}

\versionadded{2.0}

\module{xml.dom.pulldom} allows building only selected portions of a
Document Object Model representation of a document from SAX events.


\begin{classdesc}{PullDOM}{\optional{documentFactory}}
  \class{xml.sax.handler.ContentHandler} implementation that ...
\end{classdesc}


\begin{classdesc}{DOMEventStream}{stream, parser, bufsize}
  ...
\end{classdesc}


\begin{classdesc}{SAX2DOM}{\optional{documentFactory}}
  \class{xml.sax.handler.ContentHandler} implementation that ...
\end{classdesc}


\begin{funcdesc}{parse}{stream_or_string\optional{,
                        parser\optional{, bufsize}}}
  ...
\end{funcdesc}


\begin{funcdesc}{parseString}{string\optional{, parser}}
  ...
\end{funcdesc}


\begin{datadesc}{default_bufsize}
Fredrik Lundh's avatar
Fredrik Lundh committed
41
  Default value for the \var{bufsize} parameter to \function{parse()}.
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
  \versionchanged[The value of this variable can be changed before
                  calling \function{parse()} and the new value will
                  take effect]{2.1}
\end{datadesc}


\subsection{DOMEventStream Objects \label{domeventstream-objects}}


\begin{methoddesc}[DOMEventStream]{getEvent}{}
  ...
\end{methoddesc}

\begin{methoddesc}[DOMEventStream]{expandNode}{node}
  ...
\end{methoddesc}

\begin{methoddesc}[DOMEventStream]{reset}{}
  ...
\end{methoddesc}