<?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.basis.element</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.basis-module.html">Module basis</a> ::
Class element
</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.basis.element-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class element</h1><p class="nomargin-top"><span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element">source code</a></span></p>
<pre class="base-tree">
object --+
|
<a href="pyxb.utils.utility._DeconflictSymbols_mixin-class.html" onclick="show_private();">utils.utility._DeconflictSymbols_mixin</a> --+
|
object --+ |
| |
<a href="pyxb.cscRoot-class.html">cscRoot</a> --+ |
| |
<a href="pyxb.binding.basis._DynamicCreate_mixin-class.html" onclick="show_private();">_DynamicCreate_mixin</a> --+
|
<strong class="uidshort">element</strong>
</pre>
<hr />
<p>Class that represents a schema element.</p>
<p>Global and local elements are represented by instances of this
class.</p>
<!-- ==================== 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 name="name"></a><span class="summary-sig-name">name</span>(<span class="summary-sig-arg">self</span>)</span><br />
The expanded name of the element within its scope.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.name">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 name="typeDefinition"></a><span class="summary-sig-name">typeDefinition</span>(<span class="summary-sig-arg">self</span>)</span><br />
The <a href="pyxb.binding.basis._TypeBinding_mixin-class.html"
class="link" onclick="show_private();">_TypeBinding_mixin</a>
subclass for values of this element.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.typeDefinition">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.basis.element-class.html#scope" class="summary-sig-name">scope</a>(<span class="summary-sig-arg">self</span>)</span><br />
The scope of the element.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.scope">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 name="nillable"></a><span class="summary-sig-name">nillable</span>(<span class="summary-sig-arg">self</span>)</span><br />
Indicate whether values matching this element can have <a
href="http://www.w3.org/TR/xmlschema-1/#xsi_nil"
target="_top">nil</a> set.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.nillable">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 name="abstract"></a><span class="summary-sig-name">abstract</span>(<span class="summary-sig-arg">self</span>)</span><br />
Indicate whether this element is abstract (must use substitution
group members for matches).</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.abstract">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 name="documentation"></a><span class="summary-sig-name">documentation</span>(<span class="summary-sig-arg">self</span>)</span><br />
Contents of any documentation annotation in the definition.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.documentation">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 name="defaultValue"></a><span class="summary-sig-name">defaultValue</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.defaultValue">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.basis.element-class.html#substitutionGroup" class="summary-sig-name">substitutionGroup</a>(<span class="summary-sig-arg">self</span>)</span><br />
The <a href="pyxb.binding.basis.element-class.html"
class="link">element</a> instance to whose substitution group this
element belongs.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.substitutionGroup">source code</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">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_setSubstitutionGroup"></a><span class="summary-sig-name">_setSubstitutionGroup</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">substitution_group</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element._setSubstitutionGroup">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 name="findSubstituendUse"></a><span class="summary-sig-name">findSubstituendUse</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">ctd_class</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.findSubstituendUse">source code</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">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxb.binding.basis.element-class.html#_real_substitutesFor" class="summary-sig-name" onclick="show_private();">_real_substitutesFor</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Determine whether an instance of this element can substitute for the
other element.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element._real_substitutesFor">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 name="substitutesFor"></a><span class="summary-sig-name">substitutesFor</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Stub replaced by _real_substitutesFor when element supports
substitution groups.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.substitutesFor">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.basis.element-class.html#memberElement" class="summary-sig-name">memberElement</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Return a reference to the element instance used for the given name
within this element.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.memberElement">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.basis.element-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">type_definition</span>,
<span class="summary-sig-arg">scope</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">nillable</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">abstract</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">default_value</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">substitution_group</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">documentation</span>=<span class="summary-sig-default">None</span>)</span><br />
Create a new element binding.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.__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.basis.element-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kw</span>)</span><br />
Invoke the Factory method on the type associated with this element.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.__call__">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.basis.element-class.html#compatibleValue" class="summary-sig-name">compatibleValue</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>,
<span class="summary-sig-arg">**kw</span>)</span><br />
Return a variant of the value that is compatible with this element.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.compatibleValue">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.basis.element-class.html#elementForName" class="summary-sig-name">elementForName</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Return the element that should be used if this element binding is
permitted and an element with the given name is encountered.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.elementForName">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.basis.element-class.html#createFromDOM" class="summary-sig-name">createFromDOM</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">node</span>,
<span class="summary-sig-arg">expanded_name</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">fallback_namespace</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**kw</span>)</span><br />
Create a binding instance from the given DOM node.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.createFromDOM">source code</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">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="pyxb.binding.basis.element-class.html#_createFromDOM" class="summary-sig-name" onclick="show_private();">_createFromDOM</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">node</span>,
<span class="summary-sig-arg">expanded_name</span>,
<span class="summary-sig-arg">**kw</span>)</span><br />
Create a binding instance from the given DOM node, using the provided
name to identify the correct binding.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element._createFromDOM">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.basis.element-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
str(x)</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.__str__">source code</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">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_description"></a><span class="summary-sig-name">_description</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name_only</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">user_documentation</span>=<span class="summary-sig-default">True</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element._description">source code</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>__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>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS METHODS ==================== -->
<a name="section-ClassMethods"></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 Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassMethods"
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 name="AnyCreateFromDOM"></a><span class="summary-sig-name">AnyCreateFromDOM</span>(<span class="summary-sig-arg">cls</span>,
<span class="summary-sig-arg">node</span>,
<span class="summary-sig-arg">_fallback_namespace</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.AnyCreateFromDOM">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyxb.binding.basis._DynamicCreate_mixin-class.html" onclick="show_private();">_DynamicCreate_mixin</a></code></b> (private):
<code><a href="pyxb.binding.basis._DynamicCreate_mixin-class.html#_AlternativeConstructor" onclick="show_private();">_AlternativeConstructor</a></code>,
<code><a href="pyxb.binding.basis._DynamicCreate_mixin-class.html#_DynamicCreate" onclick="show_private();">_DynamicCreate</a></code>,
<code><a href="pyxb.binding.basis._DynamicCreate_mixin-class.html#_DynamicCreate_mixin__AlternativeConstructorAttribute" onclick="show_private();">_DynamicCreate_mixin__AlternativeConstructorAttribute</a></code>,
<code><a href="pyxb.binding.basis._DynamicCreate_mixin-class.html#_DynamicCreate_mixin__SupersedingClassAttribute" onclick="show_private();">_DynamicCreate_mixin__SupersedingClassAttribute</a></code>,
<code><a href="pyxb.binding.basis._DynamicCreate_mixin-class.html#_SetAlternativeConstructor" onclick="show_private();">_SetAlternativeConstructor</a></code>,
<code><a href="pyxb.binding.basis._DynamicCreate_mixin-class.html#_SetSupersedingClass" onclick="show_private();">_SetSupersedingClass</a></code>,
<code><a href="pyxb.binding.basis._DynamicCreate_mixin-class.html#_SupersedingClass" onclick="show_private();">_SupersedingClass</a></code>
</p></div>
</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="__name"></a><span class="summary-name">__name</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="__typeDefinition"></a><span class="summary-name">__typeDefinition</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="__scope"></a><span class="summary-name">__scope</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="__nillable"></a><span class="summary-name">__nillable</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 name="__abstract"></a><span class="summary-name">__abstract</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 name="__documentation"></a><span class="summary-name">__documentation</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="__defaultValue"></a><span class="summary-name">__defaultValue</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="__substitutionGroup"></a><span class="summary-name">__substitutionGroup</span> = <code title="None">None</code><br />
hash(x)
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyxb.utils.utility._DeconflictSymbols_mixin-class.html" onclick="show_private();">utils.utility._DeconflictSymbols_mixin</a></code></b> (private):
<code><a href="pyxb.utils.utility._DeconflictSymbols_mixin-class.html#_ReservedSymbols" onclick="show_private();">_ReservedSymbols</a></code>
</p></div>
</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="scope"></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">scope</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.scope">source code</a></span>
</td>
</tr></table>
<p>The scope of the element. This is either <code>None</code>,
representing a top-level element, or an instance of
<code>complexTypeDefinition</code> for local elements.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="substitutionGroup"></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">substitutionGroup</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.substitutionGroup">source code</a></span>
</td>
</tr></table>
<p>The <a href="pyxb.binding.basis.element-class.html"
class="link">element</a> instance to whose substitution group this
element belongs. <code>None</code> if this element is not part of a
substitution group.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_real_substitutesFor"></a>
<div class="private">
<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">_real_substitutesFor</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">other</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element._real_substitutesFor">source code</a></span>
</td>
</tr></table>
<p>Determine whether an instance of this element can substitute for the
other element.</p>
<p>See <a
href="http://SubstitutionGroupOK<http://www.w3.org/TR/xmlschema-1/#cos-equiv-derived-ok-rec>)"
target="_top">Substitution Group
OK<http://www.w3.org/TR/xmlschema-1/#cos-equiv-derived-ok-rec>)</a>.</p>
<dl class="fields">
</dl>
<div class="fields"> <p><strong>To Do:</strong>
Do something about blocking constraints. This ignores them, as does
everything leading to this point.
</p>
</div></td></tr></table>
</div>
<a name="memberElement"></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">memberElement</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.memberElement">source code</a></span>
</td>
</tr></table>
<p>Return a reference to the element instance used for the given name
within this element.</p>
<p>The type for this element must be a complex type definition.</p>
<dl class="fields">
</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">name</span>,
<span class="sig-arg">type_definition</span>,
<span class="sig-arg">scope</span>=<span class="sig-default">None</span>,
<span class="sig-arg">nillable</span>=<span class="sig-default">False</span>,
<span class="sig-arg">abstract</span>=<span class="sig-default">False</span>,
<span class="sig-arg">default_value</span>=<span class="sig-default">None</span>,
<span class="sig-arg">substitution_group</span>=<span class="sig-default">None</span>,
<span class="sig-arg">documentation</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.__init__">source code</a></span>
</td>
</tr></table>
<p>Create a new element binding.</p>
<dl class="fields">
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="__call__"></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">__call__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">*args</span>,
<span class="sig-arg">**kw</span>)</span>
<br /><em class="fname">(Call operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.__call__">source code</a></span>
</td>
</tr></table>
<p>Invoke the Factory method on the type associated with this
element.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>_dom_node</code></strong> - If set, specifies a DOM node that should be used for
initialization. In that case, the <a
href="pyxb.binding.basis.element-class.html#createFromDOM"
class="link">createFromDOM</a> method is invoked instead of the
type definition Factory method.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="pyxb.exceptions_.AbstractElementError-class.html">pyxb.AbstractElementError</a></strong></code> - This element is abstract and no DOM node was provided.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="compatibleValue"></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">compatibleValue</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>,
<span class="sig-arg">**kw</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.compatibleValue">source code</a></span>
</td>
</tr></table>
<p>Return a variant of the value that is compatible with this
element.</p>
<p>This mostly defers to <a
href="pyxb.binding.basis._TypeBinding_mixin-class.html#_CompatibleValue"
class="link"
onclick="show_private();">_TypeBinding_mixin._CompatibleValue</a>.</p>
<dl class="fields">
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="pyxb.exceptions_.BadTypeValueError-class.html">pyxb.BadTypeValueError</a></strong></code> - if the value is not both type-consistent and value-consistent with
the element's type.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="elementForName"></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">elementForName</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.elementForName">source code</a></span>
</td>
</tr></table>
<p>Return the element that should be used if this element binding is
permitted and an element with the given name is encountered.</p>
<p>Normally, the incoming name matches the name of this binding, and
<code>self</code> is returned. If the incoming name is different, it is
expected to be the name of a global element which is within this
element's substitution group. In that case, the binding corresponding to
the named element is return.</p>
<dl class="fields">
<dt>Returns:</dt>
<dd>An instance of <a href="pyxb.binding.basis.element-class.html"
class="link">element</a>, or <code>None</code> if no element with
the given name can be found.</dd>
</dl>
</td></tr></table>
</div>
<a name="createFromDOM"></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">createFromDOM</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">node</span>,
<span class="sig-arg">expanded_name</span>=<span class="sig-default">None</span>,
<span class="sig-arg">fallback_namespace</span>=<span class="sig-default">None</span>,
<span class="sig-arg">**kw</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.createFromDOM">source code</a></span>
</td>
</tr></table>
<p>Create a binding instance from the given DOM node.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>expanded_name</code></strong> - Optional name for the DOM node. If not present, is inferred from
<code>node</code>.</li>
<li><strong class="pname"><code>fallback_namespace</code></strong> - Optional namespace to use when resolving unqualified names.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_createFromDOM"></a>
<div class="private">
<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">_createFromDOM</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">node</span>,
<span class="sig-arg">expanded_name</span>,
<span class="sig-arg">**kw</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element._createFromDOM">source code</a></span>
</td>
</tr></table>
<p>Create a binding instance from the given DOM node, using the provided
name to identify the correct binding.</p>
<p>The context and information associated with this element is used to
identify the actual element binding to use. By default,
<code>self</code> is used. If this element represents a term in a
content model, the name and namespace of the incoming node may identify a
different element. If that element is a member of this element's
substitution group, the binding associated with the node's name will be
used instead.</p>
<p>The type of object returned is determined by the type definition
associated with the element binding and the value of any <a
href="http://www.w3.org/TR/xmlschema-1/#xsi_type"
target="_top">xsi:type</a> attribute found in the node, modulated by the
configuration of <a
href="pyxb.namespace.builtin._XMLSchema_instance-class.html#ProcessTypeAttribute"
class="link">XSI.ProcessTypeAttribute</a>.</p>
<p>Keyword parameters are passed to the factory method of the type
associated with the selected element binding. See <a
href="pyxb.binding.basis._TypeBinding_mixin-class.html" class="link"
onclick="show_private();">_TypeBinding_mixin</a> and any specializations
of it.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>expanded_name</code></strong> - The expanded name of the node. If the value is
<code>None</code>, defaults to the name of this element. (In the
case of substitution groups, the default is wrong, but correct
inference depends on context not available here.)</li>
<li><strong class="pname"><code>_fallback_namespace</code></strong> - Optional namespace to use when resolving unqualified type names.</li>
<li><strong class="pname"><code>node</code></strong> (<code>xml.dom.Node</code>) - The DOM node specifying the element content. If this is a
(top-level) Document node, its element node is used.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>An instance of <a
href="pyxb.binding.basis._TypeBinding_mixin-class.html"
class="link" onclick="show_private();">_TypeBinding_mixin</a></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="pyxb.exceptions_.StructuralBadDocumentError-class.html">pyxb.StructuralBadDocumentError</a></strong></code> - The node's name does identify an element binding.</li>
<li><code><strong class='fraise'><a href="pyxb.exceptions_.AbstractElementError-class.html">pyxb.AbstractElementError</a></strong></code> - The element binding associated with the node is abstract.</li>
<li><code><strong class='fraise'><a href="pyxb.exceptions_.BadDocumentError-class.html">pyxb.BadDocumentError</a></strong></code> - An <a href="http://www.w3.org/TR/xmlschema-1/#xsi_type"
target="_top">xsi:type</a> attribute in the node fails to resolve
to a recognized type</li>
<li><code><strong class='fraise'><a href="pyxb.exceptions_.BadDocumentError-class.html">pyxb.BadDocumentError</a></strong></code> - An <a href="http://www.w3.org/TR/xmlschema-1/#xsi_type"
target="_top">xsi:type</a> attribute in the node resolves to a type
that is not a subclass of the type of the element binding.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="__str__"></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">__str__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Informal representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.basis-pysrc.html#element.__str__">source code</a></span>
</td>
</tr></table>
<p>str(x)</p>
<dl class="fields">
<dt>Overrides:
object.__str__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</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:28 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>
