<?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.facets.ConstrainingFacet</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.facets-module.html">Module facets</a> :: Class ConstrainingFacet </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.facets.ConstrainingFacet-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class ConstrainingFacet</h1><p class="nomargin-top"><span class="codelink"><a href="pyxb.binding.facets-pysrc.html#ConstrainingFacet">source code</a></span></p> <pre class="base-tree"> object --+ | <a href="pyxb.cscRoot-class.html">cscRoot</a> --+ | <a href="pyxb.binding.facets.Facet-class.html">Facet</a> --+ | <strong class="uidshort">ConstrainingFacet</strong> </pre> <dl><dt>Known Subclasses:</dt> <dd> <ul class="subclass-list"> <li><a href="pyxb.binding.facets.CF_enumeration-class.html">CF_enumeration</a></li><li>, <a href="pyxb.binding.facets.CF_fractionDigits-class.html">CF_fractionDigits</a></li><li>, <a href="pyxb.binding.facets.CF_length-class.html">CF_length</a></li><li>, <a href="pyxb.binding.facets.CF_maxExclusive-class.html">CF_maxExclusive</a></li><li>, <a href="pyxb.binding.facets.CF_maxInclusive-class.html">CF_maxInclusive</a></li><li>, <a href="pyxb.binding.facets.CF_maxLength-class.html">CF_maxLength</a></li><li>, <a href="pyxb.binding.facets.CF_minExclusive-class.html">CF_minExclusive</a></li><li>, <a href="pyxb.binding.facets.CF_minInclusive-class.html">CF_minInclusive</a></li><li>, <a href="pyxb.binding.facets.CF_minLength-class.html">CF_minLength</a></li><li>, <a href="pyxb.binding.facets.CF_pattern-class.html">CF_pattern</a></li><li>, <a href="pyxb.binding.facets.CF_totalDigits-class.html">CF_totalDigits</a></li><li>, <a href="pyxb.binding.facets.CF_whiteSpace-class.html">CF_whiteSpace</a></li> </ul> </dd></dl> <hr /> <p>One of the facets defined in section 4.3, which provide constraints on the lexical space of a type definition.</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 href="pyxb.binding.facets.ConstrainingFacet-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">**kw</span>)</span><br /> Create a facet instance, initializing it from the keyword parameters.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.binding.facets-pysrc.html#ConstrainingFacet.__init__">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="_validateConstraint_vx"></a><span class="summary-sig-name">_validateConstraint_vx</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">value</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.binding.facets-pysrc.html#ConstrainingFacet._validateConstraint_vx">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.facets.ConstrainingFacet-class.html#validateConstraint" class="summary-sig-name">validateConstraint</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">value</span>)</span><br /> Return True iff the given value satisfies the constraint represented by this facet instance.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.binding.facets-pysrc.html#ConstrainingFacet.validateConstraint">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="__setFromKeywords"></a><span class="summary-sig-name">__setFromKeywords</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">**kw</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.binding.facets-pysrc.html#ConstrainingFacet.__setFromKeywords">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.facets.ConstrainingFacet-class.html#_setFromKeywords_vb" class="summary-sig-name" onclick="show_private();">_setFromKeywords_vb</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">**kw</span>)</span><br /> Extend base class.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyxb.binding.facets-pysrc.html#ConstrainingFacet._setFromKeywords_vb">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.facets.Facet-class.html">Facet</a></code></b>: <code><a href="pyxb.binding.facets.Facet-class.html#__str__">__str__</a></code>, <code><a href="pyxb.binding.facets.Facet-class.html#annotation">annotation</a></code>, <code><a href="pyxb.binding.facets.Facet-class.html#baseTypeDefinition">baseTypeDefinition</a></code>, <code><a href="pyxb.binding.facets.Facet-class.html#ownerDatatype">ownerDatatype</a></code>, <code><a href="pyxb.binding.facets.Facet-class.html#ownerTypeDefinition">ownerTypeDefinition</a></code>, <code><a href="pyxb.binding.facets.Facet-class.html#setFromKeywords">setFromKeywords</a></code>, <code><a href="pyxb.binding.facets.Facet-class.html#value">value</a></code>, <code><a href="pyxb.binding.facets.Facet-class.html#valueDatatype">valueDatatype</a></code> </p> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyxb.binding.facets.Facet-class.html">Facet</a></code></b> (private): <code><a href="pyxb.binding.facets.Facet-class.html#_ownerDatatype" onclick="show_private();">_ownerDatatype</a></code>, <code><a href="pyxb.binding.facets.Facet-class.html#_value" onclick="show_private();">_value</a></code>, <code><a href="pyxb.binding.facets.Facet-class.html#_valueString" onclick="show_private();">_valueString</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 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 colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyxb.binding.facets.Facet-class.html">Facet</a></code></b>: <code><a href="pyxb.binding.facets.Facet-class.html#ClassForFacet">ClassForFacet</a></code>, <code><a href="pyxb.binding.facets.Facet-class.html#Name">Name</a></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="_FacetPrefix"></a><span class="summary-name">_FacetPrefix</span> = <code title="'CF'"><code class="variable-quote">'</code><code class="variable-string">CF</code><code class="variable-quote">'</code></code> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="pyxb.binding.facets.ConstrainingFacet-class.html#Facets" class="summary-name">Facets</a> = <code title="[<class 'pyxb.binding.facets.CF_length'>, <class 'pyxb.binding.facets.CF_minLength'>, <class 'pyxb.binding.facets.CF_maxLength'>, <class 'pyxb.binding.facets.CF_pattern'>, <class 'pyxb.binding.facets.CF_enumeration'>, <class 'pyxb.binding.facets.CF_whiteSpace'>, <class 'pyxb.binding.facets.CF_minInclusive'>, <class 'pyxb.binding.facets.CF_maxInclusive'>, ..."><code class="variable-group">[</code><class 'pyxb.binding.facets.CF_length'><code class="variable-op">, </code><class 'pyx<code class="variable-ellipsis">...</code></code> </td> </tr> <tr> <td colspan="2" class="summary"> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyxb.binding.facets.Facet-class.html">Facet</a></code></b> (private): <code><a href="pyxb.binding.facets.Facet-class.html#_Name" onclick="show_private();">_Name</a></code>, <code><a href="pyxb.binding.facets.Facet-class.html#_ValueDatatype" onclick="show_private();">_ValueDatatype</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="__init__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">**kw</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyxb.binding.facets-pysrc.html#ConstrainingFacet.__init__">source code</a></span> </td> </tr></table> <p>Create a facet instance, initializing it from the keyword parameters.</p> <dl class="fields"> <dt>Overrides: object.__init__ <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="validateConstraint"></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">validateConstraint</span>(<span class="sig-arg">self</span>, <span class="sig-arg">value</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyxb.binding.facets-pysrc.html#ConstrainingFacet.validateConstraint">source code</a></span> </td> </tr></table> <p>Return True iff the given value satisfies the constraint represented by this facet instance.</p> <p>The actual test is delegated to the subclasses.</p> <dl class="fields"> </dl> </td></tr></table> </div> <a name="_setFromKeywords_vb"></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">_setFromKeywords_vb</span>(<span class="sig-arg">self</span>, <span class="sig-arg">**kw</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyxb.binding.facets-pysrc.html#ConstrainingFacet._setFromKeywords_vb">source code</a></span> </td> </tr></table> <p>Extend base class.</p> <p>Additional keywords: * value</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>_reset</code></strong> - If <code>False</code> or missing, existing values will be retained if they do not appear in the keywords. If <code>True</code>, members not defined in the keywords are set to a default.</li> <li><strong class="pname"><code>base_type_definition</code></strong></li> <li><strong class="pname"><code>owner_type_definition</code></strong></li> <li><strong class="pname"><code>owner_datatype</code></strong></li> <li><strong class="pname"><code>value_datatype</code></strong></li> </ul></dd> <dt>Overrides: <a href="pyxb.binding.facets.Facet-class.html#_setFromKeywords_vb" onclick="show_private();">Facet._setFromKeywords_vb</a> </dt> </dl> </td></tr></table> </div> <br /> <!-- ==================== CLASS VARIABLE DETAILS ==================== --> <a name="section-ClassVariableDetails"></a> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Class Variable Details</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-ClassVariableDetails" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> </table> <a name="Facets"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">Facets</h3> <dl class="fields"> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> <code class="variable-group">[</code><class 'pyxb.binding.facets.CF_length'><code class="variable-op">,</code> <class 'pyxb.binding.facets.CF_minLength'><code class="variable-op">,</code> <class 'pyxb.binding.facets.CF_maxLength'><code class="variable-op">,</code> <class 'pyxb.binding.facets.CF_pattern'><code class="variable-op">,</code> <class 'pyxb.binding.facets.CF_enumeration'><code class="variable-op">,</code> <class 'pyxb.binding.facets.CF_whiteSpace'><code class="variable-op">,</code> <class 'pyxb.binding.facets.CF_minInclusive'><code class="variable-op">,</code> <class 'pyxb.binding.facets.CF_maxInclusive'><code class="variable-op">,</code> <code class="variable-ellipsis">...</code> </pre></td></tr></table> </dd> </dl> </td></tr></table> </div> <br /> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="pyxb-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" >PyXB hosted on <a href="http://sourceforge.net/projects/pyxb"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=263147&type=9" width="80" height="15" alt="Get PyXB: Python XML Schema Bindings at SourceForge.net. Fast, secure and Free Open Source software downloads"/></a></th> </tr></table></th> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> Generated by Epydoc 3.0.1 on Sun May 30 12:40:30 2010 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" >http://epydoc.sourceforge.net</a> </td> </tr> </table> <script type="text/javascript"> <!-- // Private objects are initially displayed (because if // javascript is turned off then we want them to be // visible); but by default, we want to hide them. So hide // them unless we have a cookie that says to show them. checkCookie(); // --> </script> </body> </html>