OHLCItem.html 16 KB

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