OHLC.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413
  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>OHLC (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="OHLC (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};
  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/OHLC.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/time/ohlc/OHLCItem.html" title="class in org.jfree.data.time.ohlc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../../index.html?org/jfree/data/time/ohlc/OHLC.html" target="_top">Frames</a></li>
  57. <li><a href="OHLC.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.time.ohlc</div>
  96. <h2 title="Class OHLC" class="title">Class OHLC</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.time.ohlc.OHLC</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</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../../src-html/org/jfree/data/time/ohlc/OHLC.html#line.53">OHLC</a>
  117. extends java.lang.Object
  118. implements java.io.Serializable</pre>
  119. <div class="block">A data record containing open-high-low-close data (immutable). This class
  120. is used internally by the <a href="../../../../../org/jfree/data/time/ohlc/OHLCItem.html" title="class in org.jfree.data.time.ohlc"><code>OHLCItem</code></a> class.</div>
  121. <dl>
  122. <dt><span class="simpleTagLabel">Since:</span></dt>
  123. <dd>1.0.4</dd>
  124. <dt><span class="seeLabel">See Also:</span></dt>
  125. <dd><a href="../../../../../serialized-form.html#org.jfree.data.time.ohlc.OHLC">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/time/ohlc/OHLC.html#OHLC-double-double-double-double-">OHLC</a></span>(double&nbsp;open,
  146. double&nbsp;high,
  147. double&nbsp;low,
  148. double&nbsp;close)</code>
  149. <div class="block">Creates a new instance of <code>OHLC</code>.</div>
  150. </td>
  151. </tr>
  152. </table>
  153. </li>
  154. </ul>
  155. <!-- ========== METHOD SUMMARY =========== -->
  156. <ul class="blockList">
  157. <li class="blockList"><a name="method.summary">
  158. <!-- -->
  159. </a>
  160. <h3>Method Summary</h3>
  161. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  162. <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>
  163. <tr>
  164. <th class="colFirst" scope="col">Modifier and Type</th>
  165. <th class="colLast" scope="col">Method and Description</th>
  166. </tr>
  167. <tr id="i0" class="altColor">
  168. <td class="colFirst"><code>boolean</code></td>
  169. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/jfree/data/time/ohlc/OHLC.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  170. <div class="block">Tests this instance for equality with an arbitrary object.</div>
  171. </td>
  172. </tr>
  173. <tr id="i1" class="rowColor">
  174. <td class="colFirst"><code>double</code></td>
  175. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/jfree/data/time/ohlc/OHLC.html#getClose--">getClose</a></span>()</code>
  176. <div class="block">Returns the close value.</div>
  177. </td>
  178. </tr>
  179. <tr id="i2" class="altColor">
  180. <td class="colFirst"><code>double</code></td>
  181. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/jfree/data/time/ohlc/OHLC.html#getHigh--">getHigh</a></span>()</code>
  182. <div class="block">Returns the high value.</div>
  183. </td>
  184. </tr>
  185. <tr id="i3" class="rowColor">
  186. <td class="colFirst"><code>double</code></td>
  187. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/jfree/data/time/ohlc/OHLC.html#getLow--">getLow</a></span>()</code>
  188. <div class="block">Returns the low value.</div>
  189. </td>
  190. </tr>
  191. <tr id="i4" class="altColor">
  192. <td class="colFirst"><code>double</code></td>
  193. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/jfree/data/time/ohlc/OHLC.html#getOpen--">getOpen</a></span>()</code>
  194. <div class="block">Returns the open value.</div>
  195. </td>
  196. </tr>
  197. <tr id="i5" class="rowColor">
  198. <td class="colFirst"><code>int</code></td>
  199. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/jfree/data/time/ohlc/OHLC.html#hashCode--">hashCode</a></span>()</code>
  200. <div class="block">Returns a hash code for this instance.</div>
  201. </td>
  202. </tr>
  203. </table>
  204. <ul class="blockList">
  205. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  206. <!-- -->
  207. </a>
  208. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  209. <code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
  210. </ul>
  211. </li>
  212. </ul>
  213. </li>
  214. </ul>
  215. </div>
  216. <div class="details">
  217. <ul class="blockList">
  218. <li class="blockList">
  219. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  220. <ul class="blockList">
  221. <li class="blockList"><a name="constructor.detail">
  222. <!-- -->
  223. </a>
  224. <h3>Constructor Detail</h3>
  225. <a name="OHLC-double-double-double-double-">
  226. <!-- -->
  227. </a>
  228. <ul class="blockListLast">
  229. <li class="blockList">
  230. <h4>OHLC</h4>
  231. <pre>public&nbsp;<a href="../../../../../src-html/org/jfree/data/time/ohlc/OHLC.html#line.75">OHLC</a>(double&nbsp;open,
  232. double&nbsp;high,
  233. double&nbsp;low,
  234. double&nbsp;close)</pre>
  235. <div class="block">Creates a new instance of <code>OHLC</code>.</div>
  236. <dl>
  237. <dt><span class="paramLabel">Parameters:</span></dt>
  238. <dd><code>open</code> - the open value.</dd>
  239. <dd><code>close</code> - the close value.</dd>
  240. <dd><code>high</code> - the high value.</dd>
  241. <dd><code>low</code> - the low value.</dd>
  242. </dl>
  243. </li>
  244. </ul>
  245. </li>
  246. </ul>
  247. <!-- ============ METHOD DETAIL ========== -->
  248. <ul class="blockList">
  249. <li class="blockList"><a name="method.detail">
  250. <!-- -->
  251. </a>
  252. <h3>Method Detail</h3>
  253. <a name="getOpen--">
  254. <!-- -->
  255. </a>
  256. <ul class="blockList">
  257. <li class="blockList">
  258. <h4>getOpen</h4>
  259. <pre>public&nbsp;double&nbsp;<a href="../../../../../src-html/org/jfree/data/time/ohlc/OHLC.html#line.87">getOpen</a>()</pre>
  260. <div class="block">Returns the open value.</div>
  261. <dl>
  262. <dt><span class="returnLabel">Returns:</span></dt>
  263. <dd>The open value.</dd>
  264. </dl>
  265. </li>
  266. </ul>
  267. <a name="getClose--">
  268. <!-- -->
  269. </a>
  270. <ul class="blockList">
  271. <li class="blockList">
  272. <h4>getClose</h4>
  273. <pre>public&nbsp;double&nbsp;<a href="../../../../../src-html/org/jfree/data/time/ohlc/OHLC.html#line.96">getClose</a>()</pre>
  274. <div class="block">Returns the close value.</div>
  275. <dl>
  276. <dt><span class="returnLabel">Returns:</span></dt>
  277. <dd>The close value.</dd>
  278. </dl>
  279. </li>
  280. </ul>
  281. <a name="getHigh--">
  282. <!-- -->
  283. </a>
  284. <ul class="blockList">
  285. <li class="blockList">
  286. <h4>getHigh</h4>
  287. <pre>public&nbsp;double&nbsp;<a href="../../../../../src-html/org/jfree/data/time/ohlc/OHLC.html#line.105">getHigh</a>()</pre>
  288. <div class="block">Returns the high value.</div>
  289. <dl>
  290. <dt><span class="returnLabel">Returns:</span></dt>
  291. <dd>The high value.</dd>
  292. </dl>
  293. </li>
  294. </ul>
  295. <a name="getLow--">
  296. <!-- -->
  297. </a>
  298. <ul class="blockList">
  299. <li class="blockList">
  300. <h4>getLow</h4>
  301. <pre>public&nbsp;double&nbsp;<a href="../../../../../src-html/org/jfree/data/time/ohlc/OHLC.html#line.114">getLow</a>()</pre>
  302. <div class="block">Returns the low value.</div>
  303. <dl>
  304. <dt><span class="returnLabel">Returns:</span></dt>
  305. <dd>The low value.</dd>
  306. </dl>
  307. </li>
  308. </ul>
  309. <a name="equals-java.lang.Object-">
  310. <!-- -->
  311. </a>
  312. <ul class="blockList">
  313. <li class="blockList">
  314. <h4>equals</h4>
  315. <pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/jfree/data/time/ohlc/OHLC.html#line.126">equals</a>(java.lang.Object&nbsp;obj)</pre>
  316. <div class="block">Tests this instance for equality with an arbitrary object.</div>
  317. <dl>
  318. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  319. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  320. <dt><span class="paramLabel">Parameters:</span></dt>
  321. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  322. <dt><span class="returnLabel">Returns:</span></dt>
  323. <dd>A boolean.</dd>
  324. </dl>
  325. </li>
  326. </ul>
  327. <a name="hashCode--">
  328. <!-- -->
  329. </a>
  330. <ul class="blockListLast">
  331. <li class="blockList">
  332. <h4>hashCode</h4>
  333. <pre>public&nbsp;int&nbsp;<a href="../../../../../src-html/org/jfree/data/time/ohlc/OHLC.html#line.155">hashCode</a>()</pre>
  334. <div class="block">Returns a hash code for this instance.</div>
  335. <dl>
  336. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  337. <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  338. <dt><span class="returnLabel">Returns:</span></dt>
  339. <dd>A hash code.</dd>
  340. </dl>
  341. </li>
  342. </ul>
  343. </li>
  344. </ul>
  345. </li>
  346. </ul>
  347. </div>
  348. </div>
  349. <!-- ========= END OF CLASS DATA ========= -->
  350. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  351. <div class="bottomNav"><a name="navbar.bottom">
  352. <!-- -->
  353. </a>
  354. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  355. <a name="navbar.bottom.firstrow">
  356. <!-- -->
  357. </a>
  358. <ul class="navList" title="Navigation">
  359. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  360. <li><a href="package-summary.html">Package</a></li>
  361. <li class="navBarCell1Rev">Class</li>
  362. <li><a href="class-use/OHLC.html">Use</a></li>
  363. <li><a href="package-tree.html">Tree</a></li>
  364. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  365. <li><a href="../../../../../index-files/index-1.html">Index</a></li>
  366. <li><a href="../../../../../help-doc.html">Help</a></li>
  367. </ul>
  368. </div>
  369. <div class="subNav">
  370. <ul class="navList">
  371. <li>Prev&nbsp;Class</li>
  372. <li><a href="../../../../../org/jfree/data/time/ohlc/OHLCItem.html" title="class in org.jfree.data.time.ohlc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  373. </ul>
  374. <ul class="navList">
  375. <li><a href="../../../../../index.html?org/jfree/data/time/ohlc/OHLC.html" target="_top">Frames</a></li>
  376. <li><a href="OHLC.html" target="_top">No&nbsp;Frames</a></li>
  377. </ul>
  378. <ul class="navList" id="allclasses_navbar_bottom">
  379. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  380. </ul>
  381. <div>
  382. <script type="text/javascript"><!--
  383. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  384. if(window==top) {
  385. allClassesLink.style.display = "block";
  386. }
  387. else {
  388. allClassesLink.style.display = "none";
  389. }
  390. //-->
  391. </script>
  392. </div>
  393. <div>
  394. <ul class="subNavList">
  395. <li>Summary:&nbsp;</li>
  396. <li>Nested&nbsp;|&nbsp;</li>
  397. <li>Field&nbsp;|&nbsp;</li>
  398. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  399. <li><a href="#method.summary">Method</a></li>
  400. </ul>
  401. <ul class="subNavList">
  402. <li>Detail:&nbsp;</li>
  403. <li>Field&nbsp;|&nbsp;</li>
  404. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  405. <li><a href="#method.detail">Method</a></li>
  406. </ul>
  407. </div>
  408. <a name="skip.navbar.bottom">
  409. <!-- -->
  410. </a></div>
  411. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  412. </body>
  413. </html>