KeyedValues.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:42 CEST 2014 -->
  6. <title>KeyedValues (JFreeChart Class Library (version 1.0.19-fx))</title>
  7. <meta name="date" content="2014-07-31">
  8. <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="KeyedValues (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/KeyedValues.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../index-files/index-1.html">Index</a></li>
  47. <li><a href="../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../org/jfree/data/KeyedValueComparatorType.html" title="class in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../org/jfree/data/KeyedValues2D.html" title="interface in org.jfree.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../index.html?org/jfree/data/KeyedValues.html" target="_top">Frames</a></li>
  57. <li><a href="KeyedValues.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li>Constr&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li>Constr&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.jfree.data</div>
  96. <h2 title="Interface KeyedValues" class="title">Interface KeyedValues</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <dl>
  103. <dt>All Superinterfaces:</dt>
  104. <dd><a href="../../../org/jfree/data/Values.html" title="interface in org.jfree.data">Values</a></dd>
  105. </dl>
  106. <dl>
  107. <dt>All Known Subinterfaces:</dt>
  108. <dd><a href="../../../org/jfree/data/general/KeyedValuesDataset.html" title="interface in org.jfree.data.general">KeyedValuesDataset</a>, <a href="../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general">PieDataset</a></dd>
  109. </dl>
  110. <dl>
  111. <dt>All Known Implementing Classes:</dt>
  112. <dd><a href="../../../org/jfree/data/category/CategoryToPieDataset.html" title="class in org.jfree.data.category">CategoryToPieDataset</a>, <a href="../../../org/jfree/data/DefaultKeyedValues.html" title="class in org.jfree.data">DefaultKeyedValues</a>, <a href="../../../org/jfree/data/general/DefaultKeyedValuesDataset.html" title="class in org.jfree.data.general">DefaultKeyedValuesDataset</a>, <a href="../../../org/jfree/data/general/DefaultPieDataset.html" title="class in org.jfree.data.general">DefaultPieDataset</a>, <a href="../../../org/jfree/data/jdbc/JDBCPieDataset.html" title="class in org.jfree.data.jdbc">JDBCPieDataset</a></dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public interface <a href="../../../src-html/org/jfree/data/KeyedValues.html#line.56">KeyedValues</a>
  117. extends <a href="../../../org/jfree/data/Values.html" title="interface in org.jfree.data">Values</a></pre>
  118. <div class="block">An ordered list of (key, value) items where the keys are unique and
  119. non-<code>null</code>.</div>
  120. <dl>
  121. <dt><span class="seeLabel">See Also:</span></dt>
  122. <dd><a href="../../../org/jfree/data/Values.html" title="interface in org.jfree.data"><code>Values</code></a>,
  123. <a href="../../../org/jfree/data/DefaultKeyedValues.html" title="class in org.jfree.data"><code>DefaultKeyedValues</code></a></dd>
  124. </dl>
  125. </li>
  126. </ul>
  127. </div>
  128. <div class="summary">
  129. <ul class="blockList">
  130. <li class="blockList">
  131. <!-- ========== METHOD SUMMARY =========== -->
  132. <ul class="blockList">
  133. <li class="blockList"><a name="method.summary">
  134. <!-- -->
  135. </a>
  136. <h3>Method Summary</h3>
  137. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  138. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  139. <tr>
  140. <th class="colFirst" scope="col">Modifier and Type</th>
  141. <th class="colLast" scope="col">Method and Description</th>
  142. </tr>
  143. <tr id="i0" class="altColor">
  144. <td class="colFirst"><code>int</code></td>
  145. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValues.html#getIndex-java.lang.Comparable-">getIndex</a></span>(java.lang.Comparable&nbsp;key)</code>
  146. <div class="block">Returns the index for a given key.</div>
  147. </td>
  148. </tr>
  149. <tr id="i1" class="rowColor">
  150. <td class="colFirst"><code>java.lang.Comparable</code></td>
  151. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValues.html#getKey-int-">getKey</a></span>(int&nbsp;index)</code>
  152. <div class="block">Returns the key associated with the item at a given position.</div>
  153. </td>
  154. </tr>
  155. <tr id="i2" class="altColor">
  156. <td class="colFirst"><code>java.util.List</code></td>
  157. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValues.html#getKeys--">getKeys</a></span>()</code>
  158. <div class="block">Returns the keys for the values in the collection.</div>
  159. </td>
  160. </tr>
  161. <tr id="i3" class="rowColor">
  162. <td class="colFirst"><code>java.lang.Number</code></td>
  163. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValues.html#getValue-java.lang.Comparable-">getValue</a></span>(java.lang.Comparable&nbsp;key)</code>
  164. <div class="block">Returns the value for a given key.</div>
  165. </td>
  166. </tr>
  167. </table>
  168. <ul class="blockList">
  169. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.data.Values">
  170. <!-- -->
  171. </a>
  172. <h3>Methods inherited from interface&nbsp;org.jfree.data.<a href="../../../org/jfree/data/Values.html" title="interface in org.jfree.data">Values</a></h3>
  173. <code><a href="../../../org/jfree/data/Values.html#getItemCount--">getItemCount</a>, <a href="../../../org/jfree/data/Values.html#getValue-int-">getValue</a></code></li>
  174. </ul>
  175. </li>
  176. </ul>
  177. </li>
  178. </ul>
  179. </div>
  180. <div class="details">
  181. <ul class="blockList">
  182. <li class="blockList">
  183. <!-- ============ METHOD DETAIL ========== -->
  184. <ul class="blockList">
  185. <li class="blockList"><a name="method.detail">
  186. <!-- -->
  187. </a>
  188. <h3>Method Detail</h3>
  189. <a name="getKey-int-">
  190. <!-- -->
  191. </a>
  192. <ul class="blockList">
  193. <li class="blockList">
  194. <h4>getKey</h4>
  195. <pre>java.lang.Comparable&nbsp;<a href="../../../src-html/org/jfree/data/KeyedValues.html#line.71">getKey</a>(int&nbsp;index)</pre>
  196. <div class="block">Returns the key associated with the item at a given position. Note
  197. that some implementations allow re-ordering of the data items, so the
  198. result may be transient.</div>
  199. <dl>
  200. <dt><span class="paramLabel">Parameters:</span></dt>
  201. <dd><code>index</code> - the item index (in the range <code>0</code> to
  202. <code>getItemCount() - 1</code>).</dd>
  203. <dt><span class="returnLabel">Returns:</span></dt>
  204. <dd>The key (never <code>null</code>).</dd>
  205. <dt><span class="throwsLabel">Throws:</span></dt>
  206. <dd><code>java.lang.IndexOutOfBoundsException</code> - if <code>index</code> is not in the
  207. specified range.</dd>
  208. </dl>
  209. </li>
  210. </ul>
  211. <a name="getIndex-java.lang.Comparable-">
  212. <!-- -->
  213. </a>
  214. <ul class="blockList">
  215. <li class="blockList">
  216. <h4>getIndex</h4>
  217. <pre>int&nbsp;<a href="../../../src-html/org/jfree/data/KeyedValues.html#line.83">getIndex</a>(java.lang.Comparable&nbsp;key)</pre>
  218. <div class="block">Returns the index for a given key.</div>
  219. <dl>
  220. <dt><span class="paramLabel">Parameters:</span></dt>
  221. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  222. <dt><span class="returnLabel">Returns:</span></dt>
  223. <dd>The index, or <code>-1</code> if the key is unrecognised.</dd>
  224. <dt><span class="throwsLabel">Throws:</span></dt>
  225. <dd><code>java.lang.IllegalArgumentException</code> - if <code>key</code> is
  226. <code>null</code>.</dd>
  227. </dl>
  228. </li>
  229. </ul>
  230. <a name="getKeys--">
  231. <!-- -->
  232. </a>
  233. <ul class="blockList">
  234. <li class="blockList">
  235. <h4>getKeys</h4>
  236. <pre>java.util.List&nbsp;<a href="../../../src-html/org/jfree/data/KeyedValues.html#line.93">getKeys</a>()</pre>
  237. <div class="block">Returns the keys for the values in the collection. Note that you can
  238. access the values in this collection by key or by index. For this
  239. reason, the key order is important - this method should return the keys
  240. in order. The returned list may be unmodifiable.</div>
  241. <dl>
  242. <dt><span class="returnLabel">Returns:</span></dt>
  243. <dd>The keys (never <code>null</code>).</dd>
  244. </dl>
  245. </li>
  246. </ul>
  247. <a name="getValue-java.lang.Comparable-">
  248. <!-- -->
  249. </a>
  250. <ul class="blockListLast">
  251. <li class="blockList">
  252. <h4>getValue</h4>
  253. <pre>java.lang.Number&nbsp;<a href="../../../src-html/org/jfree/data/KeyedValues.html#line.104">getValue</a>(java.lang.Comparable&nbsp;key)</pre>
  254. <div class="block">Returns the value for a given key.</div>
  255. <dl>
  256. <dt><span class="paramLabel">Parameters:</span></dt>
  257. <dd><code>key</code> - the key.</dd>
  258. <dt><span class="returnLabel">Returns:</span></dt>
  259. <dd>The value (possibly <code>null</code>).</dd>
  260. <dt><span class="throwsLabel">Throws:</span></dt>
  261. <dd><code><a href="../../../org/jfree/data/UnknownKeyException.html" title="class in org.jfree.data">UnknownKeyException</a></code> - if the key is not recognised.</dd>
  262. </dl>
  263. </li>
  264. </ul>
  265. </li>
  266. </ul>
  267. </li>
  268. </ul>
  269. </div>
  270. </div>
  271. <!-- ========= END OF CLASS DATA ========= -->
  272. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  273. <div class="bottomNav"><a name="navbar.bottom">
  274. <!-- -->
  275. </a>
  276. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  277. <a name="navbar.bottom.firstrow">
  278. <!-- -->
  279. </a>
  280. <ul class="navList" title="Navigation">
  281. <li><a href="../../../overview-summary.html">Overview</a></li>
  282. <li><a href="package-summary.html">Package</a></li>
  283. <li class="navBarCell1Rev">Class</li>
  284. <li><a href="class-use/KeyedValues.html">Use</a></li>
  285. <li><a href="package-tree.html">Tree</a></li>
  286. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  287. <li><a href="../../../index-files/index-1.html">Index</a></li>
  288. <li><a href="../../../help-doc.html">Help</a></li>
  289. </ul>
  290. </div>
  291. <div class="subNav">
  292. <ul class="navList">
  293. <li><a href="../../../org/jfree/data/KeyedValueComparatorType.html" title="class in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  294. <li><a href="../../../org/jfree/data/KeyedValues2D.html" title="interface in org.jfree.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  295. </ul>
  296. <ul class="navList">
  297. <li><a href="../../../index.html?org/jfree/data/KeyedValues.html" target="_top">Frames</a></li>
  298. <li><a href="KeyedValues.html" target="_top">No&nbsp;Frames</a></li>
  299. </ul>
  300. <ul class="navList" id="allclasses_navbar_bottom">
  301. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  302. </ul>
  303. <div>
  304. <script type="text/javascript"><!--
  305. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  306. if(window==top) {
  307. allClassesLink.style.display = "block";
  308. }
  309. else {
  310. allClassesLink.style.display = "none";
  311. }
  312. //-->
  313. </script>
  314. </div>
  315. <div>
  316. <ul class="subNavList">
  317. <li>Summary:&nbsp;</li>
  318. <li>Nested&nbsp;|&nbsp;</li>
  319. <li>Field&nbsp;|&nbsp;</li>
  320. <li>Constr&nbsp;|&nbsp;</li>
  321. <li><a href="#method.summary">Method</a></li>
  322. </ul>
  323. <ul class="subNavList">
  324. <li>Detail:&nbsp;</li>
  325. <li>Field&nbsp;|&nbsp;</li>
  326. <li>Constr&nbsp;|&nbsp;</li>
  327. <li><a href="#method.detail">Method</a></li>
  328. </ul>
  329. </div>
  330. <a name="skip.navbar.bottom">
  331. <!-- -->
  332. </a></div>
  333. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  334. </body>
  335. </html>