doc/api/python/ccm.Query-class.html
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     1 <?xml version="1.0" encoding="ascii"?>
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3           "DTD/xhtml1-transitional.dtd">
       
     4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
       
     5 <head>
       
     6   <title>ccm.Query</title>
       
     7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
       
     8   <script type="text/javascript" src="epydoc.js"></script>
       
     9 </head>
       
    10 
       
    11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
       
    12       alink="#204080">
       
    13 <!-- ==================== NAVIGATION BAR ==================== -->
       
    14 <table class="navbar" border="0" width="100%" cellpadding="0"
       
    15        bgcolor="#a0c0ff" cellspacing="0">
       
    16   <tr valign="middle">
       
    17 
       
    18   <!-- Tree link -->
       
    19       <th>&nbsp;&nbsp;&nbsp;<a
       
    20         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
    21 
       
    22   <!-- Index link -->
       
    23       <th>&nbsp;&nbsp;&nbsp;<a
       
    24         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
    25 
       
    26   <!-- Help link -->
       
    27       <th>&nbsp;&nbsp;&nbsp;<a
       
    28         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
    29 
       
    30       <th class="navbar" width="100%"></th>
       
    31   </tr>
       
    32 </table>
       
    33 <table width="100%" cellpadding="0" cellspacing="0">
       
    34   <tr valign="top">
       
    35     <td width="100%">
       
    36       <span class="breadcrumbs">
       
    37         <a href="ccm-module.html">Package&nbsp;ccm</a> ::
       
    38         Class&nbsp;Query
       
    39       </span>
       
    40     </td>
       
    41     <td>
       
    42       <table cellpadding="0" cellspacing="0">
       
    43         <!-- hide/show private -->
       
    44         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    45     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    46         <tr><td align="right"><span class="options"
       
    47             >[<a href="frames.html" target="_top">frames</a
       
    48             >]&nbsp;|&nbsp;<a href="ccm.Query-class.html"
       
    49             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    50       </table>
       
    51     </td>
       
    52   </tr>
       
    53 </table>
       
    54 <!-- ==================== CLASS DESCRIPTION ==================== -->
       
    55 <h1 class="epydoc">Class Query</h1><span class="codelink"><a href="ccm-pysrc.html#Query">source&nbsp;code</a></span><br /><br />
       
    56 <pre class="base-tree">
       
    57 object --+
       
    58          |
       
    59         <strong class="uidshort">Query</strong>
       
    60 </pre>
       
    61 
       
    62 <hr />
       
    63 <p>This object wrap a synergy query, it takes a query as input as well as the
       
    64 attribute you want as output, and get them translated using the model configuration.
       
    65 e.g
       
    66 Query(session, &quot;type='task' and release='test/next'&quot;, ['objectname', 'task_synopsis'], ['ccmobject', 'string'])</p>
       
    67 <p>This will return a list of hash: [{'objectname': Task(xxx), 'task_synopsis': 'xxx'}, ...]</p><br /><br />
       
    68 
       
    69 <!-- ==================== INSTANCE METHODS ==================== -->
       
    70 <a name="section-InstanceMethods"></a>
       
    71 <table class="summary" border="1" cellpadding="3"
       
    72        cellspacing="0" width="100%" bgcolor="white">
       
    73 <tr bgcolor="#70b0f0" class="table-header">
       
    74   <td colspan="2" class="table-header">
       
    75     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    76       <tr valign="top">
       
    77         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    78         <td align="right" valign="top"
       
    79          ><span class="options">[<a href="#section-InstanceMethods"
       
    80          class="privatelink" onclick="toggle_private();"
       
    81          >hide private</a>]</span></td>
       
    82       </tr>
       
    83     </table>
       
    84   </td>
       
    85 </tr>
       
    86 <tr>
       
    87     <td width="15%" align="right" valign="top" class="summary">
       
    88       <span class="summary-type">&nbsp;</span>
       
    89     </td><td class="summary">
       
    90       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    91         <tr>
       
    92           <td><span class="summary-sig"><a href="ccm.Query-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    93         <span class="summary-sig-arg">session</span>,
       
    94         <span class="summary-sig-arg">query</span>,
       
    95         <span class="summary-sig-arg">keywords</span>,
       
    96         <span class="summary-sig-arg">model</span>,
       
    97         <span class="summary-sig-arg">cmd</span>=<span class="summary-sig-default">&quot;query&quot;</span>)</span><br />
       
    98       Initialize a Synergy query.</td>
       
    99           <td align="right" valign="top">
       
   100             <span class="codelink"><a href="ccm-pysrc.html#Query.__init__">source&nbsp;code</a></span>
       
   101             
       
   102           </td>
       
   103         </tr>
       
   104       </table>
       
   105       
       
   106     </td>
       
   107   </tr>
       
   108 <tr>
       
   109     <td width="15%" align="right" valign="top" class="summary">
       
   110       <span class="summary-type">&nbsp;</span>
       
   111     </td><td class="summary">
       
   112       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   113         <tr>
       
   114           <td><span class="summary-sig"><a name="execute"></a><span class="summary-sig-name">execute</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   115       Executing the query on the database.</td>
       
   116           <td align="right" valign="top">
       
   117             <span class="codelink"><a href="ccm-pysrc.html#Query.execute">source&nbsp;code</a></span>
       
   118             
       
   119           </td>
       
   120         </tr>
       
   121       </table>
       
   122       
       
   123     </td>
       
   124   </tr>
       
   125   <tr>
       
   126     <td colspan="2" class="summary">
       
   127     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   128       <code>__delattr__</code>,
       
   129       <code>__getattribute__</code>,
       
   130       <code>__hash__</code>,
       
   131       <code>__new__</code>,
       
   132       <code>__reduce__</code>,
       
   133       <code>__reduce_ex__</code>,
       
   134       <code>__repr__</code>,
       
   135       <code>__setattr__</code>,
       
   136       <code>__str__</code>
       
   137       </p>
       
   138     </td>
       
   139   </tr>
       
   140 </table>
       
   141 <!-- ==================== PROPERTIES ==================== -->
       
   142 <a name="section-Properties"></a>
       
   143 <table class="summary" border="1" cellpadding="3"
       
   144        cellspacing="0" width="100%" bgcolor="white">
       
   145 <tr bgcolor="#70b0f0" class="table-header">
       
   146   <td colspan="2" class="table-header">
       
   147     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   148       <tr valign="top">
       
   149         <td align="left"><span class="table-header">Properties</span></td>
       
   150         <td align="right" valign="top"
       
   151          ><span class="options">[<a href="#section-Properties"
       
   152          class="privatelink" onclick="toggle_private();"
       
   153          >hide private</a>]</span></td>
       
   154       </tr>
       
   155     </table>
       
   156   </td>
       
   157 </tr>
       
   158   <tr>
       
   159     <td colspan="2" class="summary">
       
   160     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   161       <code>__class__</code>
       
   162       </p>
       
   163     </td>
       
   164   </tr>
       
   165 </table>
       
   166 <!-- ==================== METHOD DETAILS ==================== -->
       
   167 <a name="section-MethodDetails"></a>
       
   168 <table class="details" border="1" cellpadding="3"
       
   169        cellspacing="0" width="100%" bgcolor="white">
       
   170 <tr bgcolor="#70b0f0" class="table-header">
       
   171   <td colspan="2" class="table-header">
       
   172     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   173       <tr valign="top">
       
   174         <td align="left"><span class="table-header">Method Details</span></td>
       
   175         <td align="right" valign="top"
       
   176          ><span class="options">[<a href="#section-MethodDetails"
       
   177          class="privatelink" onclick="toggle_private();"
       
   178          >hide private</a>]</span></td>
       
   179       </tr>
       
   180     </table>
       
   181   </td>
       
   182 </tr>
       
   183 </table>
       
   184 <a name="__init__"></a>
       
   185 <div>
       
   186 <table class="details" border="1" cellpadding="3"
       
   187        cellspacing="0" width="100%" bgcolor="white">
       
   188 <tr><td>
       
   189   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   190   <tr valign="top"><td>
       
   191   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   192         <span class="sig-arg">session</span>,
       
   193         <span class="sig-arg">query</span>,
       
   194         <span class="sig-arg">keywords</span>,
       
   195         <span class="sig-arg">model</span>,
       
   196         <span class="sig-arg">cmd</span>=<span class="sig-default">&quot;query&quot;</span>)</span>
       
   197     <br /><em class="fname">(Constructor)</em>
       
   198   </h3>
       
   199   </td><td align="right" valign="top"
       
   200     ><span class="codelink"><a href="ccm-pysrc.html#Query.__init__">source&nbsp;code</a></span>&nbsp;
       
   201     </td>
       
   202   </table>
       
   203   
       
   204   Initialize a Synergy query.
       
   205   <dl class="fields">
       
   206     <dt>Overrides:
       
   207       object.__init__
       
   208     </dt>
       
   209   </dl>
       
   210 </td></tr></table>
       
   211 </div>
       
   212 <br />
       
   213 <!-- ==================== NAVIGATION BAR ==================== -->
       
   214 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   215        bgcolor="#a0c0ff" cellspacing="0">
       
   216   <tr valign="middle">
       
   217 
       
   218   <!-- Tree link -->
       
   219       <th>&nbsp;&nbsp;&nbsp;<a
       
   220         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   221 
       
   222   <!-- Index link -->
       
   223       <th>&nbsp;&nbsp;&nbsp;<a
       
   224         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   225 
       
   226   <!-- Help link -->
       
   227       <th>&nbsp;&nbsp;&nbsp;<a
       
   228         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   229 
       
   230       <th class="navbar" width="100%"></th>
       
   231   </tr>
       
   232 </table>
       
   233 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   234   <tr>
       
   235     <td align="left" class="footer">
       
   236     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009
       
   237     </td>
       
   238     <td align="right" class="footer">
       
   239       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   240     </td>
       
   241   </tr>
       
   242 </table>
       
   243 
       
   244 <script type="text/javascript">
       
   245   <!--
       
   246   // Private objects are initially displayed (because if
       
   247   // javascript is turned off then we want them to be
       
   248   // visible); but by default, we want to hide them.  So hide
       
   249   // them unless we have a cookie that says to show them.
       
   250   checkCookie()
       
   251   // -->
       
   252 </script>
       
   253   
       
   254 </body>
       
   255 </html>