OHLCDataItem.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464
  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:43 CEST 2014 -->
  6. <title>OHLCDataItem (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="OHLCDataItem (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};
  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/OHLCDataItem.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/xy/NormalizedMatrixSeries.html" title="class in org.jfree.data.xy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/data/xy/OHLCDataset.html" title="interface in org.jfree.data.xy"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/data/xy/OHLCDataItem.html" target="_top">Frames</a></li>
  57. <li><a href="OHLCDataItem.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.xy</div>
  96. <h2 title="Class OHLCDataItem" class="title">Class OHLCDataItem</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.xy.OHLCDataItem</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.Comparable</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../src-html/org/jfree/data/xy/OHLCDataItem.html#line.55">OHLCDataItem</a>
  117. extends java.lang.Object
  118. implements java.lang.Comparable, java.io.Serializable</pre>
  119. <div class="block">Represents a single (open-high-low-close) data item in
  120. an <a href="../../../../org/jfree/data/xy/DefaultOHLCDataset.html" title="class in org.jfree.data.xy"><code>DefaultOHLCDataset</code></a>. This data item is commonly used
  121. to summarise the trading activity of a financial commodity for
  122. a fixed period (most often one day).</div>
  123. <dl>
  124. <dt><span class="seeLabel">See Also:</span></dt>
  125. <dd><a href="../../../../serialized-form.html#org.jfree.data.xy.OHLCDataItem">Serialized Form</a></dd>
  126. </dl>
  127. </li>
  128. </ul>
  129. </div>
  130. <div class="summary">
  131. <ul class="blockList">
  132. <li class="blockList">
  133. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  134. <ul class="blockList">
  135. <li class="blockList"><a name="constructor.summary">
  136. <!-- -->
  137. </a>
  138. <h3>Constructor Summary</h3>
  139. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  140. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  141. <tr>
  142. <th class="colOne" scope="col">Constructor and Description</th>
  143. </tr>
  144. <tr class="altColor">
  145. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/OHLCDataItem.html#OHLCDataItem-java.util.Date-double-double-double-double-double-">OHLCDataItem</a></span>(java.util.Date&nbsp;date,
  146. double&nbsp;open,
  147. double&nbsp;high,
  148. double&nbsp;low,
  149. double&nbsp;close,
  150. double&nbsp;volume)</code>
  151. <div class="block">Creates a new 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>int</code></td>
  171. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/OHLCDataItem.html#compareTo-java.lang.Object-">compareTo</a></span>(java.lang.Object&nbsp;object)</code>
  172. <div class="block">Compares this object with the specified object for order.</div>
  173. </td>
  174. </tr>
  175. <tr id="i1" class="rowColor">
  176. <td class="colFirst"><code>boolean</code></td>
  177. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/OHLCDataItem.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  178. <div class="block">Checks this instance for equality with an arbitrary object.</div>
  179. </td>
  180. </tr>
  181. <tr id="i2" class="altColor">
  182. <td class="colFirst"><code>java.lang.Number</code></td>
  183. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/OHLCDataItem.html#getClose--">getClose</a></span>()</code>
  184. <div class="block">Returns the close value.</div>
  185. </td>
  186. </tr>
  187. <tr id="i3" class="rowColor">
  188. <td class="colFirst"><code>java.util.Date</code></td>
  189. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/OHLCDataItem.html#getDate--">getDate</a></span>()</code>
  190. <div class="block">Returns the date that the data item relates to.</div>
  191. </td>
  192. </tr>
  193. <tr id="i4" class="altColor">
  194. <td class="colFirst"><code>java.lang.Number</code></td>
  195. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/OHLCDataItem.html#getHigh--">getHigh</a></span>()</code>
  196. <div class="block">Returns the high value.</div>
  197. </td>
  198. </tr>
  199. <tr id="i5" class="rowColor">
  200. <td class="colFirst"><code>java.lang.Number</code></td>
  201. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/OHLCDataItem.html#getLow--">getLow</a></span>()</code>
  202. <div class="block">Returns the low value.</div>
  203. </td>
  204. </tr>
  205. <tr id="i6" class="altColor">
  206. <td class="colFirst"><code>java.lang.Number</code></td>
  207. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/OHLCDataItem.html#getOpen--">getOpen</a></span>()</code>
  208. <div class="block">Returns the open value.</div>
  209. </td>
  210. </tr>
  211. <tr id="i7" class="rowColor">
  212. <td class="colFirst"><code>java.lang.Number</code></td>
  213. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/xy/OHLCDataItem.html#getVolume--">getVolume</a></span>()</code>
  214. <div class="block">Returns the volume.</div>
  215. </td>
  216. </tr>
  217. </table>
  218. <ul class="blockList">
  219. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  220. <!-- -->
  221. </a>
  222. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  223. <code>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  224. </ul>
  225. </li>
  226. </ul>
  227. </li>
  228. </ul>
  229. </div>
  230. <div class="details">
  231. <ul class="blockList">
  232. <li class="blockList">
  233. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  234. <ul class="blockList">
  235. <li class="blockList"><a name="constructor.detail">
  236. <!-- -->
  237. </a>
  238. <h3>Constructor Detail</h3>
  239. <a name="OHLCDataItem-java.util.Date-double-double-double-double-double-">
  240. <!-- -->
  241. </a>
  242. <ul class="blockListLast">
  243. <li class="blockList">
  244. <h4>OHLCDataItem</h4>
  245. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/xy/OHLCDataItem.html#line.88">OHLCDataItem</a>(java.util.Date&nbsp;date,
  246. double&nbsp;open,
  247. double&nbsp;high,
  248. double&nbsp;low,
  249. double&nbsp;close,
  250. double&nbsp;volume)</pre>
  251. <div class="block">Creates a new item.</div>
  252. <dl>
  253. <dt><span class="paramLabel">Parameters:</span></dt>
  254. <dd><code>date</code> - the date (<code>null</code> not permitted).</dd>
  255. <dd><code>open</code> - the open value.</dd>
  256. <dd><code>high</code> - the high value.</dd>
  257. <dd><code>low</code> - the low value.</dd>
  258. <dd><code>close</code> - the close value.</dd>
  259. <dd><code>volume</code> - the volume.</dd>
  260. </dl>
  261. </li>
  262. </ul>
  263. </li>
  264. </ul>
  265. <!-- ============ METHOD DETAIL ========== -->
  266. <ul class="blockList">
  267. <li class="blockList"><a name="method.detail">
  268. <!-- -->
  269. </a>
  270. <h3>Method Detail</h3>
  271. <a name="getDate--">
  272. <!-- -->
  273. </a>
  274. <ul class="blockList">
  275. <li class="blockList">
  276. <h4>getDate</h4>
  277. <pre>public&nbsp;java.util.Date&nbsp;<a href="../../../../src-html/org/jfree/data/xy/OHLCDataItem.html#line.104">getDate</a>()</pre>
  278. <div class="block">Returns the date that the data item relates to.</div>
  279. <dl>
  280. <dt><span class="returnLabel">Returns:</span></dt>
  281. <dd>The date (never <code>null</code>).</dd>
  282. </dl>
  283. </li>
  284. </ul>
  285. <a name="getOpen--">
  286. <!-- -->
  287. </a>
  288. <ul class="blockList">
  289. <li class="blockList">
  290. <h4>getOpen</h4>
  291. <pre>public&nbsp;java.lang.Number&nbsp;<a href="../../../../src-html/org/jfree/data/xy/OHLCDataItem.html#line.113">getOpen</a>()</pre>
  292. <div class="block">Returns the open value.</div>
  293. <dl>
  294. <dt><span class="returnLabel">Returns:</span></dt>
  295. <dd>The open value (never <code>null</code>).</dd>
  296. </dl>
  297. </li>
  298. </ul>
  299. <a name="getHigh--">
  300. <!-- -->
  301. </a>
  302. <ul class="blockList">
  303. <li class="blockList">
  304. <h4>getHigh</h4>
  305. <pre>public&nbsp;java.lang.Number&nbsp;<a href="../../../../src-html/org/jfree/data/xy/OHLCDataItem.html#line.122">getHigh</a>()</pre>
  306. <div class="block">Returns the high value.</div>
  307. <dl>
  308. <dt><span class="returnLabel">Returns:</span></dt>
  309. <dd>The high value (never <code>null</code>).</dd>
  310. </dl>
  311. </li>
  312. </ul>
  313. <a name="getLow--">
  314. <!-- -->
  315. </a>
  316. <ul class="blockList">
  317. <li class="blockList">
  318. <h4>getLow</h4>
  319. <pre>public&nbsp;java.lang.Number&nbsp;<a href="../../../../src-html/org/jfree/data/xy/OHLCDataItem.html#line.131">getLow</a>()</pre>
  320. <div class="block">Returns the low value.</div>
  321. <dl>
  322. <dt><span class="returnLabel">Returns:</span></dt>
  323. <dd>The low value (never <code>null</code>).</dd>
  324. </dl>
  325. </li>
  326. </ul>
  327. <a name="getClose--">
  328. <!-- -->
  329. </a>
  330. <ul class="blockList">
  331. <li class="blockList">
  332. <h4>getClose</h4>
  333. <pre>public&nbsp;java.lang.Number&nbsp;<a href="../../../../src-html/org/jfree/data/xy/OHLCDataItem.html#line.140">getClose</a>()</pre>
  334. <div class="block">Returns the close value.</div>
  335. <dl>
  336. <dt><span class="returnLabel">Returns:</span></dt>
  337. <dd>The close value (never <code>null</code>).</dd>
  338. </dl>
  339. </li>
  340. </ul>
  341. <a name="getVolume--">
  342. <!-- -->
  343. </a>
  344. <ul class="blockList">
  345. <li class="blockList">
  346. <h4>getVolume</h4>
  347. <pre>public&nbsp;java.lang.Number&nbsp;<a href="../../../../src-html/org/jfree/data/xy/OHLCDataItem.html#line.149">getVolume</a>()</pre>
  348. <div class="block">Returns the volume.</div>
  349. <dl>
  350. <dt><span class="returnLabel">Returns:</span></dt>
  351. <dd>The volume (never <code>null</code>).</dd>
  352. </dl>
  353. </li>
  354. </ul>
  355. <a name="equals-java.lang.Object-">
  356. <!-- -->
  357. </a>
  358. <ul class="blockList">
  359. <li class="blockList">
  360. <h4>equals</h4>
  361. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/data/xy/OHLCDataItem.html#line.161">equals</a>(java.lang.Object&nbsp;obj)</pre>
  362. <div class="block">Checks this instance for equality with an arbitrary object.</div>
  363. <dl>
  364. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  365. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  366. <dt><span class="paramLabel">Parameters:</span></dt>
  367. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  368. <dt><span class="returnLabel">Returns:</span></dt>
  369. <dd>A boolean.</dd>
  370. </dl>
  371. </li>
  372. </ul>
  373. <a name="compareTo-java.lang.Object-">
  374. <!-- -->
  375. </a>
  376. <ul class="blockListLast">
  377. <li class="blockList">
  378. <h4>compareTo</h4>
  379. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/data/xy/OHLCDataItem.html#line.198">compareTo</a>(java.lang.Object&nbsp;object)</pre>
  380. <div class="block">Compares this object with the specified object for order. Returns a
  381. negative integer, zero, or a positive integer as this object is less
  382. than, equal to, or greater than the specified object.</div>
  383. <dl>
  384. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  385. <dd><code>compareTo</code>&nbsp;in interface&nbsp;<code>java.lang.Comparable</code></dd>
  386. <dt><span class="paramLabel">Parameters:</span></dt>
  387. <dd><code>object</code> - the object to compare to.</dd>
  388. <dt><span class="returnLabel">Returns:</span></dt>
  389. <dd>A negative integer, zero, or a positive integer as this object
  390. is less than, equal to, or greater than the specified object.</dd>
  391. </dl>
  392. </li>
  393. </ul>
  394. </li>
  395. </ul>
  396. </li>
  397. </ul>
  398. </div>
  399. </div>
  400. <!-- ========= END OF CLASS DATA ========= -->
  401. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  402. <div class="bottomNav"><a name="navbar.bottom">
  403. <!-- -->
  404. </a>
  405. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  406. <a name="navbar.bottom.firstrow">
  407. <!-- -->
  408. </a>
  409. <ul class="navList" title="Navigation">
  410. <li><a href="../../../../overview-summary.html">Overview</a></li>
  411. <li><a href="package-summary.html">Package</a></li>
  412. <li class="navBarCell1Rev">Class</li>
  413. <li><a href="class-use/OHLCDataItem.html">Use</a></li>
  414. <li><a href="package-tree.html">Tree</a></li>
  415. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  416. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  417. <li><a href="../../../../help-doc.html">Help</a></li>
  418. </ul>
  419. </div>
  420. <div class="subNav">
  421. <ul class="navList">
  422. <li><a href="../../../../org/jfree/data/xy/NormalizedMatrixSeries.html" title="class in org.jfree.data.xy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  423. <li><a href="../../../../org/jfree/data/xy/OHLCDataset.html" title="interface in org.jfree.data.xy"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  424. </ul>
  425. <ul class="navList">
  426. <li><a href="../../../../index.html?org/jfree/data/xy/OHLCDataItem.html" target="_top">Frames</a></li>
  427. <li><a href="OHLCDataItem.html" target="_top">No&nbsp;Frames</a></li>
  428. </ul>
  429. <ul class="navList" id="allclasses_navbar_bottom">
  430. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  431. </ul>
  432. <div>
  433. <script type="text/javascript"><!--
  434. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  435. if(window==top) {
  436. allClassesLink.style.display = "block";
  437. }
  438. else {
  439. allClassesLink.style.display = "none";
  440. }
  441. //-->
  442. </script>
  443. </div>
  444. <div>
  445. <ul class="subNavList">
  446. <li>Summary:&nbsp;</li>
  447. <li>Nested&nbsp;|&nbsp;</li>
  448. <li>Field&nbsp;|&nbsp;</li>
  449. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  450. <li><a href="#method.summary">Method</a></li>
  451. </ul>
  452. <ul class="subNavList">
  453. <li>Detail:&nbsp;</li>
  454. <li>Field&nbsp;|&nbsp;</li>
  455. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  456. <li><a href="#method.detail">Method</a></li>
  457. </ul>
  458. </div>
  459. <a name="skip.navbar.bottom">
  460. <!-- -->
  461. </a></div>
  462. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  463. </body>
  464. </html>