KeyedValues2D.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389
  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>KeyedValues2D (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="KeyedValues2D (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,"i4":6,"i5":6,"i6":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/KeyedValues2D.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/KeyedValues.html" title="interface in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../org/jfree/data/KeyToGroupMap.html" title="class 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/KeyedValues2D.html" target="_top">Frames</a></li>
  57. <li><a href="KeyedValues2D.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 KeyedValues2D" class="title">Interface KeyedValues2D</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/Values2D.html" title="interface in org.jfree.data">Values2D</a></dd>
  105. </dl>
  106. <dl>
  107. <dt>All Known Subinterfaces:</dt>
  108. <dd><a href="../../../org/jfree/data/statistics/BoxAndWhiskerCategoryDataset.html" title="interface in org.jfree.data.statistics">BoxAndWhiskerCategoryDataset</a>, <a href="../../../org/jfree/data/category/CategoryDataset.html" title="interface in org.jfree.data.category">CategoryDataset</a>, <a href="../../../org/jfree/data/gantt/GanttCategoryDataset.html" title="interface in org.jfree.data.gantt">GanttCategoryDataset</a>, <a href="../../../org/jfree/data/category/IntervalCategoryDataset.html" title="interface in org.jfree.data.category">IntervalCategoryDataset</a>, <a href="../../../org/jfree/data/general/KeyedValues2DDataset.html" title="interface in org.jfree.data.general">KeyedValues2DDataset</a>, <a href="../../../org/jfree/data/statistics/MultiValueCategoryDataset.html" title="interface in org.jfree.data.statistics">MultiValueCategoryDataset</a>, <a href="../../../org/jfree/data/statistics/StatisticalCategoryDataset.html" title="interface in org.jfree.data.statistics">StatisticalCategoryDataset</a></dd>
  109. </dl>
  110. <dl>
  111. <dt>All Known Implementing Classes:</dt>
  112. <dd><a href="../../../org/jfree/data/statistics/DefaultBoxAndWhiskerCategoryDataset.html" title="class in org.jfree.data.statistics">DefaultBoxAndWhiskerCategoryDataset</a>, <a href="../../../org/jfree/data/category/DefaultCategoryDataset.html" title="class in org.jfree.data.category">DefaultCategoryDataset</a>, <a href="../../../org/jfree/data/category/DefaultIntervalCategoryDataset.html" title="class in org.jfree.data.category">DefaultIntervalCategoryDataset</a>, <a href="../../../org/jfree/data/DefaultKeyedValues2D.html" title="class in org.jfree.data">DefaultKeyedValues2D</a>, <a href="../../../org/jfree/data/general/DefaultKeyedValues2DDataset.html" title="class in org.jfree.data.general">DefaultKeyedValues2DDataset</a>, <a href="../../../org/jfree/data/statistics/DefaultMultiValueCategoryDataset.html" title="class in org.jfree.data.statistics">DefaultMultiValueCategoryDataset</a>, <a href="../../../org/jfree/data/statistics/DefaultStatisticalCategoryDataset.html" title="class in org.jfree.data.statistics">DefaultStatisticalCategoryDataset</a>, <a href="../../../org/jfree/data/jdbc/JDBCCategoryDataset.html" title="class in org.jfree.data.jdbc">JDBCCategoryDataset</a>, <a href="../../../org/jfree/data/category/SlidingCategoryDataset.html" title="class in org.jfree.data.category">SlidingCategoryDataset</a>, <a href="../../../org/jfree/data/gantt/SlidingGanttCategoryDataset.html" title="class in org.jfree.data.gantt">SlidingGanttCategoryDataset</a>, <a href="../../../org/jfree/data/gantt/TaskSeriesCollection.html" title="class in org.jfree.data.gantt">TaskSeriesCollection</a></dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public interface <a href="../../../src-html/org/jfree/data/KeyedValues2D.html#line.50">KeyedValues2D</a>
  117. extends <a href="../../../org/jfree/data/Values2D.html" title="interface in org.jfree.data">Values2D</a></pre>
  118. <div class="block">An extension of the <a href="../../../org/jfree/data/Values2D.html" title="interface in org.jfree.data"><code>Values2D</code></a> interface where a unique key is
  119. associated with the row and column indices.</div>
  120. </li>
  121. </ul>
  122. </div>
  123. <div class="summary">
  124. <ul class="blockList">
  125. <li class="blockList">
  126. <!-- ========== METHOD SUMMARY =========== -->
  127. <ul class="blockList">
  128. <li class="blockList"><a name="method.summary">
  129. <!-- -->
  130. </a>
  131. <h3>Method Summary</h3>
  132. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  133. <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>
  134. <tr>
  135. <th class="colFirst" scope="col">Modifier and Type</th>
  136. <th class="colLast" scope="col">Method and Description</th>
  137. </tr>
  138. <tr id="i0" class="altColor">
  139. <td class="colFirst"><code>int</code></td>
  140. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValues2D.html#getColumnIndex-java.lang.Comparable-">getColumnIndex</a></span>(java.lang.Comparable&nbsp;key)</code>
  141. <div class="block">Returns the column index for a given key.</div>
  142. </td>
  143. </tr>
  144. <tr id="i1" class="rowColor">
  145. <td class="colFirst"><code>java.lang.Comparable</code></td>
  146. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValues2D.html#getColumnKey-int-">getColumnKey</a></span>(int&nbsp;column)</code>
  147. <div class="block">Returns the column key for a given index.</div>
  148. </td>
  149. </tr>
  150. <tr id="i2" class="altColor">
  151. <td class="colFirst"><code>java.util.List</code></td>
  152. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValues2D.html#getColumnKeys--">getColumnKeys</a></span>()</code>
  153. <div class="block">Returns the column keys.</div>
  154. </td>
  155. </tr>
  156. <tr id="i3" class="rowColor">
  157. <td class="colFirst"><code>int</code></td>
  158. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValues2D.html#getRowIndex-java.lang.Comparable-">getRowIndex</a></span>(java.lang.Comparable&nbsp;key)</code>
  159. <div class="block">Returns the row index for a given key.</div>
  160. </td>
  161. </tr>
  162. <tr id="i4" class="altColor">
  163. <td class="colFirst"><code>java.lang.Comparable</code></td>
  164. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValues2D.html#getRowKey-int-">getRowKey</a></span>(int&nbsp;row)</code>
  165. <div class="block">Returns the row key for a given index.</div>
  166. </td>
  167. </tr>
  168. <tr id="i5" class="rowColor">
  169. <td class="colFirst"><code>java.util.List</code></td>
  170. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValues2D.html#getRowKeys--">getRowKeys</a></span>()</code>
  171. <div class="block">Returns the row keys.</div>
  172. </td>
  173. </tr>
  174. <tr id="i6" class="altColor">
  175. <td class="colFirst"><code>java.lang.Number</code></td>
  176. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedValues2D.html#getValue-java.lang.Comparable-java.lang.Comparable-">getValue</a></span>(java.lang.Comparable&nbsp;rowKey,
  177. java.lang.Comparable&nbsp;columnKey)</code>
  178. <div class="block">Returns the value associated with the specified keys.</div>
  179. </td>
  180. </tr>
  181. </table>
  182. <ul class="blockList">
  183. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.data.Values2D">
  184. <!-- -->
  185. </a>
  186. <h3>Methods inherited from interface&nbsp;org.jfree.data.<a href="../../../org/jfree/data/Values2D.html" title="interface in org.jfree.data">Values2D</a></h3>
  187. <code><a href="../../../org/jfree/data/Values2D.html#getColumnCount--">getColumnCount</a>, <a href="../../../org/jfree/data/Values2D.html#getRowCount--">getRowCount</a>, <a href="../../../org/jfree/data/Values2D.html#getValue-int-int-">getValue</a></code></li>
  188. </ul>
  189. </li>
  190. </ul>
  191. </li>
  192. </ul>
  193. </div>
  194. <div class="details">
  195. <ul class="blockList">
  196. <li class="blockList">
  197. <!-- ============ METHOD DETAIL ========== -->
  198. <ul class="blockList">
  199. <li class="blockList"><a name="method.detail">
  200. <!-- -->
  201. </a>
  202. <h3>Method Detail</h3>
  203. <a name="getRowKey-int-">
  204. <!-- -->
  205. </a>
  206. <ul class="blockList">
  207. <li class="blockList">
  208. <h4>getRowKey</h4>
  209. <pre>java.lang.Comparable&nbsp;<a href="../../../src-html/org/jfree/data/KeyedValues2D.html#line.61">getRowKey</a>(int&nbsp;row)</pre>
  210. <div class="block">Returns the row key for a given index.</div>
  211. <dl>
  212. <dt><span class="paramLabel">Parameters:</span></dt>
  213. <dd><code>row</code> - the row index (zero-based).</dd>
  214. <dt><span class="returnLabel">Returns:</span></dt>
  215. <dd>The row key.</dd>
  216. <dt><span class="throwsLabel">Throws:</span></dt>
  217. <dd><code>java.lang.IndexOutOfBoundsException</code> - if <code>row</code> is out of bounds.</dd>
  218. </dl>
  219. </li>
  220. </ul>
  221. <a name="getRowIndex-java.lang.Comparable-">
  222. <!-- -->
  223. </a>
  224. <ul class="blockList">
  225. <li class="blockList">
  226. <h4>getRowIndex</h4>
  227. <pre>int&nbsp;<a href="../../../src-html/org/jfree/data/KeyedValues2D.html#line.70">getRowIndex</a>(java.lang.Comparable&nbsp;key)</pre>
  228. <div class="block">Returns the row index for a given key.</div>
  229. <dl>
  230. <dt><span class="paramLabel">Parameters:</span></dt>
  231. <dd><code>key</code> - the row key.</dd>
  232. <dt><span class="returnLabel">Returns:</span></dt>
  233. <dd>The row index, or <code>-1</code> if the key is unrecognised.</dd>
  234. </dl>
  235. </li>
  236. </ul>
  237. <a name="getRowKeys--">
  238. <!-- -->
  239. </a>
  240. <ul class="blockList">
  241. <li class="blockList">
  242. <h4>getRowKeys</h4>
  243. <pre>java.util.List&nbsp;<a href="../../../src-html/org/jfree/data/KeyedValues2D.html#line.77">getRowKeys</a>()</pre>
  244. <div class="block">Returns the row keys.</div>
  245. <dl>
  246. <dt><span class="returnLabel">Returns:</span></dt>
  247. <dd>The keys.</dd>
  248. </dl>
  249. </li>
  250. </ul>
  251. <a name="getColumnKey-int-">
  252. <!-- -->
  253. </a>
  254. <ul class="blockList">
  255. <li class="blockList">
  256. <h4>getColumnKey</h4>
  257. <pre>java.lang.Comparable&nbsp;<a href="../../../src-html/org/jfree/data/KeyedValues2D.html#line.88">getColumnKey</a>(int&nbsp;column)</pre>
  258. <div class="block">Returns the column key for a given index.</div>
  259. <dl>
  260. <dt><span class="paramLabel">Parameters:</span></dt>
  261. <dd><code>column</code> - the column index (zero-based).</dd>
  262. <dt><span class="returnLabel">Returns:</span></dt>
  263. <dd>The column key.</dd>
  264. <dt><span class="throwsLabel">Throws:</span></dt>
  265. <dd><code>java.lang.IndexOutOfBoundsException</code> - if <code>row</code> is out of bounds.</dd>
  266. </dl>
  267. </li>
  268. </ul>
  269. <a name="getColumnIndex-java.lang.Comparable-">
  270. <!-- -->
  271. </a>
  272. <ul class="blockList">
  273. <li class="blockList">
  274. <h4>getColumnIndex</h4>
  275. <pre>int&nbsp;<a href="../../../src-html/org/jfree/data/KeyedValues2D.html#line.97">getColumnIndex</a>(java.lang.Comparable&nbsp;key)</pre>
  276. <div class="block">Returns the column index for a given key.</div>
  277. <dl>
  278. <dt><span class="paramLabel">Parameters:</span></dt>
  279. <dd><code>key</code> - the column key.</dd>
  280. <dt><span class="returnLabel">Returns:</span></dt>
  281. <dd>The column index, or <code>-1</code> if the key is unrecognised.</dd>
  282. </dl>
  283. </li>
  284. </ul>
  285. <a name="getColumnKeys--">
  286. <!-- -->
  287. </a>
  288. <ul class="blockList">
  289. <li class="blockList">
  290. <h4>getColumnKeys</h4>
  291. <pre>java.util.List&nbsp;<a href="../../../src-html/org/jfree/data/KeyedValues2D.html#line.104">getColumnKeys</a>()</pre>
  292. <div class="block">Returns the column keys.</div>
  293. <dl>
  294. <dt><span class="returnLabel">Returns:</span></dt>
  295. <dd>The keys.</dd>
  296. </dl>
  297. </li>
  298. </ul>
  299. <a name="getValue-java.lang.Comparable-java.lang.Comparable-">
  300. <!-- -->
  301. </a>
  302. <ul class="blockListLast">
  303. <li class="blockList">
  304. <h4>getValue</h4>
  305. <pre>java.lang.Number&nbsp;<a href="../../../src-html/org/jfree/data/KeyedValues2D.html#line.116">getValue</a>(java.lang.Comparable&nbsp;rowKey,
  306. java.lang.Comparable&nbsp;columnKey)</pre>
  307. <div class="block">Returns the value associated with the specified keys.</div>
  308. <dl>
  309. <dt><span class="paramLabel">Parameters:</span></dt>
  310. <dd><code>rowKey</code> - the row key (<code>null</code> not permitted).</dd>
  311. <dd><code>columnKey</code> - the column key (<code>null</code> not permitted).</dd>
  312. <dt><span class="returnLabel">Returns:</span></dt>
  313. <dd>The value.</dd>
  314. <dt><span class="throwsLabel">Throws:</span></dt>
  315. <dd><code><a href="../../../org/jfree/data/UnknownKeyException.html" title="class in org.jfree.data">UnknownKeyException</a></code> - if either key is not recognised.</dd>
  316. </dl>
  317. </li>
  318. </ul>
  319. </li>
  320. </ul>
  321. </li>
  322. </ul>
  323. </div>
  324. </div>
  325. <!-- ========= END OF CLASS DATA ========= -->
  326. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  327. <div class="bottomNav"><a name="navbar.bottom">
  328. <!-- -->
  329. </a>
  330. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  331. <a name="navbar.bottom.firstrow">
  332. <!-- -->
  333. </a>
  334. <ul class="navList" title="Navigation">
  335. <li><a href="../../../overview-summary.html">Overview</a></li>
  336. <li><a href="package-summary.html">Package</a></li>
  337. <li class="navBarCell1Rev">Class</li>
  338. <li><a href="class-use/KeyedValues2D.html">Use</a></li>
  339. <li><a href="package-tree.html">Tree</a></li>
  340. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  341. <li><a href="../../../index-files/index-1.html">Index</a></li>
  342. <li><a href="../../../help-doc.html">Help</a></li>
  343. </ul>
  344. </div>
  345. <div class="subNav">
  346. <ul class="navList">
  347. <li><a href="../../../org/jfree/data/KeyedValues.html" title="interface in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  348. <li><a href="../../../org/jfree/data/KeyToGroupMap.html" title="class in org.jfree.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  349. </ul>
  350. <ul class="navList">
  351. <li><a href="../../../index.html?org/jfree/data/KeyedValues2D.html" target="_top">Frames</a></li>
  352. <li><a href="KeyedValues2D.html" target="_top">No&nbsp;Frames</a></li>
  353. </ul>
  354. <ul class="navList" id="allclasses_navbar_bottom">
  355. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  356. </ul>
  357. <div>
  358. <script type="text/javascript"><!--
  359. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  360. if(window==top) {
  361. allClassesLink.style.display = "block";
  362. }
  363. else {
  364. allClassesLink.style.display = "none";
  365. }
  366. //-->
  367. </script>
  368. </div>
  369. <div>
  370. <ul class="subNavList">
  371. <li>Summary:&nbsp;</li>
  372. <li>Nested&nbsp;|&nbsp;</li>
  373. <li>Field&nbsp;|&nbsp;</li>
  374. <li>Constr&nbsp;|&nbsp;</li>
  375. <li><a href="#method.summary">Method</a></li>
  376. </ul>
  377. <ul class="subNavList">
  378. <li>Detail:&nbsp;</li>
  379. <li>Field&nbsp;|&nbsp;</li>
  380. <li>Constr&nbsp;|&nbsp;</li>
  381. <li><a href="#method.detail">Method</a></li>
  382. </ul>
  383. </div>
  384. <a name="skip.navbar.bottom">
  385. <!-- -->
  386. </a></div>
  387. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  388. </body>
  389. </html>