<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>pyxb.binding.saxer.PyXBSAXHandler</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="pyxb-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>PyXB hosted on <a href="http://sourceforge.net/projects/pyxb"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=263147&type=9" width="80" height="15" alt="Get PyXB: Python XML Schema Bindings at SourceForge.net. Fast, secure and Free Open Source software downloads"/></a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="pyxb-module.html">Package pyxb</a> ::
<a href="pyxb.binding-module.html">Package binding</a> ::
<a href="pyxb.binding.saxer-module.html">Module saxer</a> ::
Class PyXBSAXHandler
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="pyxb.binding.saxer.PyXBSAXHandler-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class PyXBSAXHandler</h1><p class="nomargin-top"><span class="codelink"><a href="pyxb.binding.saxer-pysrc.html#PyXBSAXHandler">source code</a></span></p>
<pre class="base-tree">
xml.sax.handler.ContentHandler --+
|
object --+
|
<a href="pyxb.utils.saxutils.BaseSAXHandler-class.html">utils.saxutils.BaseSAXHandler</a> --+
|
<strong class="uidshort">PyXBSAXHandler</strong>
</pre>
<hr />
<p>A SAX handler class which generates a binding instance for a document
through a streaming parser.</p>
<p>An example of using this to parse the document held in the string
<code>xmls</code> is:</p>
<pre class="literalblock">
import pyxb.binding.saxer
import StringIO
saxer = pyxb.binding.saxer.make_parser()
handler = saxer.getContentHandler()
saxer.parse(StringIO.StringIO(xml))
instance = handler.rootObject()
</pre>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxb.binding.saxer.PyXBSAXHandler-class.html#rootObject" class="summary-sig-name">rootObject</a>(<span class="summary-sig-arg">self</span>)</span><br />
Return the binding object corresponding to the top-most element in
the document</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.saxer-pysrc.html#PyXBSAXHandler.rootObject">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxb.binding.saxer.PyXBSAXHandler-class.html#reset" class="summary-sig-name">reset</a>(<span class="summary-sig-arg">self</span>)</span><br />
Reset the state of the handler in preparation for processing a new
document.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.saxer-pysrc.html#PyXBSAXHandler.reset">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxb.binding.saxer.PyXBSAXHandler-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**kw</span>)</span><br />
Create a parser instance for converting XML to bindings.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.saxer-pysrc.html#PyXBSAXHandler.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxb.binding.saxer.PyXBSAXHandler-class.html#startElementNS" class="summary-sig-name">startElementNS</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">qname</span>,
<span class="summary-sig-arg">attrs</span>)</span><br />
Process the start of an element.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.saxer-pysrc.html#PyXBSAXHandler.startElementNS">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxb.binding.saxer.PyXBSAXHandler-class.html#endElementNS" class="summary-sig-name">endElementNS</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">qname</span>)</span><br />
Process the completion of an element.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.saxer-pysrc.html#PyXBSAXHandler.endElementNS">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyxb.utils.saxutils.BaseSAXHandler-class.html">utils.saxutils.BaseSAXHandler</a></code></b>:
<code><a href="pyxb.utils.saxutils.BaseSAXHandler-class.html#characters">characters</a></code>,
<code><a href="pyxb.utils.saxutils.BaseSAXHandler-class.html#elementState">elementState</a></code>,
<code><a href="pyxb.utils.saxutils.BaseSAXHandler-class.html#ignorableWhitespace">ignorableWhitespace</a></code>,
<code><a href="pyxb.utils.saxutils.BaseSAXHandler-class.html#namespaceContext">namespaceContext</a></code>,
<code><a href="pyxb.utils.saxutils.BaseSAXHandler-class.html#processingInstruction">processingInstruction</a></code>,
<code><a href="pyxb.utils.saxutils.BaseSAXHandler-class.html#setDocumentLocator">setDocumentLocator</a></code>,
<code><a href="pyxb.utils.saxutils.BaseSAXHandler-class.html#startDocument">startDocument</a></code>,
<code><a href="pyxb.utils.saxutils.BaseSAXHandler-class.html#startPrefixMapping">startPrefixMapping</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>xml.sax.handler.ContentHandler</code></b>:
<code>endDocument</code>,
<code>endElement</code>,
<code>endPrefixMapping</code>,
<code>skippedEntity</code>,
<code>startElement</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__trace"></a><span class="summary-name">__trace</span> = <code title="False">False</code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="pyxb.binding.saxer.PyXBSAXHandler-class.html#__XSITypeTuple" class="summary-name" onclick="show_private();">__XSITypeTuple</a> = <code title="('http://www.w3.org/2001/XMLSchema-instance', 'type')"><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">http://www.w3.org/2001/XMLSchema-instance</code><code class="variable-quote">'</code><code class="variable-op">,</code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__domHandler"></a><span class="summary-name">__domHandler</span> = <code title="None">None</code><br />
hash(x)
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__domDepth"></a><span class="summary-name">__domDepth</span> = <code title="None">None</code><br />
hash(x)
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__rootObject"></a><span class="summary-name">__rootObject</span> = <code title="None">None</code><br />
hash(x)
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="rootObject"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">rootObject</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.saxer-pysrc.html#PyXBSAXHandler.rootObject">source code</a></span>
</td>
</tr></table>
<p>Return the binding object corresponding to the top-most element in the
document</p>
<dl class="fields">
<dt>Returns:</dt>
<dd>An instance of <a
href="pyxb.binding.basis._TypeBinding_mixin-class.html"
class="link"
onclick="show_private();">basis._TypeBinding_mixin</a> (most
usually a <a
href="pyxb.binding.basis.complexTypeDefinition-class.html"
class="link">basis.complexTypeDefinition</a>.</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="pyxb.exceptions_.UnrecognizedElementError-class.html">pyxb.UnrecognizedElementError</a></strong></code> - No binding could be found to match the top-level element in the
document.</li>
</ul></dd>
<dt>Overrides:
<a href="pyxb.utils.saxutils.BaseSAXHandler-class.html#rootObject">utils.saxutils.BaseSAXHandler.rootObject</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="reset"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">reset</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.saxer-pysrc.html#PyXBSAXHandler.reset">source code</a></span>
</td>
</tr></table>
<p>Reset the state of the handler in preparation for processing a new
document.</p>
<dl class="fields">
<dt>Returns:</dt>
<dd><code>self</code></dd>
<dt>Overrides:
<a href="pyxb.utils.saxutils.BaseSAXHandler-class.html#reset">utils.saxutils.BaseSAXHandler.reset</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**kw</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.saxer-pysrc.html#PyXBSAXHandler.__init__">source code</a></span>
</td>
</tr></table>
<p>Create a parser instance for converting XML to bindings.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>element_state_constructor</code></strong> - Overridden with the value <a
href="pyxb.binding.saxer._SAXElementState-class.html"
class="link" onclick="show_private();">_SAXElementState</a>
before invoking the <a
href="pyxb.utils.saxutils.BaseSAXHandler-class.html#__init__"
class="link">superclass constructor</a>.</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="startElementNS"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">startElementNS</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">qname</span>,
<span class="sig-arg">attrs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.saxer-pysrc.html#PyXBSAXHandler.startElementNS">source code</a></span>
</td>
</tr></table>
<p>Process the start of an element.</p>
<dl class="fields">
<dt>Overrides:
xml.sax.handler.ContentHandler.startElementNS
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="endElementNS"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">endElementNS</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">qname</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.saxer-pysrc.html#PyXBSAXHandler.endElementNS">source code</a></span>
</td>
</tr></table>
<p>Process the completion of an element.</p>
<dl class="fields">
<dt>Overrides:
xml.sax.handler.ContentHandler.endElementNS
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
<a name="section-ClassVariableDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variable Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariableDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__XSITypeTuple"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">__XSITypeTuple</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">http://www.w3.org/2001/XMLSchema-instance</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">type</code><code class="variable-quote">'</code><code class="variable-group">)</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="pyxb-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>PyXB hosted on <a href="http://sourceforge.net/projects/pyxb"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=263147&type=9" width="80" height="15" alt="Get PyXB: Python XML Schema Bindings at SourceForge.net. Fast, secure and Free Open Source software downloads"/></a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sun May 30 12:40:30 2010
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
