KeyedObjects2D.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780
  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>KeyedObjects2D (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="KeyedObjects2D (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/KeyedObjects2D.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/KeyedObjects.html" title="class in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../org/jfree/data/KeyedValue.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/KeyedObjects2D.html" target="_top">Frames</a></li>
  57. <li><a href="KeyedObjects2D.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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="Class KeyedObjects2D" class="title">Class KeyedObjects2D</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>org.jfree.data.KeyedObjects2D</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <dd>java.io.Serializable, java.lang.Cloneable</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.58">KeyedObjects2D</a>
  117. extends java.lang.Object
  118. implements java.lang.Cloneable, java.io.Serializable</pre>
  119. <div class="block">A data structure that stores zero, one or many objects, where each object is
  120. associated with two keys (a 'row' key and a 'column' key).</div>
  121. <dl>
  122. <dt><span class="seeLabel">See Also:</span></dt>
  123. <dd><a href="../../../serialized-form.html#org.jfree.data.KeyedObjects2D">Serialized Form</a></dd>
  124. </dl>
  125. </li>
  126. </ul>
  127. </div>
  128. <div class="summary">
  129. <ul class="blockList">
  130. <li class="blockList">
  131. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  132. <ul class="blockList">
  133. <li class="blockList"><a name="constructor.summary">
  134. <!-- -->
  135. </a>
  136. <h3>Constructor Summary</h3>
  137. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  138. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  139. <tr>
  140. <th class="colOne" scope="col">Constructor and Description</th>
  141. </tr>
  142. <tr class="altColor">
  143. <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#KeyedObjects2D--">KeyedObjects2D</a></span>()</code>
  144. <div class="block">Creates a new instance (initially empty).</div>
  145. </td>
  146. </tr>
  147. </table>
  148. </li>
  149. </ul>
  150. <!-- ========== METHOD SUMMARY =========== -->
  151. <ul class="blockList">
  152. <li class="blockList"><a name="method.summary">
  153. <!-- -->
  154. </a>
  155. <h3>Method Summary</h3>
  156. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  157. <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  158. <tr>
  159. <th class="colFirst" scope="col">Modifier and Type</th>
  160. <th class="colLast" scope="col">Method and Description</th>
  161. </tr>
  162. <tr id="i0" class="altColor">
  163. <td class="colFirst"><code>void</code></td>
  164. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#addObject-java.lang.Object-java.lang.Comparable-java.lang.Comparable-">addObject</a></span>(java.lang.Object&nbsp;object,
  165. java.lang.Comparable&nbsp;rowKey,
  166. java.lang.Comparable&nbsp;columnKey)</code>
  167. <div class="block">Adds an object to the table.</div>
  168. </td>
  169. </tr>
  170. <tr id="i1" class="rowColor">
  171. <td class="colFirst"><code>void</code></td>
  172. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#clear--">clear</a></span>()</code>
  173. <div class="block">Clears all the data and associated keys.</div>
  174. </td>
  175. </tr>
  176. <tr id="i2" class="altColor">
  177. <td class="colFirst"><code>java.lang.Object</code></td>
  178. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#clone--">clone</a></span>()</code>
  179. <div class="block">Returns a clone.</div>
  180. </td>
  181. </tr>
  182. <tr id="i3" class="rowColor">
  183. <td class="colFirst"><code>boolean</code></td>
  184. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  185. <div class="block">Tests this object for equality with an arbitrary object.</div>
  186. </td>
  187. </tr>
  188. <tr id="i4" class="altColor">
  189. <td class="colFirst"><code>int</code></td>
  190. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#getColumnCount--">getColumnCount</a></span>()</code>
  191. <div class="block">Returns the column count.</div>
  192. </td>
  193. </tr>
  194. <tr id="i5" class="rowColor">
  195. <td class="colFirst"><code>int</code></td>
  196. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#getColumnIndex-java.lang.Comparable-">getColumnIndex</a></span>(java.lang.Comparable&nbsp;key)</code>
  197. <div class="block">Returns the column index for a given key, or <code>-1</code> if the key
  198. is not recognised.</div>
  199. </td>
  200. </tr>
  201. <tr id="i6" class="altColor">
  202. <td class="colFirst"><code>java.lang.Comparable</code></td>
  203. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#getColumnKey-int-">getColumnKey</a></span>(int&nbsp;column)</code>
  204. <div class="block">Returns the key for a given column.</div>
  205. </td>
  206. </tr>
  207. <tr id="i7" class="rowColor">
  208. <td class="colFirst"><code>java.util.List</code></td>
  209. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#getColumnKeys--">getColumnKeys</a></span>()</code>
  210. <div class="block">Returns the column keys.</div>
  211. </td>
  212. </tr>
  213. <tr id="i8" class="altColor">
  214. <td class="colFirst"><code>java.lang.Object</code></td>
  215. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#getObject-java.lang.Comparable-java.lang.Comparable-">getObject</a></span>(java.lang.Comparable&nbsp;rowKey,
  216. java.lang.Comparable&nbsp;columnKey)</code>
  217. <div class="block">Returns the object for the given row and column keys.</div>
  218. </td>
  219. </tr>
  220. <tr id="i9" class="rowColor">
  221. <td class="colFirst"><code>java.lang.Object</code></td>
  222. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#getObject-int-int-">getObject</a></span>(int&nbsp;row,
  223. int&nbsp;column)</code>
  224. <div class="block">Returns the object for a given row and column.</div>
  225. </td>
  226. </tr>
  227. <tr id="i10" class="altColor">
  228. <td class="colFirst"><code>int</code></td>
  229. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#getRowCount--">getRowCount</a></span>()</code>
  230. <div class="block">Returns the row count.</div>
  231. </td>
  232. </tr>
  233. <tr id="i11" class="rowColor">
  234. <td class="colFirst"><code>int</code></td>
  235. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#getRowIndex-java.lang.Comparable-">getRowIndex</a></span>(java.lang.Comparable&nbsp;key)</code>
  236. <div class="block">Returns the row index for a given key, or <code>-1</code> if the key
  237. is not recognised.</div>
  238. </td>
  239. </tr>
  240. <tr id="i12" class="altColor">
  241. <td class="colFirst"><code>java.lang.Comparable</code></td>
  242. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#getRowKey-int-">getRowKey</a></span>(int&nbsp;row)</code>
  243. <div class="block">Returns the key for a given row.</div>
  244. </td>
  245. </tr>
  246. <tr id="i13" class="rowColor">
  247. <td class="colFirst"><code>java.util.List</code></td>
  248. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#getRowKeys--">getRowKeys</a></span>()</code>
  249. <div class="block">Returns the row keys.</div>
  250. </td>
  251. </tr>
  252. <tr id="i14" class="altColor">
  253. <td class="colFirst"><code>int</code></td>
  254. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#hashCode--">hashCode</a></span>()</code>
  255. <div class="block">Returns a hashcode for this object.</div>
  256. </td>
  257. </tr>
  258. <tr id="i15" class="rowColor">
  259. <td class="colFirst"><code>void</code></td>
  260. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#removeColumn-java.lang.Comparable-">removeColumn</a></span>(java.lang.Comparable&nbsp;columnKey)</code>
  261. <div class="block">Removes an entire column from the table.</div>
  262. </td>
  263. </tr>
  264. <tr id="i16" class="altColor">
  265. <td class="colFirst"><code>void</code></td>
  266. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#removeColumn-int-">removeColumn</a></span>(int&nbsp;columnIndex)</code>
  267. <div class="block">Removes an entire column from the table.</div>
  268. </td>
  269. </tr>
  270. <tr id="i17" class="rowColor">
  271. <td class="colFirst"><code>void</code></td>
  272. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#removeObject-java.lang.Comparable-java.lang.Comparable-">removeObject</a></span>(java.lang.Comparable&nbsp;rowKey,
  273. java.lang.Comparable&nbsp;columnKey)</code>
  274. <div class="block">Removes an object from the table by setting it to <code>null</code>.</div>
  275. </td>
  276. </tr>
  277. <tr id="i18" class="altColor">
  278. <td class="colFirst"><code>void</code></td>
  279. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#removeRow-java.lang.Comparable-">removeRow</a></span>(java.lang.Comparable&nbsp;rowKey)</code>
  280. <div class="block">Removes an entire row from the table.</div>
  281. </td>
  282. </tr>
  283. <tr id="i19" class="rowColor">
  284. <td class="colFirst"><code>void</code></td>
  285. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#removeRow-int-">removeRow</a></span>(int&nbsp;rowIndex)</code>
  286. <div class="block">Removes an entire row from the table.</div>
  287. </td>
  288. </tr>
  289. <tr id="i20" class="altColor">
  290. <td class="colFirst"><code>void</code></td>
  291. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/KeyedObjects2D.html#setObject-java.lang.Object-java.lang.Comparable-java.lang.Comparable-">setObject</a></span>(java.lang.Object&nbsp;object,
  292. java.lang.Comparable&nbsp;rowKey,
  293. java.lang.Comparable&nbsp;columnKey)</code>
  294. <div class="block">Adds or updates an object.</div>
  295. </td>
  296. </tr>
  297. </table>
  298. <ul class="blockList">
  299. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  300. <!-- -->
  301. </a>
  302. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  303. <code>finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
  304. </ul>
  305. </li>
  306. </ul>
  307. </li>
  308. </ul>
  309. </div>
  310. <div class="details">
  311. <ul class="blockList">
  312. <li class="blockList">
  313. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  314. <ul class="blockList">
  315. <li class="blockList"><a name="constructor.detail">
  316. <!-- -->
  317. </a>
  318. <h3>Constructor Detail</h3>
  319. <a name="KeyedObjects2D--">
  320. <!-- -->
  321. </a>
  322. <ul class="blockListLast">
  323. <li class="blockList">
  324. <h4>KeyedObjects2D</h4>
  325. <pre>public&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.75">KeyedObjects2D</a>()</pre>
  326. <div class="block">Creates a new instance (initially empty).</div>
  327. </li>
  328. </ul>
  329. </li>
  330. </ul>
  331. <!-- ============ METHOD DETAIL ========== -->
  332. <ul class="blockList">
  333. <li class="blockList"><a name="method.detail">
  334. <!-- -->
  335. </a>
  336. <h3>Method Detail</h3>
  337. <a name="getRowCount--">
  338. <!-- -->
  339. </a>
  340. <ul class="blockList">
  341. <li class="blockList">
  342. <h4>getRowCount</h4>
  343. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.88">getRowCount</a>()</pre>
  344. <div class="block">Returns the row count.</div>
  345. <dl>
  346. <dt><span class="returnLabel">Returns:</span></dt>
  347. <dd>The row count.</dd>
  348. <dt><span class="seeLabel">See Also:</span></dt>
  349. <dd><a href="../../../org/jfree/data/KeyedObjects2D.html#getColumnCount--"><code>getColumnCount()</code></a></dd>
  350. </dl>
  351. </li>
  352. </ul>
  353. <a name="getColumnCount--">
  354. <!-- -->
  355. </a>
  356. <ul class="blockList">
  357. <li class="blockList">
  358. <h4>getColumnCount</h4>
  359. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.99">getColumnCount</a>()</pre>
  360. <div class="block">Returns the column count.</div>
  361. <dl>
  362. <dt><span class="returnLabel">Returns:</span></dt>
  363. <dd>The column count.</dd>
  364. <dt><span class="seeLabel">See Also:</span></dt>
  365. <dd><a href="../../../org/jfree/data/KeyedObjects2D.html#getRowCount--"><code>getRowCount()</code></a></dd>
  366. </dl>
  367. </li>
  368. </ul>
  369. <a name="getObject-int-int-">
  370. <!-- -->
  371. </a>
  372. <ul class="blockList">
  373. <li class="blockList">
  374. <h4>getObject</h4>
  375. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.113">getObject</a>(int&nbsp;row,
  376. int&nbsp;column)</pre>
  377. <div class="block">Returns the object for a given row and column.</div>
  378. <dl>
  379. <dt><span class="paramLabel">Parameters:</span></dt>
  380. <dd><code>row</code> - the row index (in the range 0 to getRowCount() - 1).</dd>
  381. <dd><code>column</code> - the column index (in the range 0 to getColumnCount() - 1).</dd>
  382. <dt><span class="returnLabel">Returns:</span></dt>
  383. <dd>The object (possibly <code>null</code>).</dd>
  384. <dt><span class="seeLabel">See Also:</span></dt>
  385. <dd><a href="../../../org/jfree/data/KeyedObjects2D.html#getObject-java.lang.Comparable-java.lang.Comparable-"><code>getObject(Comparable, Comparable)</code></a></dd>
  386. </dl>
  387. </li>
  388. </ul>
  389. <a name="getRowKey-int-">
  390. <!-- -->
  391. </a>
  392. <ul class="blockList">
  393. <li class="blockList">
  394. <h4>getRowKey</h4>
  395. <pre>public&nbsp;java.lang.Comparable&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.137">getRowKey</a>(int&nbsp;row)</pre>
  396. <div class="block">Returns the key for a given row.</div>
  397. <dl>
  398. <dt><span class="paramLabel">Parameters:</span></dt>
  399. <dd><code>row</code> - the row index (zero based).</dd>
  400. <dt><span class="returnLabel">Returns:</span></dt>
  401. <dd>The row index.</dd>
  402. <dt><span class="seeLabel">See Also:</span></dt>
  403. <dd><a href="../../../org/jfree/data/KeyedObjects2D.html#getRowIndex-java.lang.Comparable-"><code>getRowIndex(Comparable)</code></a></dd>
  404. </dl>
  405. </li>
  406. </ul>
  407. <a name="getRowIndex-java.lang.Comparable-">
  408. <!-- -->
  409. </a>
  410. <ul class="blockList">
  411. <li class="blockList">
  412. <h4>getRowIndex</h4>
  413. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.151">getRowIndex</a>(java.lang.Comparable&nbsp;key)</pre>
  414. <div class="block">Returns the row index for a given key, or <code>-1</code> if the key
  415. is not recognised.</div>
  416. <dl>
  417. <dt><span class="paramLabel">Parameters:</span></dt>
  418. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  419. <dt><span class="returnLabel">Returns:</span></dt>
  420. <dd>The row index.</dd>
  421. <dt><span class="seeLabel">See Also:</span></dt>
  422. <dd><a href="../../../org/jfree/data/KeyedObjects2D.html#getRowKey-int-"><code>getRowKey(int)</code></a></dd>
  423. </dl>
  424. </li>
  425. </ul>
  426. <a name="getRowKeys--">
  427. <!-- -->
  428. </a>
  429. <ul class="blockList">
  430. <li class="blockList">
  431. <h4>getRowKeys</h4>
  432. <pre>public&nbsp;java.util.List&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.163">getRowKeys</a>()</pre>
  433. <div class="block">Returns the row keys.</div>
  434. <dl>
  435. <dt><span class="returnLabel">Returns:</span></dt>
  436. <dd>The row keys (never <code>null</code>).</dd>
  437. <dt><span class="seeLabel">See Also:</span></dt>
  438. <dd><a href="../../../org/jfree/data/KeyedObjects2D.html#getRowKeys--"><code>getRowKeys()</code></a></dd>
  439. </dl>
  440. </li>
  441. </ul>
  442. <a name="getColumnKey-int-">
  443. <!-- -->
  444. </a>
  445. <ul class="blockList">
  446. <li class="blockList">
  447. <h4>getColumnKey</h4>
  448. <pre>public&nbsp;java.lang.Comparable&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.176">getColumnKey</a>(int&nbsp;column)</pre>
  449. <div class="block">Returns the key for a given column.</div>
  450. <dl>
  451. <dt><span class="paramLabel">Parameters:</span></dt>
  452. <dd><code>column</code> - the column.</dd>
  453. <dt><span class="returnLabel">Returns:</span></dt>
  454. <dd>The key.</dd>
  455. <dt><span class="seeLabel">See Also:</span></dt>
  456. <dd><a href="../../../org/jfree/data/KeyedObjects2D.html#getColumnIndex-java.lang.Comparable-"><code>getColumnIndex(Comparable)</code></a></dd>
  457. </dl>
  458. </li>
  459. </ul>
  460. <a name="getColumnIndex-java.lang.Comparable-">
  461. <!-- -->
  462. </a>
  463. <ul class="blockList">
  464. <li class="blockList">
  465. <h4>getColumnIndex</h4>
  466. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.190">getColumnIndex</a>(java.lang.Comparable&nbsp;key)</pre>
  467. <div class="block">Returns the column index for a given key, or <code>-1</code> if the key
  468. is not recognised.</div>
  469. <dl>
  470. <dt><span class="paramLabel">Parameters:</span></dt>
  471. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  472. <dt><span class="returnLabel">Returns:</span></dt>
  473. <dd>The column index.</dd>
  474. <dt><span class="seeLabel">See Also:</span></dt>
  475. <dd><a href="../../../org/jfree/data/KeyedObjects2D.html#getColumnKey-int-"><code>getColumnKey(int)</code></a></dd>
  476. </dl>
  477. </li>
  478. </ul>
  479. <a name="getColumnKeys--">
  480. <!-- -->
  481. </a>
  482. <ul class="blockList">
  483. <li class="blockList">
  484. <h4>getColumnKeys</h4>
  485. <pre>public&nbsp;java.util.List&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.202">getColumnKeys</a>()</pre>
  486. <div class="block">Returns the column keys.</div>
  487. <dl>
  488. <dt><span class="returnLabel">Returns:</span></dt>
  489. <dd>The column keys (never <code>null</code>).</dd>
  490. <dt><span class="seeLabel">See Also:</span></dt>
  491. <dd><a href="../../../org/jfree/data/KeyedObjects2D.html#getRowKeys--"><code>getRowKeys()</code></a></dd>
  492. </dl>
  493. </li>
  494. </ul>
  495. <a name="getObject-java.lang.Comparable-java.lang.Comparable-">
  496. <!-- -->
  497. </a>
  498. <ul class="blockList">
  499. <li class="blockList">
  500. <h4>getObject</h4>
  501. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.219">getObject</a>(java.lang.Comparable&nbsp;rowKey,
  502. java.lang.Comparable&nbsp;columnKey)</pre>
  503. <div class="block">Returns the object for the given row and column keys.</div>
  504. <dl>
  505. <dt><span class="paramLabel">Parameters:</span></dt>
  506. <dd><code>rowKey</code> - the row key (<code>null</code> not permitted).</dd>
  507. <dd><code>columnKey</code> - the column key (<code>null</code> not permitted).</dd>
  508. <dt><span class="returnLabel">Returns:</span></dt>
  509. <dd>The object (possibly <code>null</code>).</dd>
  510. <dt><span class="throwsLabel">Throws:</span></dt>
  511. <dd><code>java.lang.IllegalArgumentException</code> - if <code>rowKey</code> or
  512. <code>columnKey</code> is <code>null</code>.</dd>
  513. <dd><code><a href="../../../org/jfree/data/UnknownKeyException.html" title="class in org.jfree.data">UnknownKeyException</a></code> - if <code>rowKey</code> or
  514. <code>columnKey</code> is not recognised.</dd>
  515. </dl>
  516. </li>
  517. </ul>
  518. <a name="addObject-java.lang.Object-java.lang.Comparable-java.lang.Comparable-">
  519. <!-- -->
  520. </a>
  521. <ul class="blockList">
  522. <li class="blockList">
  523. <h4>addObject</h4>
  524. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.249">addObject</a>(java.lang.Object&nbsp;object,
  525. java.lang.Comparable&nbsp;rowKey,
  526. java.lang.Comparable&nbsp;columnKey)</pre>
  527. <div class="block">Adds an object to the table. Performs the same function as setObject().</div>
  528. <dl>
  529. <dt><span class="paramLabel">Parameters:</span></dt>
  530. <dd><code>object</code> - the object.</dd>
  531. <dd><code>rowKey</code> - the row key (<code>null</code> not permitted).</dd>
  532. <dd><code>columnKey</code> - the column key (<code>null</code> not permitted).</dd>
  533. </dl>
  534. </li>
  535. </ul>
  536. <a name="setObject-java.lang.Object-java.lang.Comparable-java.lang.Comparable-">
  537. <!-- -->
  538. </a>
  539. <ul class="blockList">
  540. <li class="blockList">
  541. <h4>setObject</h4>
  542. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.261">setObject</a>(java.lang.Object&nbsp;object,
  543. java.lang.Comparable&nbsp;rowKey,
  544. java.lang.Comparable&nbsp;columnKey)</pre>
  545. <div class="block">Adds or updates an object.</div>
  546. <dl>
  547. <dt><span class="paramLabel">Parameters:</span></dt>
  548. <dd><code>object</code> - the object.</dd>
  549. <dd><code>rowKey</code> - the row key (<code>null</code> not permitted).</dd>
  550. <dd><code>columnKey</code> - the column key (<code>null</code> not permitted).</dd>
  551. </dl>
  552. </li>
  553. </ul>
  554. <a name="removeObject-java.lang.Comparable-java.lang.Comparable-">
  555. <!-- -->
  556. </a>
  557. <ul class="blockList">
  558. <li class="blockList">
  559. <h4>removeObject</h4>
  560. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.292">removeObject</a>(java.lang.Comparable&nbsp;rowKey,
  561. java.lang.Comparable&nbsp;columnKey)</pre>
  562. <div class="block">Removes an object from the table by setting it to <code>null</code>. If
  563. all the objects in the specified row and/or column are now
  564. <code>null</code>, the row and/or column is removed from the table.</div>
  565. <dl>
  566. <dt><span class="paramLabel">Parameters:</span></dt>
  567. <dd><code>rowKey</code> - the row key (<code>null</code> not permitted).</dd>
  568. <dd><code>columnKey</code> - the column key (<code>null</code> not permitted).</dd>
  569. <dt><span class="seeLabel">See Also:</span></dt>
  570. <dd><a href="../../../org/jfree/data/KeyedObjects2D.html#addObject-java.lang.Object-java.lang.Comparable-java.lang.Comparable-"><code>addObject(Object, Comparable, Comparable)</code></a></dd>
  571. </dl>
  572. </li>
  573. </ul>
  574. <a name="removeRow-int-">
  575. <!-- -->
  576. </a>
  577. <ul class="blockList">
  578. <li class="blockList">
  579. <h4>removeRow</h4>
  580. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.355">removeRow</a>(int&nbsp;rowIndex)</pre>
  581. <div class="block">Removes an entire row from the table.</div>
  582. <dl>
  583. <dt><span class="paramLabel">Parameters:</span></dt>
  584. <dd><code>rowIndex</code> - the row index.</dd>
  585. <dt><span class="seeLabel">See Also:</span></dt>
  586. <dd><a href="../../../org/jfree/data/KeyedObjects2D.html#removeColumn-int-"><code>removeColumn(int)</code></a></dd>
  587. </dl>
  588. </li>
  589. </ul>
  590. <a name="removeRow-java.lang.Comparable-">
  591. <!-- -->
  592. </a>
  593. <ul class="blockList">
  594. <li class="blockList">
  595. <h4>removeRow</h4>
  596. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.369">removeRow</a>(java.lang.Comparable&nbsp;rowKey)</pre>
  597. <div class="block">Removes an entire row from the table.</div>
  598. <dl>
  599. <dt><span class="paramLabel">Parameters:</span></dt>
  600. <dd><code>rowKey</code> - the row key (<code>null</code> not permitted).</dd>
  601. <dt><span class="throwsLabel">Throws:</span></dt>
  602. <dd><code><a href="../../../org/jfree/data/UnknownKeyException.html" title="class in org.jfree.data">UnknownKeyException</a></code> - if <code>rowKey</code> is not recognised.</dd>
  603. <dt><span class="seeLabel">See Also:</span></dt>
  604. <dd><a href="../../../org/jfree/data/KeyedObjects2D.html#removeColumn-java.lang.Comparable-"><code>removeColumn(Comparable)</code></a></dd>
  605. </dl>
  606. </li>
  607. </ul>
  608. <a name="removeColumn-int-">
  609. <!-- -->
  610. </a>
  611. <ul class="blockList">
  612. <li class="blockList">
  613. <h4>removeColumn</h4>
  614. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.385">removeColumn</a>(int&nbsp;columnIndex)</pre>
  615. <div class="block">Removes an entire column from the table.</div>
  616. <dl>
  617. <dt><span class="paramLabel">Parameters:</span></dt>
  618. <dd><code>columnIndex</code> - the column index.</dd>
  619. <dt><span class="seeLabel">See Also:</span></dt>
  620. <dd><a href="../../../org/jfree/data/KeyedObjects2D.html#removeRow-int-"><code>removeRow(int)</code></a></dd>
  621. </dl>
  622. </li>
  623. </ul>
  624. <a name="removeColumn-java.lang.Comparable-">
  625. <!-- -->
  626. </a>
  627. <ul class="blockList">
  628. <li class="blockList">
  629. <h4>removeColumn</h4>
  630. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.399">removeColumn</a>(java.lang.Comparable&nbsp;columnKey)</pre>
  631. <div class="block">Removes an entire column from the table.</div>
  632. <dl>
  633. <dt><span class="paramLabel">Parameters:</span></dt>
  634. <dd><code>columnKey</code> - the column key (<code>null</code> not permitted).</dd>
  635. <dt><span class="throwsLabel">Throws:</span></dt>
  636. <dd><code><a href="../../../org/jfree/data/UnknownKeyException.html" title="class in org.jfree.data">UnknownKeyException</a></code> - if <code>rowKey</code> is not recognised.</dd>
  637. <dt><span class="seeLabel">See Also:</span></dt>
  638. <dd><a href="../../../org/jfree/data/KeyedObjects2D.html#removeRow-java.lang.Comparable-"><code>removeRow(Comparable)</code></a></dd>
  639. </dl>
  640. </li>
  641. </ul>
  642. <a name="clear--">
  643. <!-- -->
  644. </a>
  645. <ul class="blockList">
  646. <li class="blockList">
  647. <h4>clear</h4>
  648. <pre>public&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.421">clear</a>()</pre>
  649. <div class="block">Clears all the data and associated keys.</div>
  650. <dl>
  651. <dt><span class="simpleTagLabel">Since:</span></dt>
  652. <dd>1.0.7</dd>
  653. </dl>
  654. </li>
  655. </ul>
  656. <a name="equals-java.lang.Object-">
  657. <!-- -->
  658. </a>
  659. <ul class="blockList">
  660. <li class="blockList">
  661. <h4>equals</h4>
  662. <pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.435">equals</a>(java.lang.Object&nbsp;obj)</pre>
  663. <div class="block">Tests this object for equality with an arbitrary object.</div>
  664. <dl>
  665. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  666. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  667. <dt><span class="paramLabel">Parameters:</span></dt>
  668. <dd><code>obj</code> - the object to test (<code>null</code> permitted).</dd>
  669. <dt><span class="returnLabel">Returns:</span></dt>
  670. <dd>A boolean.</dd>
  671. </dl>
  672. </li>
  673. </ul>
  674. <a name="hashCode--">
  675. <!-- -->
  676. </a>
  677. <ul class="blockList">
  678. <li class="blockList">
  679. <h4>hashCode</h4>
  680. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.483">hashCode</a>()</pre>
  681. <div class="block">Returns a hashcode for this object.</div>
  682. <dl>
  683. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  684. <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  685. <dt><span class="returnLabel">Returns:</span></dt>
  686. <dd>A hashcode.</dd>
  687. </dl>
  688. </li>
  689. </ul>
  690. <a name="clone--">
  691. <!-- -->
  692. </a>
  693. <ul class="blockListLast">
  694. <li class="blockList">
  695. <h4>clone</h4>
  696. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../src-html/org/jfree/data/KeyedObjects2D.html#line.500">clone</a>()
  697. throws java.lang.CloneNotSupportedException</pre>
  698. <div class="block">Returns a clone.</div>
  699. <dl>
  700. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  701. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  702. <dt><span class="returnLabel">Returns:</span></dt>
  703. <dd>A clone.</dd>
  704. <dt><span class="throwsLabel">Throws:</span></dt>
  705. <dd><code>java.lang.CloneNotSupportedException</code> - this class will not throw this
  706. exception, but subclasses (if any) might.</dd>
  707. </dl>
  708. </li>
  709. </ul>
  710. </li>
  711. </ul>
  712. </li>
  713. </ul>
  714. </div>
  715. </div>
  716. <!-- ========= END OF CLASS DATA ========= -->
  717. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  718. <div class="bottomNav"><a name="navbar.bottom">
  719. <!-- -->
  720. </a>
  721. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  722. <a name="navbar.bottom.firstrow">
  723. <!-- -->
  724. </a>
  725. <ul class="navList" title="Navigation">
  726. <li><a href="../../../overview-summary.html">Overview</a></li>
  727. <li><a href="package-summary.html">Package</a></li>
  728. <li class="navBarCell1Rev">Class</li>
  729. <li><a href="class-use/KeyedObjects2D.html">Use</a></li>
  730. <li><a href="package-tree.html">Tree</a></li>
  731. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  732. <li><a href="../../../index-files/index-1.html">Index</a></li>
  733. <li><a href="../../../help-doc.html">Help</a></li>
  734. </ul>
  735. </div>
  736. <div class="subNav">
  737. <ul class="navList">
  738. <li><a href="../../../org/jfree/data/KeyedObjects.html" title="class in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  739. <li><a href="../../../org/jfree/data/KeyedValue.html" title="interface in org.jfree.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  740. </ul>
  741. <ul class="navList">
  742. <li><a href="../../../index.html?org/jfree/data/KeyedObjects2D.html" target="_top">Frames</a></li>
  743. <li><a href="KeyedObjects2D.html" target="_top">No&nbsp;Frames</a></li>
  744. </ul>
  745. <ul class="navList" id="allclasses_navbar_bottom">
  746. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  747. </ul>
  748. <div>
  749. <script type="text/javascript"><!--
  750. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  751. if(window==top) {
  752. allClassesLink.style.display = "block";
  753. }
  754. else {
  755. allClassesLink.style.display = "none";
  756. }
  757. //-->
  758. </script>
  759. </div>
  760. <div>
  761. <ul class="subNavList">
  762. <li>Summary:&nbsp;</li>
  763. <li>Nested&nbsp;|&nbsp;</li>
  764. <li>Field&nbsp;|&nbsp;</li>
  765. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  766. <li><a href="#method.summary">Method</a></li>
  767. </ul>
  768. <ul class="subNavList">
  769. <li>Detail:&nbsp;</li>
  770. <li>Field&nbsp;|&nbsp;</li>
  771. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  772. <li><a href="#method.detail">Method</a></li>
  773. </ul>
  774. </div>
  775. <a name="skip.navbar.bottom">
  776. <!-- -->
  777. </a></div>
  778. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  779. </body>
  780. </html>