/apidocs/pyechonest.document-module.html

http://echo-nest-remix.googlecode.com/ · HTML · 181 lines · 146 code · 14 blank · 21 comment · 0 complexity · 8089410f263b587d72ee94fc03dbe643 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</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.         Module&nbsp;document
    44. 

  44.       </span>
    45. 

  45.     </td>
    46. 

  46.     <td>
    47. 

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

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

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

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

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

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

  53.             >]&nbsp;|&nbsp;<a href="pyechonest.document-module.html"
    54. 

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

  55.       </table>
    56. 

  56.     </td>
    57. 

  57.   </tr>
    58. 

  58. </table>
    59. 

  59. <!-- ==================== MODULE DESCRIPTION ==================== -->
    60. 

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

  61. <pre class="literalblock">
    62. 

  62. 

  63. document.py
    64. 

  64. 

  65. Created by Ben Lacker on 2009-06-25.
    66. 

  66. Copyright (c) 2009 __MyCompanyName__. All rights reserved.
    67. 

  67. 

  68. </pre>
    69. 

  69. 

  70. <!-- ==================== CLASSES ==================== -->
    71. 

  71. <a name="section-Classes"></a>
    72. 

  72. <table class="summary" border="1" cellpadding="3"
    73. 

  73.        cellspacing="0" width="100%" bgcolor="white">
    74. 

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

  75.   <td colspan="2" class="table-header">
    76. 

  76.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    77. 

  77.       <tr valign="top">
    78. 

  78.         <td align="left"><span class="table-header">Classes</span></td>
    79. 

  79.         <td align="right" valign="top"
    80. 

  80.          ><span class="options">[<a href="#section-Classes"
    81. 

  81.          class="privatelink" onclick="toggle_private();"
    82. 

  82.          >hide private</a>]</span></td>
    83. 

  83.       </tr>
    84. 

  84.     </table>
    85. 

  85.   </td>
    86. 

  86. </tr>
    87. 

  87. <tr>
    88. 

  88.     <td width="15%" align="right" valign="top" class="summary">
    89. 

  89.       <span class="summary-type">&nbsp;</span>
    90. 

  90.     </td><td class="summary">
    91. 

  91.         <a href="pyechonest.document.DocumentSetCache-class.html" class="summary-name">DocumentSetCache</a>
    92. 

  92.     </td>
    93. 

  93.   </tr>
    94. 

  94. <tr>
    95. 

  95.     <td width="15%" align="right" valign="top" class="summary">
    96. 

  96.       <span class="summary-type">&nbsp;</span>
    97. 

  97.     </td><td class="summary">
    98. 

  98.         <a href="pyechonest.document.DocumentSet-class.html" class="summary-name">DocumentSet</a>
    99. 

  99.     </td>
    100. 

  100.   </tr>
    101. 

  101. <tr>
    102. 

  102.     <td width="15%" align="right" valign="top" class="summary">
    103. 

  103.       <span class="summary-type">&nbsp;</span>
    104. 

  104.     </td><td class="summary">
    105. 

  105.         <a href="pyechonest.document.WebDocumentSet-class.html" class="summary-name">WebDocumentSet</a>
    106. 

  106.     </td>
    107. 

  107.   </tr>
    108. 

  108. </table>
    109. 

  109. <!-- ==================== VARIABLES ==================== -->
    110. 

  110. <a name="section-Variables"></a>
    111. 

  111. <table class="summary" border="1" cellpadding="3"
    112. 

  112.        cellspacing="0" width="100%" bgcolor="white">
    113. 

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

  114.   <td colspan="2" class="table-header">
    115. 

  115.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    116. 

  116.       <tr valign="top">
    117. 

  117.         <td align="left"><span class="table-header">Variables</span></td>
    118. 

  118.         <td align="right" valign="top"
    119. 

  119.          ><span class="options">[<a href="#section-Variables"
    120. 

  120.          class="privatelink" onclick="toggle_private();"
    121. 

  121.          >hide private</a>]</span></td>
    122. 

  122.       </tr>
    123. 

  123.     </table>
    124. 

  124.   </td>
    125. 

  125. </tr>
    126. 

  126. <tr>
    127. 

  127.     <td width="15%" align="right" valign="top" class="summary">
    128. 

  128.       <span class="summary-type">&nbsp;</span>
    129. 

  129.     </td><td class="summary">
    130. 

  130.         <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'pyechonest'"><code class="variable-quote">'</code><code class="variable-string">pyechonest</code><code class="variable-quote">'</code></code>
    131. 

  131.     </td>
    132. 

  132.   </tr>
    133. 

  133. </table>
    134. 

  134. <!-- ==================== NAVIGATION BAR ==================== -->
    135. 

  135. <table class="navbar" border="0" width="100%" cellpadding="0"
    136. 

  136.        bgcolor="#a0c0ff" cellspacing="0">
    137. 

  137.   <tr valign="middle">
    138. 

  138. 

  139.   <!-- Tree link -->
    140. 

  140.       <th>&nbsp;&nbsp;&nbsp;<a
    141. 

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

  142. 

  143.   <!-- Index link -->
    144. 

  144.       <th>&nbsp;&nbsp;&nbsp;<a
    145. 

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

  146. 

  147.   <!-- Help link -->
    148. 

  148.       <th>&nbsp;&nbsp;&nbsp;<a
    149. 

  149.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    150. 

  150. 

  151.   <!-- Project homepage -->
    152. 

  152.       <th class="navbar" align="right" width="100%">
    153. 

  153.         <table border="0" cellpadding="0" cellspacing="0">
    154. 

  154.           <tr><th class="navbar" align="center"
    155. 

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

  156.           </tr></table></th>
    157. 

  157.   </tr>
    158. 

  158. </table>
    159. 

  159. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    160. 

  160.   <tr>
    161. 

  161.     <td align="left" class="footer">
    162. 

  162.     Generated by Epydoc 3.0.1 on Wed May 26 12:17:55 2010
    163. 

  163.     </td>
    164. 

  164.     <td align="right" class="footer">
    165. 

  165.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    166. 

  166.         >http://epydoc.sourceforge.net</a>
    167. 

  167.     </td>
    168. 

  168.   </tr>
    169. 

  169. </table>
    170. 

  170. 

  171. <script type="text/javascript">
    172. 

  172.   <!--
    173. 

  173.   // Private objects are initially displayed (because if
    174. 

  174.   // javascript is turned off then we want them to be
    175. 

  175.   // visible); but by default, we want to hide them.  So hide
    176. 

  176.   // them unless we have a cookie that says to show them.
    177. 

  177.   checkCookie();
    178. 

  178.   // -->
    179. 

  179. </script>
    180. 

  180. </body>
    181. 

  181. </html>
    182.