<?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.GroupChoice</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 GroupChoice
</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.GroupChoice-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class GroupChoice</h1><p class="nomargin-top"><span class="codelink"><a href="pyxb.binding.content-pysrc.html#GroupChoice">source code</a></span></p>
<pre class="base-tree">
object --+
|
<a href="pyxb.cscRoot-class.html">cscRoot</a> --+
|
<a href="pyxb.binding.content.ContentModel_mixin-class.html">ContentModel_mixin</a> --+
|
<a href="pyxb.binding.content._Group-class.html" onclick="show_private();">_Group</a> --+
|
<strong class="uidshort">GroupChoice</strong>
</pre>
<hr />
<!-- ==================== NESTED CLASSES ==================== -->
<a name="section-NestedClasses"></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">Nested Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-NestedClasses"
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 href="pyxb.binding.content.ChoiceState-class.html" class="summary-name" onclick="show_private();">_StateClass</a><br />
A reference to a <a
href="pyxb.binding.content.ContentState_mixin-class.html"
class="link">ContentState_mixin</a> class that maintains state when
validating an instance of this group.
</td>
</tr>
</table>
<!-- ==================== 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 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.GroupChoice-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#GroupChoice._validate">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._Group-class.html" onclick="show_private();">_Group</a></code></b>:
<code><a href="pyxb.binding.content._Group-class.html#__init__">__init__</a></code>,
<code><a href="pyxb.binding.content._Group-class.html#newState">newState</a></code>,
<code><a href="pyxb.binding.content._Group-class.html#particles">particles</a></code>
</p>
<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>__str__</code>,
<code>__subclasshook__</code>
</p>
</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="_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#GroupChoice._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>
<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>
