<?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.content.ElementUse</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.content-module.html">Module content</a> ::
Class ElementUse
</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.content.ElementUse-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ElementUse</h1><p class="nomargin-top"><span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse">source code</a></span></p>
<pre class="base-tree">
object --+
|
<a href="pyxb.cscRoot-class.html">cscRoot</a> --+
|
<a href="pyxb.binding.content.ContentState_mixin-class.html">ContentState_mixin</a> --+
|
object --+ |
| |
<a href="pyxb.cscRoot-class.html">cscRoot</a> --+ |
| |
<a href="pyxb.binding.content.ContentModel_mixin-class.html">ContentModel_mixin</a> --+
|
<strong class="uidshort">ElementUse</strong>
</pre>
<hr />
<p>Aggregate the information relevant to an element of a complex
type.</p>
<p>This includes the <a
href="pyxb.binding.content.ElementUse-class.html#name"
class="link">original tag name</a>, the spelling of <a
href="pyxb.binding.content.ElementUse-class.html#id" class="link">the
corresponding object in Python</a>, an <a
href="pyxb.binding.content.ElementUse-class.html#isPlural"
class="link">indicator</a> of whether multiple instances might be
associated with the field, and other relevant information..</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"><a href="pyxb.namespace.ExpandedName-class.html"
class="link">pyxb.namespace.ExpandedName</a></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.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.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 href="pyxb.binding.content.ElementUse-class.html#id" class="summary-sig-name">id</a>(<span class="summary-sig-arg">self</span>)</span><br />
The string name of the binding class field used to hold the element
values.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.id">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="elementBinding"></a><span class="summary-sig-name">elementBinding</span>(<span class="summary-sig-arg">self</span>)</span><br />
The <a href="pyxb.binding.basis.element-class.html"
class="link">basis.element</a> instance identifying the information
associated with the element declaration.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.elementBinding">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="_setElementBinding"></a><span class="summary-sig-name">_setElementBinding</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">element_binding</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse._setElementBinding">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.content.ElementUse-class.html#isPlural" class="summary-sig-name">isPlural</a>(<span class="summary-sig-arg">self</span>)</span><br />
True iff the content model indicates that more than one element can
legitimately belong to this use.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.isPlural">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.content.ElementUse-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">id</span>,
<span class="summary-sig-arg">key</span>,
<span class="summary-sig-arg">is_plural</span>,
<span class="summary-sig-arg">element_binding</span>=<span class="summary-sig-default">None</span>)</span><br />
Create an ElementUse instance.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.__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.content.ElementUse-class.html#defaultValue" class="summary-sig-name">defaultValue</a>(<span class="summary-sig-arg">self</span>)</span><br />
Return the default value for this element.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.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 name="value"></a><span class="summary-sig-name">value</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">ctd_instance</span>)</span><br />
Return the value for this use within the given instance.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.value">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="reset"></a><span class="summary-sig-name">reset</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">ctd_instance</span>)</span><br />
Set the value for this use in the given element to its default.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.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 name="set"></a><span class="summary-sig-name">set</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">ctd_instance</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Set the value of this element in the given instance.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.set">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="setOrAppend"></a><span class="summary-sig-name">setOrAppend</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">ctd_instance</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Invoke either <a
href="pyxb.binding.content.ElementUse-class.html#set"
class="link">set</a> or <a
href="pyxb.binding.content.ElementUse-class.html#append"
class="link">append</a>, depending on whether the element use is
plural.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.setOrAppend">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.content.ElementUse-class.html#append" class="summary-sig-name">append</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">ctd_instance</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Add the given value as another instance of this element within the
binding instance.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.append">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.content.ElementUse-class.html#toDOM" class="summary-sig-name">toDOM</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">dom_support</span>,
<span class="summary-sig-arg">parent</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Convert the given value to DOM as an instance of this element.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.toDOM">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.content-pysrc.html#ElementUse._description">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.content.ElementUse-class.html#newState" class="summary-sig-name">newState</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">parent_particle_state</span>)</span><br />
Implement parent class method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.newState">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.content.ElementUse-class.html#accepts" class="summary-sig-name">accepts</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">particle_state</span>,
<span class="summary-sig-arg">instance</span>,
<span class="summary-sig-arg">value</span>,
<span class="summary-sig-arg">element_use</span>)</span><br />
Determine whether the provided value can be added to the instance
without violating state validation.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.accepts">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="_accepts"></a><span class="summary-sig-name">_accepts</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">instance</span>,
<span class="summary-sig-arg">value</span>,
<span class="summary-sig-arg">element_use</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse._accepts">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.content.ElementUse-class.html#_validate" class="summary-sig-name" onclick="show_private();">_validate</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">symbol_set</span>,
<span class="summary-sig-arg">output_sequence</span>)</span><br />
Determine whether an output sequence created from the symbols can be
made consistent with the model.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse._validate">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.content.ElementUse-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.content-pysrc.html#ElementUse.__str__">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.binding.content.ContentState_mixin-class.html">ContentState_mixin</a></code></b>:
<code><a href="pyxb.binding.content.ContentState_mixin-class.html#notifyFailure">notifyFailure</a></code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyxb.binding.content.ContentState_mixin-class.html">ContentState_mixin</a></code></b> (private):
<code><a href="pyxb.binding.content.ContentState_mixin-class.html#_verifyComplete" onclick="show_private();">_verifyComplete</a></code>
</p></div>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyxb.binding.content.ContentModel_mixin-class.html">ContentModel_mixin</a></code></b> (private):
<code><a href="pyxb.binding.content.ContentModel_mixin-class.html#_validateCloneOutputSequence" onclick="show_private();">_validateCloneOutputSequence</a></code>,
<code><a href="pyxb.binding.content.ContentModel_mixin-class.html#_validateCloneSymbolSet" onclick="show_private();">_validateCloneSymbolSet</a></code>,
<code><a href="pyxb.binding.content.ContentModel_mixin-class.html#_validateReplaceResults" onclick="show_private();">_validateReplaceResults</a></code>
</p></div>
<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 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="__id"></a><span class="summary-name">__id</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="__key"></a><span class="summary-name">__key</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="__elementBinding"></a><span class="summary-name">__elementBinding</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="__isPlural"></a><span class="summary-name">__isPlural</span> = <code title="False">False</code>
</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="id"></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">id</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.id">source code</a></span>
</td>
</tr></table>
<p>The string name of the binding class field used to hold the element
values.</p>
<p>This is the user-visible name, and excepting disambiguation will be
equal to the local name of the element.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="isPlural"></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">isPlural</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.isPlural">source code</a></span>
</td>
</tr></table>
<p>True iff the content model indicates that more than one element can
legitimately belong to this use.</p>
<p>This includes elements in particles with maxOccurs greater than one,
and when multiple elements with the same NCName are declared in the same
type.</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">id</span>,
<span class="sig-arg">key</span>,
<span class="sig-arg">is_plural</span>,
<span class="sig-arg">element_binding</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.content-pysrc.html#ElementUse.__init__">source code</a></span>
</td>
</tr></table>
<p>Create an ElementUse instance.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (<a href="pyxb.namespace.ExpandedName-class.html"
class="link">pyxb.namespace.ExpandedName</a>) - The name by which the element is referenced in the XML</li>
<li><strong class="pname"><code>id</code></strong> (<code>str</code>) - The Python name for the element within the containing <a
href="pyxb.binding.basis.complexTypeDefinition-class.html"
class="link">pyxb.basis.binding.complexTypeDefinition</a>. This
is a public identifier, albeit modified to be unique, and is
usually used as the name of the element's inspector method or
property.</li>
<li><strong class="pname"><code>key</code></strong> (<code>str</code>) - The string used to store the element value in the dictionary of
the containing <a
href="pyxb.binding.basis.complexTypeDefinition-class.html"
class="link">pyxb.basis.binding.complexTypeDefinition</a>. This
is mangled so that it is unique among and is treated as a Python
private member.</li>
<li><strong class="pname"><code>is_plural</code></strong> (<code>bool</code>) - If <code>True</code>, documents for the corresponding type may
have multiple instances of this element. As a consequence, the
value of the element will be a list. If <code>False</code>, the
value will be <code>None</code> if the element is absent, and a
reference to an instance of the type identified by <a
href="pyxb.binding.basis.element-class.html#typeDefinition"
class="link">pyxb.binding.basis.element.typeDefinition</a> if
present.</li>
<li><strong class="pname"><code>element_binding</code></strong> - Reference to the class that serves as the binding for the
element.</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="defaultValue"></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">defaultValue</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.defaultValue">source code</a></span>
</td>
</tr></table>
<p>Return the default value for this element.</p>
<dl class="fields">
</dl>
<div class="fields"> <p><strong>To Do:</strong>
Right now, this returns <code>None</code> for non-plural and an empty
list for plural elements. Need to support schema-specified default
values for simple-type content.
</p>
</div></td></tr></table>
</div>
<a name="append"></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">append</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">ctd_instance</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.append">source code</a></span>
</td>
</tr></table>
<p>Add the given value as another instance of this element within the
binding instance.</p>
<dl class="fields">
<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> - invoked on an element use that is not plural</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="toDOM"></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">toDOM</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">dom_support</span>,
<span class="sig-arg">parent</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.toDOM">source code</a></span>
</td>
</tr></table>
<p>Convert the given value to DOM as an instance of this element.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>dom_support</code></strong> (<a href="pyxb.utils.domutils.BindingDOMSupport-class.html"
class="link">pyxb.utils.domutils.BindingDOMSupport</a>) - Helper for managing DOM properties</li>
<li><strong class="pname"><code>parent</code></strong> (<code>xml.dom.Element</code>) - The DOM node within which this element should be generated.</li>
<li><strong class="pname"><code>value</code></strong> - The content for this element. May be text (if the element allows
mixed content), or an instance of <a
href="pyxb.binding.basis._TypeBinding_mixin-class.html"
class="link"
onclick="show_private();">basis._TypeBinding_mixin</a>.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="newState"></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">newState</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">parent_particle_state</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.newState">source code</a></span>
</td>
</tr></table>
<p>Implement parent class method.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parent_particle_state</code></strong> - The <a href="pyxb.binding.content.ParticleState-class.html"
class="link">ParticleState</a> instance for which this instance
is a term. <code>None</code> for the top content model of a
complex data type.</li>
</ul></dd>
<dt>Overrides:
<a href="pyxb.binding.content.ContentModel_mixin-class.html#newState">ContentModel_mixin.newState</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="accepts"></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">accepts</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">particle_state</span>,
<span class="sig-arg">instance</span>,
<span class="sig-arg">value</span>,
<span class="sig-arg">element_use</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse.accepts">source code</a></span>
</td>
</tr></table>
<p>Determine whether the provided value can be added to the instance
without violating state validation.</p>
<p>This method must not throw any non-catastrophic exceptions; general
failures should be transformed to a <code>False</code> return value.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>particle_state</code></strong> - The <a href="pyxb.binding.content.ParticleState-class.html"
class="link">ParticleState</a> instance serving as the parent to
this state. The implementation must inform that state when the
proposed value completes the content model.</li>
<li><strong class="pname"><code>instance</code></strong> - An instance of a subclass of {basis.complexTypeDefinition}, into
which the provided value will be stored if it is consistent with
the current model state.</li>
<li><strong class="pname"><code>value</code></strong> - The value that is being validated against the state.</li>
<li><strong class="pname"><code>element_use</code></strong> - An optional <a href="pyxb.binding.content.ElementUse-class.html"
class="link">ElementUse</a> instance that specifies the element
to which the value corresponds. This will be available when the
value is extracted by parsing a document, but will be absent if
the value was passed as a constructor positional parameter.</li>
</ul></dd>
<dt>Returns:</dt>
<dd><code>True</code> if the value was successfully matched against
the state. <code>False</code> if the value did not match against
the state.</dd>
<dt>Overrides:
<a href="pyxb.binding.content.ContentState_mixin-class.html#accepts">ContentState_mixin.accepts</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="_validate"></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">_validate</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">symbol_set</span>,
<span class="sig-arg">output_sequence</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyxb.binding.content-pysrc.html#ElementUse._validate">source code</a></span>
</td>
</tr></table>
<p>Determine whether an output sequence created from the symbols can be
made consistent with the model.</p>
<p>The symbol set represents letters in an alphabet; the output sequence
orders those letters in a way that satisfies the regular expression
expressed in the model. Both are changed as a result of a successful
validation; both remain unchanged if the validation failed. In
recursing, implementers may assume that <code>output_sequence</code> is
monotonic: its length remains unchanged after an invocation iff the
symbol set also remains unchanged. The <a
href="pyxb.binding.content.ContentModel_mixin-class.html#_validateCloneSymbolSet"
class="link" onclick="show_private();">_validateCloneSymbolSet</a>, <a
href="pyxb.binding.content.ContentModel_mixin-class.html#_validateCloneOutputSequence"
class="link" onclick="show_private();">_validateCloneOutputSequence</a>,
and <a
href="pyxb.binding.content.ContentModel_mixin-class.html#_validateReplaceResults"
class="link" onclick="show_private();">_validateReplaceResults</a>
methods are available to help preserve this behavior.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>symbol_set</code></strong> - A map from <a href="pyxb.binding.content.ElementUse-class.html"
class="link">ElementUse</a> instances to a list of values. The
order of the values corresponds to the order in which they should
appear. A key of <code>None</code> identifies values that are
stored as wildcard elements. Values are removed from the lists
as they are used; when the last value of a list is removed, its
key is removed from the map. Thus an empty dictionary is the
indicator that no more symbols are available.</li>
<li><strong class="pname"><code>output_sequence</code></strong> - A mutable list to which should be appended tuples <code>( eu, val
)</code> where <code>eu</code> is an <a
href="pyxb.binding.content.ElementUse-class.html"
class="link">ElementUse</a> from the set of symbol keys, and
<code>val</code> is a value from the corresponding list. A
document generated by producing the elements in the given order
is expected to validate.</li>
</ul></dd>
<dt>Returns:</dt>
<dd><code>True</code> iff the model validates.
<code>symbol_set</code> and <code>output_path</code> must be
unmodified if returns <code>False</code>.</dd>
<dt>Overrides:
<a href="pyxb.binding.content.ContentModel_mixin-class.html#_validate" onclick="show_private();">ContentModel_mixin._validate</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</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.content-pysrc.html#ElementUse.__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>
