ComparableObjectItem.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449
  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>ComparableObjectItem (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="ComparableObjectItem (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};
  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/ComparableObjectItem.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>Prev&nbsp;Class</li>
  53. <li><a href="../../../org/jfree/data/ComparableObjectSeries.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/ComparableObjectItem.html" target="_top">Frames</a></li>
  57. <li><a href="ComparableObjectItem.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 ComparableObjectItem" class="title">Class ComparableObjectItem</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.ComparableObjectItem</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, java.lang.Comparable</dd>
  113. </dl>
  114. <dl>
  115. <dt>Direct Known Subclasses:</dt>
  116. <dd><a href="../../../org/jfree/data/time/ohlc/OHLCItem.html" title="class in org.jfree.data.time.ohlc">OHLCItem</a>, <a href="../../../org/jfree/data/xy/VectorDataItem.html" title="class in org.jfree.data.xy">VectorDataItem</a>, <a href="../../../org/jfree/data/xy/XIntervalDataItem.html" title="class in org.jfree.data.xy">XIntervalDataItem</a>, <a href="../../../org/jfree/data/xy/XYIntervalDataItem.html" title="class in org.jfree.data.xy">XYIntervalDataItem</a>, <a href="../../../org/jfree/data/xy/YIntervalDataItem.html" title="class in org.jfree.data.xy">YIntervalDataItem</a></dd>
  117. </dl>
  118. <hr>
  119. <br>
  120. <pre>public class <a href="../../../src-html/org/jfree/data/ComparableObjectItem.html#line.55">ComparableObjectItem</a>
  121. extends java.lang.Object
  122. implements java.lang.Cloneable, java.lang.Comparable, java.io.Serializable</pre>
  123. <div class="block">Represents one (Comparable, Object) data item for use in a
  124. <a href="../../../org/jfree/data/ComparableObjectSeries.html" title="class in org.jfree.data"><code>ComparableObjectSeries</code></a>.</div>
  125. <dl>
  126. <dt><span class="simpleTagLabel">Since:</span></dt>
  127. <dd>1.0.3</dd>
  128. <dt><span class="seeLabel">See Also:</span></dt>
  129. <dd><a href="../../../serialized-form.html#org.jfree.data.ComparableObjectItem">Serialized Form</a></dd>
  130. </dl>
  131. </li>
  132. </ul>
  133. </div>
  134. <div class="summary">
  135. <ul class="blockList">
  136. <li class="blockList">
  137. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  138. <ul class="blockList">
  139. <li class="blockList"><a name="constructor.summary">
  140. <!-- -->
  141. </a>
  142. <h3>Constructor Summary</h3>
  143. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  144. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  145. <tr>
  146. <th class="colOne" scope="col">Constructor and Description</th>
  147. </tr>
  148. <tr class="altColor">
  149. <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/jfree/data/ComparableObjectItem.html#ComparableObjectItem-java.lang.Comparable-java.lang.Object-">ComparableObjectItem</a></span>(java.lang.Comparable&nbsp;x,
  150. java.lang.Object&nbsp;y)</code>
  151. <div class="block">Constructs a new data item.</div>
  152. </td>
  153. </tr>
  154. </table>
  155. </li>
  156. </ul>
  157. <!-- ========== METHOD SUMMARY =========== -->
  158. <ul class="blockList">
  159. <li class="blockList"><a name="method.summary">
  160. <!-- -->
  161. </a>
  162. <h3>Method Summary</h3>
  163. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  164. <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>
  165. <tr>
  166. <th class="colFirst" scope="col">Modifier and Type</th>
  167. <th class="colLast" scope="col">Method and Description</th>
  168. </tr>
  169. <tr id="i0" class="altColor">
  170. <td class="colFirst"><code>java.lang.Object</code></td>
  171. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/ComparableObjectItem.html#clone--">clone</a></span>()</code>
  172. <div class="block">Returns a clone of this object.</div>
  173. </td>
  174. </tr>
  175. <tr id="i1" class="rowColor">
  176. <td class="colFirst"><code>int</code></td>
  177. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/ComparableObjectItem.html#compareTo-java.lang.Object-">compareTo</a></span>(java.lang.Object&nbsp;o1)</code>
  178. <div class="block">Returns an integer indicating the order of this object relative to
  179. another object.</div>
  180. </td>
  181. </tr>
  182. <tr id="i2" class="altColor">
  183. <td class="colFirst"><code>boolean</code></td>
  184. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/ComparableObjectItem.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  185. <div class="block">Tests if this object is equal to another.</div>
  186. </td>
  187. </tr>
  188. <tr id="i3" class="rowColor">
  189. <td class="colFirst"><code>protected java.lang.Comparable</code></td>
  190. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/ComparableObjectItem.html#getComparable--">getComparable</a></span>()</code>
  191. <div class="block">Returns the x-value.</div>
  192. </td>
  193. </tr>
  194. <tr id="i4" class="altColor">
  195. <td class="colFirst"><code>protected java.lang.Object</code></td>
  196. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/ComparableObjectItem.html#getObject--">getObject</a></span>()</code>
  197. <div class="block">Returns the y-value.</div>
  198. </td>
  199. </tr>
  200. <tr id="i5" class="rowColor">
  201. <td class="colFirst"><code>int</code></td>
  202. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/ComparableObjectItem.html#hashCode--">hashCode</a></span>()</code>
  203. <div class="block">Returns a hash code.</div>
  204. </td>
  205. </tr>
  206. <tr id="i6" class="altColor">
  207. <td class="colFirst"><code>protected void</code></td>
  208. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/ComparableObjectItem.html#setObject-java.lang.Object-">setObject</a></span>(java.lang.Object&nbsp;y)</code>
  209. <div class="block">Sets the y-value for this data item.</div>
  210. </td>
  211. </tr>
  212. </table>
  213. <ul class="blockList">
  214. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  215. <!-- -->
  216. </a>
  217. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  218. <code>finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
  219. </ul>
  220. </li>
  221. </ul>
  222. </li>
  223. </ul>
  224. </div>
  225. <div class="details">
  226. <ul class="blockList">
  227. <li class="blockList">
  228. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  229. <ul class="blockList">
  230. <li class="blockList"><a name="constructor.detail">
  231. <!-- -->
  232. </a>
  233. <h3>Constructor Detail</h3>
  234. <a name="ComparableObjectItem-java.lang.Comparable-java.lang.Object-">
  235. <!-- -->
  236. </a>
  237. <ul class="blockListLast">
  238. <li class="blockList">
  239. <h4>ComparableObjectItem</h4>
  240. <pre>public&nbsp;<a href="../../../src-html/org/jfree/data/ComparableObjectItem.html#line.73">ComparableObjectItem</a>(java.lang.Comparable&nbsp;x,
  241. java.lang.Object&nbsp;y)</pre>
  242. <div class="block">Constructs a new data item.</div>
  243. <dl>
  244. <dt><span class="paramLabel">Parameters:</span></dt>
  245. <dd><code>x</code> - the x-value (<code>null</code> NOT permitted).</dd>
  246. <dd><code>y</code> - the y-value (<code>null</code> permitted).</dd>
  247. </dl>
  248. </li>
  249. </ul>
  250. </li>
  251. </ul>
  252. <!-- ============ METHOD DETAIL ========== -->
  253. <ul class="blockList">
  254. <li class="blockList"><a name="method.detail">
  255. <!-- -->
  256. </a>
  257. <h3>Method Detail</h3>
  258. <a name="getComparable--">
  259. <!-- -->
  260. </a>
  261. <ul class="blockList">
  262. <li class="blockList">
  263. <h4>getComparable</h4>
  264. <pre>protected&nbsp;java.lang.Comparable&nbsp;<a href="../../../src-html/org/jfree/data/ComparableObjectItem.html#line.84">getComparable</a>()</pre>
  265. <div class="block">Returns the x-value.</div>
  266. <dl>
  267. <dt><span class="returnLabel">Returns:</span></dt>
  268. <dd>The x-value (never <code>null</code>).</dd>
  269. </dl>
  270. </li>
  271. </ul>
  272. <a name="getObject--">
  273. <!-- -->
  274. </a>
  275. <ul class="blockList">
  276. <li class="blockList">
  277. <h4>getObject</h4>
  278. <pre>protected&nbsp;java.lang.Object&nbsp;<a href="../../../src-html/org/jfree/data/ComparableObjectItem.html#line.93">getObject</a>()</pre>
  279. <div class="block">Returns the y-value.</div>
  280. <dl>
  281. <dt><span class="returnLabel">Returns:</span></dt>
  282. <dd>The y-value (possibly <code>null</code>).</dd>
  283. </dl>
  284. </li>
  285. </ul>
  286. <a name="setObject-java.lang.Object-">
  287. <!-- -->
  288. </a>
  289. <ul class="blockList">
  290. <li class="blockList">
  291. <h4>setObject</h4>
  292. <pre>protected&nbsp;void&nbsp;<a href="../../../src-html/org/jfree/data/ComparableObjectItem.html#line.103">setObject</a>(java.lang.Object&nbsp;y)</pre>
  293. <div class="block">Sets the y-value for this data item. Note that there is no
  294. corresponding method to change the x-value.</div>
  295. <dl>
  296. <dt><span class="paramLabel">Parameters:</span></dt>
  297. <dd><code>y</code> - the new y-value (<code>null</code> permitted).</dd>
  298. </dl>
  299. </li>
  300. </ul>
  301. <a name="compareTo-java.lang.Object-">
  302. <!-- -->
  303. </a>
  304. <ul class="blockList">
  305. <li class="blockList">
  306. <h4>compareTo</h4>
  307. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/ComparableObjectItem.html#line.120">compareTo</a>(java.lang.Object&nbsp;o1)</pre>
  308. <div class="block">Returns an integer indicating the order of this object relative to
  309. another object.
  310. <P>
  311. For the order we consider only the x-value:
  312. negative == "less-than", zero == "equal", positive == "greater-than".</div>
  313. <dl>
  314. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  315. <dd><code>compareTo</code>&nbsp;in interface&nbsp;<code>java.lang.Comparable</code></dd>
  316. <dt><span class="paramLabel">Parameters:</span></dt>
  317. <dd><code>o1</code> - the object being compared to.</dd>
  318. <dt><span class="returnLabel">Returns:</span></dt>
  319. <dd>An integer indicating the order of this data pair object
  320. relative to another object.</dd>
  321. </dl>
  322. </li>
  323. </ul>
  324. <a name="clone--">
  325. <!-- -->
  326. </a>
  327. <ul class="blockList">
  328. <li class="blockList">
  329. <h4>clone</h4>
  330. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../src-html/org/jfree/data/ComparableObjectItem.html#line.151">clone</a>()
  331. throws java.lang.CloneNotSupportedException</pre>
  332. <div class="block">Returns a clone of this object.</div>
  333. <dl>
  334. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  335. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  336. <dt><span class="returnLabel">Returns:</span></dt>
  337. <dd>A clone.</dd>
  338. <dt><span class="throwsLabel">Throws:</span></dt>
  339. <dd><code>java.lang.CloneNotSupportedException</code> - not thrown by this class, but
  340. subclasses may differ.</dd>
  341. </dl>
  342. </li>
  343. </ul>
  344. <a name="equals-java.lang.Object-">
  345. <!-- -->
  346. </a>
  347. <ul class="blockList">
  348. <li class="blockList">
  349. <h4>equals</h4>
  350. <pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/org/jfree/data/ComparableObjectItem.html#line.164">equals</a>(java.lang.Object&nbsp;obj)</pre>
  351. <div class="block">Tests if this object is equal to another.</div>
  352. <dl>
  353. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  354. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  355. <dt><span class="paramLabel">Parameters:</span></dt>
  356. <dd><code>obj</code> - the object to test against for equality (<code>null</code>
  357. permitted).</dd>
  358. <dt><span class="returnLabel">Returns:</span></dt>
  359. <dd>A boolean.</dd>
  360. </dl>
  361. </li>
  362. </ul>
  363. <a name="hashCode--">
  364. <!-- -->
  365. </a>
  366. <ul class="blockListLast">
  367. <li class="blockList">
  368. <h4>hashCode</h4>
  369. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/ComparableObjectItem.html#line.187">hashCode</a>()</pre>
  370. <div class="block">Returns a hash code.</div>
  371. <dl>
  372. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  373. <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  374. <dt><span class="returnLabel">Returns:</span></dt>
  375. <dd>A hash code.</dd>
  376. </dl>
  377. </li>
  378. </ul>
  379. </li>
  380. </ul>
  381. </li>
  382. </ul>
  383. </div>
  384. </div>
  385. <!-- ========= END OF CLASS DATA ========= -->
  386. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  387. <div class="bottomNav"><a name="navbar.bottom">
  388. <!-- -->
  389. </a>
  390. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  391. <a name="navbar.bottom.firstrow">
  392. <!-- -->
  393. </a>
  394. <ul class="navList" title="Navigation">
  395. <li><a href="../../../overview-summary.html">Overview</a></li>
  396. <li><a href="package-summary.html">Package</a></li>
  397. <li class="navBarCell1Rev">Class</li>
  398. <li><a href="class-use/ComparableObjectItem.html">Use</a></li>
  399. <li><a href="package-tree.html">Tree</a></li>
  400. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  401. <li><a href="../../../index-files/index-1.html">Index</a></li>
  402. <li><a href="../../../help-doc.html">Help</a></li>
  403. </ul>
  404. </div>
  405. <div class="subNav">
  406. <ul class="navList">
  407. <li>Prev&nbsp;Class</li>
  408. <li><a href="../../../org/jfree/data/ComparableObjectSeries.html" title="class in org.jfree.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  409. </ul>
  410. <ul class="navList">
  411. <li><a href="../../../index.html?org/jfree/data/ComparableObjectItem.html" target="_top">Frames</a></li>
  412. <li><a href="ComparableObjectItem.html" target="_top">No&nbsp;Frames</a></li>
  413. </ul>
  414. <ul class="navList" id="allclasses_navbar_bottom">
  415. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  416. </ul>
  417. <div>
  418. <script type="text/javascript"><!--
  419. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  420. if(window==top) {
  421. allClassesLink.style.display = "block";
  422. }
  423. else {
  424. allClassesLink.style.display = "none";
  425. }
  426. //-->
  427. </script>
  428. </div>
  429. <div>
  430. <ul class="subNavList">
  431. <li>Summary:&nbsp;</li>
  432. <li>Nested&nbsp;|&nbsp;</li>
  433. <li>Field&nbsp;|&nbsp;</li>
  434. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  435. <li><a href="#method.summary">Method</a></li>
  436. </ul>
  437. <ul class="subNavList">
  438. <li>Detail:&nbsp;</li>
  439. <li>Field&nbsp;|&nbsp;</li>
  440. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  441. <li><a href="#method.detail">Method</a></li>
  442. </ul>
  443. </div>
  444. <a name="skip.navbar.bottom">
  445. <!-- -->
  446. </a></div>
  447. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  448. </body>
  449. </html>