/apidocs/pyechonest.document.DocumentSet-class.html

http://echo-nest-remix.googlecode.com/ · HTML · 309 lines · 264 code · 23 blank · 22 comment · 0 complexity · 33faf7c72485f7d2acfa65f96cacd1f6 MD5 · raw file 

    

  1. <?xml version="1.0" encoding="ascii"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.           "DTD/xhtml1-transitional.dtd">
    4. 

  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    5. 

  5. <head>
    6. 

  6.   <title>pyechonest.document.DocumentSet</title>
    7. 

  7.   <link rel="stylesheet" href="epydoc.css" type="text/css" />
    8. 

  8.   <script type="text/javascript" src="epydoc.js"></script>
    9. 

  9. </head>
    10. 

  10. 

  11. <body bgcolor="white" text="black" link="blue" vlink="#204080"
    12. 

  12.       alink="#204080">
    13. 

  13. <!-- ==================== NAVIGATION BAR ==================== -->
    14. 

  14. <table class="navbar" border="0" width="100%" cellpadding="0"
    15. 

  15.        bgcolor="#a0c0ff" cellspacing="0">
    16. 

  16.   <tr valign="middle">
    17. 

  17. 

  18.   <!-- Tree link -->
    19. 

  19.       <th>&nbsp;&nbsp;&nbsp;<a
    20. 

  20.         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    21. 

  21. 

  22.   <!-- Index link -->
    23. 

  23.       <th>&nbsp;&nbsp;&nbsp;<a
    24. 

  24.         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
    25. 

  25. 

  26.   <!-- Help link -->
    27. 

  27.       <th>&nbsp;&nbsp;&nbsp;<a
    28. 

  28.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    29. 

  29. 

  30.   <!-- Project homepage -->
    31. 

  31.       <th class="navbar" align="right" width="100%">
    32. 

  32.         <table border="0" cellpadding="0" cellspacing="0">
    33. 

  33.           <tr><th class="navbar" align="center"
    34. 

  34.             ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">The Echo Nest Remix API, SVN Revision: 448</a></th>
    35. 

  35.           </tr></table></th>
    36. 

  36.   </tr>
    37. 

  37. </table>
    38. 

  38. <table width="100%" cellpadding="0" cellspacing="0">
    39. 

  39.   <tr valign="top">
    40. 

  40.     <td width="100%">
    41. 

  41.       <span class="breadcrumbs">
    42. 

  42.         <a href="pyechonest-module.html">Package&nbsp;pyechonest</a> ::
    43. 

  43.         <a href="pyechonest.document-module.html">Module&nbsp;document</a> ::
    44. 

  44.         Class&nbsp;DocumentSet
    45. 

  45.       </span>
    46. 

  46.     </td>
    47. 

  47.     <td>
    48. 

  48.       <table cellpadding="0" cellspacing="0">
    49. 

  49.         <!-- hide/show private -->
    50. 

  50.         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    51. 

  51.     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
    52. 

  52.         <tr><td align="right"><span class="options"
    53. 

  53.             >[<a href="frames.html" target="_top">frames</a
    54. 

  54.             >]&nbsp;|&nbsp;<a href="pyechonest.document.DocumentSet-class.html"
    55. 

  55.             target="_top">no&nbsp;frames</a>]</span></td></tr>
    56. 

  56.       </table>
    57. 

  57.     </td>
    58. 

  58.   </tr>
    59. 

  59. </table>
    60. 

  60. <!-- ==================== CLASS DESCRIPTION ==================== -->
    61. 

  61. <h1 class="epydoc">Class DocumentSet</h1><p class="nomargin-top"><span class="codelink"><a href="pyechonest.document-pysrc.html#DocumentSet">source&nbsp;code</a></span></p>
    62. 

  62. <center>
    63. 

  63. 

  64. </center>
    65. 

  65. <hr />
    66. 

  66. <!-- ==================== INSTANCE METHODS ==================== -->
    67. 

  67. <a name="section-InstanceMethods"></a>
    68. 

  68. <table class="summary" border="1" cellpadding="3"
    69. 

  69.        cellspacing="0" width="100%" bgcolor="white">
    70. 

  70. <tr bgcolor="#70b0f0" class="table-header">
    71. 

  71.   <td colspan="2" class="table-header">
    72. 

  72.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    73. 

  73.       <tr valign="top">
    74. 

  74.         <td align="left"><span class="table-header">Instance Methods</span></td>
    75. 

  75.         <td align="right" valign="top"
    76. 

  76.          ><span class="options">[<a href="#section-InstanceMethods"
    77. 

  77.          class="privatelink" onclick="toggle_private();"
    78. 

  78.          >hide private</a>]</span></td>
    79. 

  79.       </tr>
    80. 

  80.     </table>
    81. 

  81.   </td>
    82. 

  82. </tr>
    83. 

  83. <tr>
    84. 

  84.     <td width="15%" align="right" valign="top" class="summary">
    85. 

  85.       <span class="summary-type">&nbsp;</span>
    86. 

  86.     </td><td class="summary">
    87. 

  87.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    88. 

  88.         <tr>
    89. 

  89.           <td><span class="summary-sig"><a href="pyechonest.document.DocumentSet-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
    90. 

  90.         <span class="summary-sig-arg">identifier</span>,
    91. 

  91.         <span class="summary-sig-arg">method</span>,
    92. 

  92.         <span class="summary-sig-arg">element_path</span>)</span><br />
    93. 

  93.       x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
    94. 

  94.           <td align="right" valign="top">
    95. 

  95.             <span class="codelink"><a href="pyechonest.document-pysrc.html#DocumentSet.__init__">source&nbsp;code</a></span>
    96. 

  96.             
    97. 

  97.           </td>
    98. 

  98.         </tr>
    99. 

  99.       </table>
    100. 

  100.       
    101. 

  101.     </td>
    102. 

  102.   </tr>
    103. 

  103. <tr>
    104. 

  104.     <td width="15%" align="right" valign="top" class="summary">
    105. 

  105.       <span class="summary-type">&nbsp;</span>
    106. 

  106.     </td><td class="summary">
    107. 

  107.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    108. 

  108.         <tr>
    109. 

  109.           <td><span class="summary-sig"><a name="__getitem__"></a><span class="summary-sig-name">__getitem__</span>(<span class="summary-sig-arg">self</span>,
    110. 

  110.         <span class="summary-sig-arg">k</span>)</span></td>
    111. 

  111.           <td align="right" valign="top">
    112. 

  112.             <span class="codelink"><a href="pyechonest.document-pysrc.html#DocumentSet.__getitem__">source&nbsp;code</a></span>
    113. 

  113.             
    114. 

  114.           </td>
    115. 

  115.         </tr>
    116. 

  116.       </table>
    117. 

  117.       
    118. 

  118.     </td>
    119. 

  119.   </tr>
    120. 

  120. <tr>
    121. 

  121.     <td width="15%" align="right" valign="top" class="summary">
    122. 

  122.       <span class="summary-type">&nbsp;</span>
    123. 

  123.     </td><td class="summary">
    124. 

  124.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    125. 

  125.         <tr>
    126. 

  126.           <td><span class="summary-sig"><a name="__iter__"></a><span class="summary-sig-name">__iter__</span>(<span class="summary-sig-arg">self</span>)</span></td>
    127. 

  127.           <td align="right" valign="top">
    128. 

  128.             <span class="codelink"><a href="pyechonest.document-pysrc.html#DocumentSet.__iter__">source&nbsp;code</a></span>
    129. 

  129.             
    130. 

  130.           </td>
    131. 

  131.         </tr>
    132. 

  132.       </table>
    133. 

  133.       
    134. 

  134.     </td>
    135. 

  135.   </tr>
    136. 

  136. <tr>
    137. 

  137.     <td width="15%" align="right" valign="top" class="summary">
    138. 

  138.       <span class="summary-type">&nbsp;</span>
    139. 

  139.     </td><td class="summary">
    140. 

  140.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    141. 

  141.         <tr>
    142. 

  142.           <td><span class="summary-sig"><a name="__len__"></a><span class="summary-sig-name">__len__</span>(<span class="summary-sig-arg">self</span>)</span></td>
    143. 

  143.           <td align="right" valign="top">
    144. 

  144.             <span class="codelink"><a href="pyechonest.document-pysrc.html#DocumentSet.__len__">source&nbsp;code</a></span>
    145. 

  145.             
    146. 

  146.           </td>
    147. 

  147.         </tr>
    148. 

  148.       </table>
    149. 

  149.       
    150. 

  150.     </td>
    151. 

  151.   </tr>
    152. 

  152. <tr class="private">
    153. 

  153.     <td width="15%" align="right" valign="top" class="summary">
    154. 

  154.       <span class="summary-type">&nbsp;</span>
    155. 

  155.     </td><td class="summary">
    156. 

  156.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    157. 

  157.         <tr>
    158. 

  158.           <td><span class="summary-sig"><a name="_parse_element"></a><span class="summary-sig-name">_parse_element</span>(<span class="summary-sig-arg">self</span>,
    159. 

  159.         <span class="summary-sig-arg">element</span>)</span></td>
    160. 

  160.           <td align="right" valign="top">
    161. 

  161.             <span class="codelink"><a href="pyechonest.document-pysrc.html#DocumentSet._parse_element">source&nbsp;code</a></span>
    162. 

  162.             
    163. 

  163.           </td>
    164. 

  164.         </tr>
    165. 

  165.       </table>
    166. 

  166.       
    167. 

  167.     </td>
    168. 

  168.   </tr>
    169. 

  169.   <tr>
    170. 

  170.     <td colspan="2" class="summary">
    171. 

  171.     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
    172. 

  172.       <code>__delattr__</code>,
    173. 

  173.       <code>__format__</code>,
    174. 

  174.       <code>__getattribute__</code>,
    175. 

  175.       <code>__hash__</code>,
    176. 

  176.       <code>__new__</code>,
    177. 

  177.       <code>__reduce__</code>,
    178. 

  178.       <code>__reduce_ex__</code>,
    179. 

  179.       <code>__repr__</code>,
    180. 

  180.       <code>__setattr__</code>,
    181. 

  181.       <code>__sizeof__</code>,
    182. 

  182.       <code>__str__</code>,
    183. 

  183.       <code>__subclasshook__</code>
    184. 

  184.       </p>
    185. 

  185.     </td>
    186. 

  186.   </tr>
    187. 

  187. </table>
    188. 

  188. <!-- ==================== PROPERTIES ==================== -->
    189. 

  189. <a name="section-Properties"></a>
    190. 

  190. <table class="summary" border="1" cellpadding="3"
    191. 

  191.        cellspacing="0" width="100%" bgcolor="white">
    192. 

  192. <tr bgcolor="#70b0f0" class="table-header">
    193. 

  193.   <td colspan="2" class="table-header">
    194. 

  194.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    195. 

  195.       <tr valign="top">
    196. 

  196.         <td align="left"><span class="table-header">Properties</span></td>
    197. 

  197.         <td align="right" valign="top"
    198. 

  198.          ><span class="options">[<a href="#section-Properties"
    199. 

  199.          class="privatelink" onclick="toggle_private();"
    200. 

  200.          >hide private</a>]</span></td>
    201. 

  201.       </tr>
    202. 

  202.     </table>
    203. 

  203.   </td>
    204. 

  204. </tr>
    205. 

  205.   <tr>
    206. 

  206.     <td colspan="2" class="summary">
    207. 

  207.     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
    208. 

  208.       <code>__class__</code>
    209. 

  209.       </p>
    210. 

  210.     </td>
    211. 

  211.   </tr>
    212. 

  212. </table>
    213. 

  213. <!-- ==================== METHOD DETAILS ==================== -->
    214. 

  214. <a name="section-MethodDetails"></a>
    215. 

  215. <table class="details" border="1" cellpadding="3"
    216. 

  216.        cellspacing="0" width="100%" bgcolor="white">
    217. 

  217. <tr bgcolor="#70b0f0" class="table-header">
    218. 

  218.   <td colspan="2" class="table-header">
    219. 

  219.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    220. 

  220.       <tr valign="top">
    221. 

  221.         <td align="left"><span class="table-header">Method Details</span></td>
    222. 

  222.         <td align="right" valign="top"
    223. 

  223.          ><span class="options">[<a href="#section-MethodDetails"
    224. 

  224.          class="privatelink" onclick="toggle_private();"
    225. 

  225.          >hide private</a>]</span></td>
    226. 

  226.       </tr>
    227. 

  227.     </table>
    228. 

  228.   </td>
    229. 

  229. </tr>
    230. 

  230. </table>
    231. 

  231. <a name="__init__"></a>
    232. 

  232. <div>
    233. 

  233. <table class="details" border="1" cellpadding="3"
    234. 

  234.        cellspacing="0" width="100%" bgcolor="white">
    235. 

  235. <tr><td>
    236. 

  236.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    237. 

  237.   <tr valign="top"><td>
    238. 

  238.   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
    239. 

  239.         <span class="sig-arg">identifier</span>,
    240. 

  240.         <span class="sig-arg">method</span>,
    241. 

  241.         <span class="sig-arg">element_path</span>)</span>
    242. 

  242.     <br /><em class="fname">(Constructor)</em>
    243. 

  243.   </h3>
    244. 

  244.   </td><td align="right" valign="top"
    245. 

  245.     ><span class="codelink"><a href="pyechonest.document-pysrc.html#DocumentSet.__init__">source&nbsp;code</a></span>&nbsp;
    246. 

  246.     </td>
    247. 

  247.   </tr></table>
    248. 

  248.   
    249. 

  249.   <pre class="literalblock">
    250. 

  250. x.__init__(...) initializes x; see x.__class__.__doc__ for signature
    251. 

  251. 

  252. </pre>
    253. 

  253.   <dl class="fields">
    254. 

  254.     <dt>Overrides:
    255. 

  255.         object.__init__
    256. 

  256.         <dd><em class="note">(inherited documentation)</em></dd>
    257. 

  257.     </dt>
    258. 

  258.   </dl>
    259. 

  259. </td></tr></table>
    260. 

  260. </div>
    261. 

  261. <br />
    262. 

  262. <!-- ==================== NAVIGATION BAR ==================== -->
    263. 

  263. <table class="navbar" border="0" width="100%" cellpadding="0"
    264. 

  264.        bgcolor="#a0c0ff" cellspacing="0">
    265. 

  265.   <tr valign="middle">
    266. 

  266. 

  267.   <!-- Tree link -->
    268. 

  268.       <th>&nbsp;&nbsp;&nbsp;<a
    269. 

  269.         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    270. 

  270. 

  271.   <!-- Index link -->
    272. 

  272.       <th>&nbsp;&nbsp;&nbsp;<a
    273. 

  273.         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
    274. 

  274. 

  275.   <!-- Help link -->
    276. 

  276.       <th>&nbsp;&nbsp;&nbsp;<a
    277. 

  277.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    278. 

  278. 

  279.   <!-- Project homepage -->
    280. 

  280.       <th class="navbar" align="right" width="100%">
    281. 

  281.         <table border="0" cellpadding="0" cellspacing="0">
    282. 

  282.           <tr><th class="navbar" align="center"
    283. 

  283.             ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">The Echo Nest Remix API, SVN Revision: 448</a></th>
    284. 

  284.           </tr></table></th>
    285. 

  285.   </tr>
    286. 

  286. </table>
    287. 

  287. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    288. 

  288.   <tr>
    289. 

  289.     <td align="left" class="footer">
    290. 

  290.     Generated by Epydoc 3.0.1 on Wed May 26 12:18:01 2010
    291. 

  291.     </td>
    292. 

  292.     <td align="right" class="footer">
    293. 

  293.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    294. 

  294.         >http://epydoc.sourceforge.net</a>
    295. 

  295.     </td>
    296. 

  296.   </tr>
    297. 

  297. </table>
    298. 

  298. 

  299. <script type="text/javascript">
    300. 

  300.   <!--
    301. 

  301.   // Private objects are initially displayed (because if
    302. 

  302.   // javascript is turned off then we want them to be
    303. 

  303.   // visible); but by default, we want to hide them.  So hide
    304. 

  304.   // them unless we have a cookie that says to show them.
    305. 

  305.   checkCookie();
    306. 

  306.   // -->
    307. 

  307. </script>
    308. 

  308. </body>
    309. 

  309. </html>
    310.