Series.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804
  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>Series (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="Series (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":6,"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"],4:["t3","Abstract 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/Series.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/general/PieDataset.html" title="interface in org.jfree.data.general"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/data/general/SeriesChangeEvent.html" title="class in org.jfree.data.general"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/data/general/Series.html" target="_top">Frames</a></li>
  57. <li><a href="Series.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.general</div>
  96. <h2 title="Class Series" class="title">Class Series</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.general.Series</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. <dl>
  115. <dt>Direct Known Subclasses:</dt>
  116. <dd><a href="../../../../org/jfree/data/ComparableObjectSeries.html" title="class in org.jfree.data">ComparableObjectSeries</a>, <a href="../../../../org/jfree/data/xy/MatrixSeries.html" title="class in org.jfree.data.xy">MatrixSeries</a>, <a href="../../../../org/jfree/data/gantt/TaskSeries.html" title="class in org.jfree.data.gantt">TaskSeries</a>, <a href="../../../../org/jfree/data/time/TimePeriodValues.html" title="class in org.jfree.data.time">TimePeriodValues</a>, <a href="../../../../org/jfree/data/time/TimeSeries.html" title="class in org.jfree.data.time">TimeSeries</a>, <a href="../../../../org/jfree/data/xy/XYSeries.html" title="class in org.jfree.data.xy">XYSeries</a></dd>
  117. </dl>
  118. <hr>
  119. <br>
  120. <pre>public abstract class <a href="../../../../src-html/org/jfree/data/general/Series.html#line.81">Series</a>
  121. extends java.lang.Object
  122. implements java.lang.Cloneable, java.io.Serializable</pre>
  123. <div class="block">Base class representing a data series. Subclasses are left to implement the
  124. actual data structures.
  125. <P>
  126. The series has two properties ("Key" and "Description") for which you can
  127. register a <code>PropertyChangeListener</code>.
  128. <P>
  129. You can also register a <a href="../../../../org/jfree/data/general/SeriesChangeListener.html" title="interface in org.jfree.data.general"><code>SeriesChangeListener</code></a> to receive notification
  130. of changes to the series data.</div>
  131. <dl>
  132. <dt><span class="seeLabel">See Also:</span></dt>
  133. <dd><a href="../../../../serialized-form.html#org.jfree.data.general.Series">Serialized Form</a></dd>
  134. </dl>
  135. </li>
  136. </ul>
  137. </div>
  138. <div class="summary">
  139. <ul class="blockList">
  140. <li class="blockList">
  141. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  142. <ul class="blockList">
  143. <li class="blockList"><a name="constructor.summary">
  144. <!-- -->
  145. </a>
  146. <h3>Constructor Summary</h3>
  147. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  148. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  149. <tr>
  150. <th class="colFirst" scope="col">Modifier</th>
  151. <th class="colLast" scope="col">Constructor and Description</th>
  152. </tr>
  153. <tr class="altColor">
  154. <td class="colFirst"><code>protected </code></td>
  155. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#Series-java.lang.Comparable-">Series</a></span>(java.lang.Comparable&nbsp;key)</code>
  156. <div class="block">Creates a new series with the specified key.</div>
  157. </td>
  158. </tr>
  159. <tr class="rowColor">
  160. <td class="colFirst"><code>protected </code></td>
  161. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#Series-java.lang.Comparable-java.lang.String-">Series</a></span>(java.lang.Comparable&nbsp;key,
  162. java.lang.String&nbsp;description)</code>
  163. <div class="block">Creates a new series with the specified key and description.</div>
  164. </td>
  165. </tr>
  166. </table>
  167. </li>
  168. </ul>
  169. <!-- ========== METHOD SUMMARY =========== -->
  170. <ul class="blockList">
  171. <li class="blockList"><a name="method.summary">
  172. <!-- -->
  173. </a>
  174. <h3>Method Summary</h3>
  175. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  176. <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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>
  177. <tr>
  178. <th class="colFirst" scope="col">Modifier and Type</th>
  179. <th class="colLast" scope="col">Method and Description</th>
  180. </tr>
  181. <tr id="i0" class="altColor">
  182. <td class="colFirst"><code>void</code></td>
  183. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#addChangeListener-org.jfree.data.general.SeriesChangeListener-">addChangeListener</a></span>(<a href="../../../../org/jfree/data/general/SeriesChangeListener.html" title="interface in org.jfree.data.general">SeriesChangeListener</a>&nbsp;listener)</code>
  184. <div class="block">Registers an object with this series, to receive notification whenever
  185. the series changes.</div>
  186. </td>
  187. </tr>
  188. <tr id="i1" class="rowColor">
  189. <td class="colFirst"><code>void</code></td>
  190. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#addPropertyChangeListener-java.beans.PropertyChangeListener-">addPropertyChangeListener</a></span>(java.beans.PropertyChangeListener&nbsp;listener)</code>
  191. <div class="block">Adds a property change listener to the series.</div>
  192. </td>
  193. </tr>
  194. <tr id="i2" class="altColor">
  195. <td class="colFirst"><code>void</code></td>
  196. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#addVetoableChangeListener-java.beans.VetoableChangeListener-">addVetoableChangeListener</a></span>(java.beans.VetoableChangeListener&nbsp;listener)</code>
  197. <div class="block">Adds a vetoable property change listener to the series.</div>
  198. </td>
  199. </tr>
  200. <tr id="i3" class="rowColor">
  201. <td class="colFirst"><code>java.lang.Object</code></td>
  202. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#clone--">clone</a></span>()</code>
  203. <div class="block">Returns a clone of the series.</div>
  204. </td>
  205. </tr>
  206. <tr id="i4" class="altColor">
  207. <td class="colFirst"><code>boolean</code></td>
  208. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  209. <div class="block">Tests the series for equality with another object.</div>
  210. </td>
  211. </tr>
  212. <tr id="i5" class="rowColor">
  213. <td class="colFirst"><code>protected void</code></td>
  214. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#firePropertyChange-java.lang.String-java.lang.Object-java.lang.Object-">firePropertyChange</a></span>(java.lang.String&nbsp;property,
  215. java.lang.Object&nbsp;oldValue,
  216. java.lang.Object&nbsp;newValue)</code>
  217. <div class="block">Fires a property change event.</div>
  218. </td>
  219. </tr>
  220. <tr id="i6" class="altColor">
  221. <td class="colFirst"><code>void</code></td>
  222. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#fireSeriesChanged--">fireSeriesChanged</a></span>()</code>
  223. <div class="block">General method for signalling to registered listeners that the series
  224. has been changed.</div>
  225. </td>
  226. </tr>
  227. <tr id="i7" class="rowColor">
  228. <td class="colFirst"><code>protected void</code></td>
  229. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#fireVetoableChange-java.lang.String-java.lang.Object-java.lang.Object-">fireVetoableChange</a></span>(java.lang.String&nbsp;property,
  230. java.lang.Object&nbsp;oldValue,
  231. java.lang.Object&nbsp;newValue)</code>
  232. <div class="block">Fires a vetoable property change event.</div>
  233. </td>
  234. </tr>
  235. <tr id="i8" class="altColor">
  236. <td class="colFirst"><code>java.lang.String</code></td>
  237. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#getDescription--">getDescription</a></span>()</code>
  238. <div class="block">Returns a description of the series.</div>
  239. </td>
  240. </tr>
  241. <tr id="i9" class="rowColor">
  242. <td class="colFirst"><code>abstract int</code></td>
  243. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#getItemCount--">getItemCount</a></span>()</code>
  244. <div class="block">Returns the number of data items in the series.</div>
  245. </td>
  246. </tr>
  247. <tr id="i10" class="altColor">
  248. <td class="colFirst"><code>java.lang.Comparable</code></td>
  249. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#getKey--">getKey</a></span>()</code>
  250. <div class="block">Returns the key for the series.</div>
  251. </td>
  252. </tr>
  253. <tr id="i11" class="rowColor">
  254. <td class="colFirst"><code>boolean</code></td>
  255. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#getNotify--">getNotify</a></span>()</code>
  256. <div class="block">Returns the flag that controls whether or not change events are sent to
  257. registered listeners.</div>
  258. </td>
  259. </tr>
  260. <tr id="i12" class="altColor">
  261. <td class="colFirst"><code>int</code></td>
  262. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#hashCode--">hashCode</a></span>()</code>
  263. <div class="block">Returns a hash code.</div>
  264. </td>
  265. </tr>
  266. <tr id="i13" class="rowColor">
  267. <td class="colFirst"><code>boolean</code></td>
  268. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#isEmpty--">isEmpty</a></span>()</code>
  269. <div class="block">Returns <code>true</code> if the series contains no data items, and
  270. <code>false</code> otherwise.</div>
  271. </td>
  272. </tr>
  273. <tr id="i14" class="altColor">
  274. <td class="colFirst"><code>protected void</code></td>
  275. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#notifyListeners-org.jfree.data.general.SeriesChangeEvent-">notifyListeners</a></span>(<a href="../../../../org/jfree/data/general/SeriesChangeEvent.html" title="class in org.jfree.data.general">SeriesChangeEvent</a>&nbsp;event)</code>
  276. <div class="block">Sends a change event to all registered listeners.</div>
  277. </td>
  278. </tr>
  279. <tr id="i15" class="rowColor">
  280. <td class="colFirst"><code>void</code></td>
  281. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#removeChangeListener-org.jfree.data.general.SeriesChangeListener-">removeChangeListener</a></span>(<a href="../../../../org/jfree/data/general/SeriesChangeListener.html" title="interface in org.jfree.data.general">SeriesChangeListener</a>&nbsp;listener)</code>
  282. <div class="block">Deregisters an object, so that it not longer receives notification
  283. whenever the series changes.</div>
  284. </td>
  285. </tr>
  286. <tr id="i16" class="altColor">
  287. <td class="colFirst"><code>void</code></td>
  288. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#removePropertyChangeListener-java.beans.PropertyChangeListener-">removePropertyChangeListener</a></span>(java.beans.PropertyChangeListener&nbsp;listener)</code>
  289. <div class="block">Removes a property change listener from the series.</div>
  290. </td>
  291. </tr>
  292. <tr id="i17" class="rowColor">
  293. <td class="colFirst"><code>void</code></td>
  294. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#removeVetoableChangeListener-java.beans.VetoableChangeListener-">removeVetoableChangeListener</a></span>(java.beans.VetoableChangeListener&nbsp;listener)</code>
  295. <div class="block">Removes a vetoable property change listener from the series.</div>
  296. </td>
  297. </tr>
  298. <tr id="i18" class="altColor">
  299. <td class="colFirst"><code>void</code></td>
  300. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#setDescription-java.lang.String-">setDescription</a></span>(java.lang.String&nbsp;description)</code>
  301. <div class="block">Sets the description of the series and sends a
  302. <code>PropertyChangeEvent</code> to all registered listeners.</div>
  303. </td>
  304. </tr>
  305. <tr id="i19" class="rowColor">
  306. <td class="colFirst"><code>void</code></td>
  307. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#setKey-java.lang.Comparable-">setKey</a></span>(java.lang.Comparable&nbsp;key)</code>
  308. <div class="block">Sets the key for the series and sends a <code>VetoableChangeEvent</code>
  309. (with the property name "Key") to all registered listeners.</div>
  310. </td>
  311. </tr>
  312. <tr id="i20" class="altColor">
  313. <td class="colFirst"><code>void</code></td>
  314. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/Series.html#setNotify-boolean-">setNotify</a></span>(boolean&nbsp;notify)</code>
  315. <div class="block">Sets the flag that controls whether or not change events are sent to
  316. registered listeners.</div>
  317. </td>
  318. </tr>
  319. </table>
  320. <ul class="blockList">
  321. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  322. <!-- -->
  323. </a>
  324. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  325. <code>finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
  326. </ul>
  327. </li>
  328. </ul>
  329. </li>
  330. </ul>
  331. </div>
  332. <div class="details">
  333. <ul class="blockList">
  334. <li class="blockList">
  335. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  336. <ul class="blockList">
  337. <li class="blockList"><a name="constructor.detail">
  338. <!-- -->
  339. </a>
  340. <h3>Constructor Detail</h3>
  341. <a name="Series-java.lang.Comparable-">
  342. <!-- -->
  343. </a>
  344. <ul class="blockList">
  345. <li class="blockList">
  346. <h4>Series</h4>
  347. <pre>protected&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.109">Series</a>(java.lang.Comparable&nbsp;key)</pre>
  348. <div class="block">Creates a new series with the specified key.</div>
  349. <dl>
  350. <dt><span class="paramLabel">Parameters:</span></dt>
  351. <dd><code>key</code> - the series key (<code>null</code> not permitted).</dd>
  352. </dl>
  353. </li>
  354. </ul>
  355. <a name="Series-java.lang.Comparable-java.lang.String-">
  356. <!-- -->
  357. </a>
  358. <ul class="blockListLast">
  359. <li class="blockList">
  360. <h4>Series</h4>
  361. <pre>protected&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.119">Series</a>(java.lang.Comparable&nbsp;key,
  362. java.lang.String&nbsp;description)</pre>
  363. <div class="block">Creates a new series with the specified key and description.</div>
  364. <dl>
  365. <dt><span class="paramLabel">Parameters:</span></dt>
  366. <dd><code>key</code> - the series key (<code>null</code> NOT permitted).</dd>
  367. <dd><code>description</code> - the series description (<code>null</code> permitted).</dd>
  368. </dl>
  369. </li>
  370. </ul>
  371. </li>
  372. </ul>
  373. <!-- ============ METHOD DETAIL ========== -->
  374. <ul class="blockList">
  375. <li class="blockList"><a name="method.detail">
  376. <!-- -->
  377. </a>
  378. <h3>Method Detail</h3>
  379. <a name="getKey--">
  380. <!-- -->
  381. </a>
  382. <ul class="blockList">
  383. <li class="blockList">
  384. <h4>getKey</h4>
  385. <pre>public&nbsp;java.lang.Comparable&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.136">getKey</a>()</pre>
  386. <div class="block">Returns the key for the series.</div>
  387. <dl>
  388. <dt><span class="returnLabel">Returns:</span></dt>
  389. <dd>The series key (never <code>null</code>).</dd>
  390. <dt><span class="seeLabel">See Also:</span></dt>
  391. <dd><a href="../../../../org/jfree/data/general/Series.html#setKey-java.lang.Comparable-"><code>setKey(Comparable)</code></a></dd>
  392. </dl>
  393. </li>
  394. </ul>
  395. <a name="setKey-java.lang.Comparable-">
  396. <!-- -->
  397. </a>
  398. <ul class="blockList">
  399. <li class="blockList">
  400. <h4>setKey</h4>
  401. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.151">setKey</a>(java.lang.Comparable&nbsp;key)</pre>
  402. <div class="block">Sets the key for the series and sends a <code>VetoableChangeEvent</code>
  403. (with the property name "Key") to all registered listeners. For
  404. backwards compatibility, this method also fires a regular
  405. <code>PropertyChangeEvent</code>. If the key change is vetoed this
  406. method will throw an IllegalArgumentException.</div>
  407. <dl>
  408. <dt><span class="paramLabel">Parameters:</span></dt>
  409. <dd><code>key</code> - the key (<code>null</code> not permitted).</dd>
  410. <dt><span class="seeLabel">See Also:</span></dt>
  411. <dd><a href="../../../../org/jfree/data/general/Series.html#getKey--"><code>getKey()</code></a></dd>
  412. </dl>
  413. </li>
  414. </ul>
  415. <a name="getDescription--">
  416. <!-- -->
  417. </a>
  418. <ul class="blockList">
  419. <li class="blockList">
  420. <h4>getDescription</h4>
  421. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.175">getDescription</a>()</pre>
  422. <div class="block">Returns a description of the series.</div>
  423. <dl>
  424. <dt><span class="returnLabel">Returns:</span></dt>
  425. <dd>The series description (possibly <code>null</code>).</dd>
  426. <dt><span class="seeLabel">See Also:</span></dt>
  427. <dd><a href="../../../../org/jfree/data/general/Series.html#setDescription-java.lang.String-"><code>setDescription(String)</code></a></dd>
  428. </dl>
  429. </li>
  430. </ul>
  431. <a name="setDescription-java.lang.String-">
  432. <!-- -->
  433. </a>
  434. <ul class="blockList">
  435. <li class="blockList">
  436. <h4>setDescription</h4>
  437. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.187">setDescription</a>(java.lang.String&nbsp;description)</pre>
  438. <div class="block">Sets the description of the series and sends a
  439. <code>PropertyChangeEvent</code> to all registered listeners.</div>
  440. <dl>
  441. <dt><span class="paramLabel">Parameters:</span></dt>
  442. <dd><code>description</code> - the description (<code>null</code> permitted).</dd>
  443. <dt><span class="seeLabel">See Also:</span></dt>
  444. <dd><a href="../../../../org/jfree/data/general/Series.html#getDescription--"><code>getDescription()</code></a></dd>
  445. </dl>
  446. </li>
  447. </ul>
  448. <a name="getNotify--">
  449. <!-- -->
  450. </a>
  451. <ul class="blockList">
  452. <li class="blockList">
  453. <h4>getNotify</h4>
  454. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.202">getNotify</a>()</pre>
  455. <div class="block">Returns the flag that controls whether or not change events are sent to
  456. registered listeners.</div>
  457. <dl>
  458. <dt><span class="returnLabel">Returns:</span></dt>
  459. <dd>A boolean.</dd>
  460. <dt><span class="seeLabel">See Also:</span></dt>
  461. <dd><a href="../../../../org/jfree/data/general/Series.html#setNotify-boolean-"><code>setNotify(boolean)</code></a></dd>
  462. </dl>
  463. </li>
  464. </ul>
  465. <a name="setNotify-boolean-">
  466. <!-- -->
  467. </a>
  468. <ul class="blockList">
  469. <li class="blockList">
  470. <h4>setNotify</h4>
  471. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.214">setNotify</a>(boolean&nbsp;notify)</pre>
  472. <div class="block">Sets the flag that controls whether or not change events are sent to
  473. registered listeners.</div>
  474. <dl>
  475. <dt><span class="paramLabel">Parameters:</span></dt>
  476. <dd><code>notify</code> - the new value of the flag.</dd>
  477. <dt><span class="seeLabel">See Also:</span></dt>
  478. <dd><a href="../../../../org/jfree/data/general/Series.html#getNotify--"><code>getNotify()</code></a></dd>
  479. </dl>
  480. </li>
  481. </ul>
  482. <a name="isEmpty--">
  483. <!-- -->
  484. </a>
  485. <ul class="blockList">
  486. <li class="blockList">
  487. <h4>isEmpty</h4>
  488. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.229">isEmpty</a>()</pre>
  489. <div class="block">Returns <code>true</code> if the series contains no data items, and
  490. <code>false</code> otherwise.</div>
  491. <dl>
  492. <dt><span class="returnLabel">Returns:</span></dt>
  493. <dd>A boolean.</dd>
  494. <dt><span class="simpleTagLabel">Since:</span></dt>
  495. <dd>1.0.7</dd>
  496. </dl>
  497. </li>
  498. </ul>
  499. <a name="getItemCount--">
  500. <!-- -->
  501. </a>
  502. <ul class="blockList">
  503. <li class="blockList">
  504. <h4>getItemCount</h4>
  505. <pre>public abstract&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.238">getItemCount</a>()</pre>
  506. <div class="block">Returns the number of data items in the series.</div>
  507. <dl>
  508. <dt><span class="returnLabel">Returns:</span></dt>
  509. <dd>The number of data items in the series.</dd>
  510. </dl>
  511. </li>
  512. </ul>
  513. <a name="clone--">
  514. <!-- -->
  515. </a>
  516. <ul class="blockList">
  517. <li class="blockList">
  518. <h4>clone</h4>
  519. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.258">clone</a>()
  520. throws java.lang.CloneNotSupportedException</pre>
  521. <div class="block">Returns a clone of the series.
  522. <P>
  523. Notes:
  524. <ul>
  525. <li>No need to clone the name or description, since String object is
  526. immutable.</li>
  527. <li>We set the listener list to empty, since the listeners did not
  528. register with the clone.</li>
  529. <li>Same applies to the PropertyChangeSupport instance.</li>
  530. </ul></div>
  531. <dl>
  532. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  533. <dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  534. <dt><span class="returnLabel">Returns:</span></dt>
  535. <dd>A clone of the series.</dd>
  536. <dt><span class="throwsLabel">Throws:</span></dt>
  537. <dd><code>java.lang.CloneNotSupportedException</code> - not thrown by this class, but
  538. subclasses may differ.</dd>
  539. </dl>
  540. </li>
  541. </ul>
  542. <a name="equals-java.lang.Object-">
  543. <!-- -->
  544. </a>
  545. <ul class="blockList">
  546. <li class="blockList">
  547. <h4>equals</h4>
  548. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.274">equals</a>(java.lang.Object&nbsp;obj)</pre>
  549. <div class="block">Tests the series for equality with another object.</div>
  550. <dl>
  551. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  552. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  553. <dt><span class="paramLabel">Parameters:</span></dt>
  554. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  555. <dt><span class="returnLabel">Returns:</span></dt>
  556. <dd><code>true</code> or <code>false</code>.</dd>
  557. </dl>
  558. </li>
  559. </ul>
  560. <a name="hashCode--">
  561. <!-- -->
  562. </a>
  563. <ul class="blockList">
  564. <li class="blockList">
  565. <h4>hashCode</h4>
  566. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.297">hashCode</a>()</pre>
  567. <div class="block">Returns a hash code.</div>
  568. <dl>
  569. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  570. <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  571. <dt><span class="returnLabel">Returns:</span></dt>
  572. <dd>A hash code.</dd>
  573. </dl>
  574. </li>
  575. </ul>
  576. <a name="addChangeListener-org.jfree.data.general.SeriesChangeListener-">
  577. <!-- -->
  578. </a>
  579. <ul class="blockList">
  580. <li class="blockList">
  581. <h4>addChangeListener</h4>
  582. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.314">addChangeListener</a>(<a href="../../../../org/jfree/data/general/SeriesChangeListener.html" title="interface in org.jfree.data.general">SeriesChangeListener</a>&nbsp;listener)</pre>
  583. <div class="block">Registers an object with this series, to receive notification whenever
  584. the series changes.
  585. <P>
  586. Objects being registered must implement the <a href="../../../../org/jfree/data/general/SeriesChangeListener.html" title="interface in org.jfree.data.general"><code>SeriesChangeListener</code></a>
  587. interface.</div>
  588. <dl>
  589. <dt><span class="paramLabel">Parameters:</span></dt>
  590. <dd><code>listener</code> - the listener to register.</dd>
  591. </dl>
  592. </li>
  593. </ul>
  594. <a name="removeChangeListener-org.jfree.data.general.SeriesChangeListener-">
  595. <!-- -->
  596. </a>
  597. <ul class="blockList">
  598. <li class="blockList">
  599. <h4>removeChangeListener</h4>
  600. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.324">removeChangeListener</a>(<a href="../../../../org/jfree/data/general/SeriesChangeListener.html" title="interface in org.jfree.data.general">SeriesChangeListener</a>&nbsp;listener)</pre>
  601. <div class="block">Deregisters an object, so that it not longer receives notification
  602. whenever the series changes.</div>
  603. <dl>
  604. <dt><span class="paramLabel">Parameters:</span></dt>
  605. <dd><code>listener</code> - the listener to deregister.</dd>
  606. </dl>
  607. </li>
  608. </ul>
  609. <a name="fireSeriesChanged--">
  610. <!-- -->
  611. </a>
  612. <ul class="blockList">
  613. <li class="blockList">
  614. <h4>fireSeriesChanged</h4>
  615. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.332">fireSeriesChanged</a>()</pre>
  616. <div class="block">General method for signalling to registered listeners that the series
  617. has been changed.</div>
  618. </li>
  619. </ul>
  620. <a name="notifyListeners-org.jfree.data.general.SeriesChangeEvent-">
  621. <!-- -->
  622. </a>
  623. <ul class="blockList">
  624. <li class="blockList">
  625. <h4>notifyListeners</h4>
  626. <pre>protected&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.344">notifyListeners</a>(<a href="../../../../org/jfree/data/general/SeriesChangeEvent.html" title="class in org.jfree.data.general">SeriesChangeEvent</a>&nbsp;event)</pre>
  627. <div class="block">Sends a change event to all registered listeners.</div>
  628. <dl>
  629. <dt><span class="paramLabel">Parameters:</span></dt>
  630. <dd><code>event</code> - contains information about the event that triggered the
  631. notification.</dd>
  632. </dl>
  633. </li>
  634. </ul>
  635. <a name="addPropertyChangeListener-java.beans.PropertyChangeListener-">
  636. <!-- -->
  637. </a>
  638. <ul class="blockList">
  639. <li class="blockList">
  640. <h4>addPropertyChangeListener</h4>
  641. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.361">addPropertyChangeListener</a>(java.beans.PropertyChangeListener&nbsp;listener)</pre>
  642. <div class="block">Adds a property change listener to the series.</div>
  643. <dl>
  644. <dt><span class="paramLabel">Parameters:</span></dt>
  645. <dd><code>listener</code> - the listener.</dd>
  646. </dl>
  647. </li>
  648. </ul>
  649. <a name="removePropertyChangeListener-java.beans.PropertyChangeListener-">
  650. <!-- -->
  651. </a>
  652. <ul class="blockList">
  653. <li class="blockList">
  654. <h4>removePropertyChangeListener</h4>
  655. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.370">removePropertyChangeListener</a>(java.beans.PropertyChangeListener&nbsp;listener)</pre>
  656. <div class="block">Removes a property change listener from the series.</div>
  657. <dl>
  658. <dt><span class="paramLabel">Parameters:</span></dt>
  659. <dd><code>listener</code> - the listener.</dd>
  660. </dl>
  661. </li>
  662. </ul>
  663. <a name="firePropertyChange-java.lang.String-java.lang.Object-java.lang.Object-">
  664. <!-- -->
  665. </a>
  666. <ul class="blockList">
  667. <li class="blockList">
  668. <h4>firePropertyChange</h4>
  669. <pre>protected&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.381">firePropertyChange</a>(java.lang.String&nbsp;property,
  670. java.lang.Object&nbsp;oldValue,
  671. java.lang.Object&nbsp;newValue)</pre>
  672. <div class="block">Fires a property change event.</div>
  673. <dl>
  674. <dt><span class="paramLabel">Parameters:</span></dt>
  675. <dd><code>property</code> - the property key.</dd>
  676. <dd><code>oldValue</code> - the old value.</dd>
  677. <dd><code>newValue</code> - the new value.</dd>
  678. </dl>
  679. </li>
  680. </ul>
  681. <a name="addVetoableChangeListener-java.beans.VetoableChangeListener-">
  682. <!-- -->
  683. </a>
  684. <ul class="blockList">
  685. <li class="blockList">
  686. <h4>addVetoableChangeListener</h4>
  687. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.394">addVetoableChangeListener</a>(java.beans.VetoableChangeListener&nbsp;listener)</pre>
  688. <div class="block">Adds a vetoable property change listener to the series.</div>
  689. <dl>
  690. <dt><span class="paramLabel">Parameters:</span></dt>
  691. <dd><code>listener</code> - the listener.</dd>
  692. <dt><span class="simpleTagLabel">Since:</span></dt>
  693. <dd>1.0.14</dd>
  694. </dl>
  695. </li>
  696. </ul>
  697. <a name="removeVetoableChangeListener-java.beans.VetoableChangeListener-">
  698. <!-- -->
  699. </a>
  700. <ul class="blockList">
  701. <li class="blockList">
  702. <h4>removeVetoableChangeListener</h4>
  703. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.405">removeVetoableChangeListener</a>(java.beans.VetoableChangeListener&nbsp;listener)</pre>
  704. <div class="block">Removes a vetoable property change listener from the series.</div>
  705. <dl>
  706. <dt><span class="paramLabel">Parameters:</span></dt>
  707. <dd><code>listener</code> - the listener.</dd>
  708. <dt><span class="simpleTagLabel">Since:</span></dt>
  709. <dd>1.0.14</dd>
  710. </dl>
  711. </li>
  712. </ul>
  713. <a name="fireVetoableChange-java.lang.String-java.lang.Object-java.lang.Object-">
  714. <!-- -->
  715. </a>
  716. <ul class="blockListLast">
  717. <li class="blockList">
  718. <h4>fireVetoableChange</h4>
  719. <pre>protected&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/general/Series.html#line.418">fireVetoableChange</a>(java.lang.String&nbsp;property,
  720. java.lang.Object&nbsp;oldValue,
  721. java.lang.Object&nbsp;newValue)
  722. throws java.beans.PropertyVetoException</pre>
  723. <div class="block">Fires a vetoable property change event.</div>
  724. <dl>
  725. <dt><span class="paramLabel">Parameters:</span></dt>
  726. <dd><code>property</code> - the property key.</dd>
  727. <dd><code>oldValue</code> - the old value.</dd>
  728. <dd><code>newValue</code> - the new value.</dd>
  729. <dt><span class="throwsLabel">Throws:</span></dt>
  730. <dd><code>java.beans.PropertyVetoException</code> - if the change was vetoed.</dd>
  731. </dl>
  732. </li>
  733. </ul>
  734. </li>
  735. </ul>
  736. </li>
  737. </ul>
  738. </div>
  739. </div>
  740. <!-- ========= END OF CLASS DATA ========= -->
  741. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  742. <div class="bottomNav"><a name="navbar.bottom">
  743. <!-- -->
  744. </a>
  745. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  746. <a name="navbar.bottom.firstrow">
  747. <!-- -->
  748. </a>
  749. <ul class="navList" title="Navigation">
  750. <li><a href="../../../../overview-summary.html">Overview</a></li>
  751. <li><a href="package-summary.html">Package</a></li>
  752. <li class="navBarCell1Rev">Class</li>
  753. <li><a href="class-use/Series.html">Use</a></li>
  754. <li><a href="package-tree.html">Tree</a></li>
  755. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  756. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  757. <li><a href="../../../../help-doc.html">Help</a></li>
  758. </ul>
  759. </div>
  760. <div class="subNav">
  761. <ul class="navList">
  762. <li><a href="../../../../org/jfree/data/general/PieDataset.html" title="interface in org.jfree.data.general"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  763. <li><a href="../../../../org/jfree/data/general/SeriesChangeEvent.html" title="class in org.jfree.data.general"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  764. </ul>
  765. <ul class="navList">
  766. <li><a href="../../../../index.html?org/jfree/data/general/Series.html" target="_top">Frames</a></li>
  767. <li><a href="Series.html" target="_top">No&nbsp;Frames</a></li>
  768. </ul>
  769. <ul class="navList" id="allclasses_navbar_bottom">
  770. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  771. </ul>
  772. <div>
  773. <script type="text/javascript"><!--
  774. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  775. if(window==top) {
  776. allClassesLink.style.display = "block";
  777. }
  778. else {
  779. allClassesLink.style.display = "none";
  780. }
  781. //-->
  782. </script>
  783. </div>
  784. <div>
  785. <ul class="subNavList">
  786. <li>Summary:&nbsp;</li>
  787. <li>Nested&nbsp;|&nbsp;</li>
  788. <li>Field&nbsp;|&nbsp;</li>
  789. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  790. <li><a href="#method.summary">Method</a></li>
  791. </ul>
  792. <ul class="subNavList">
  793. <li>Detail:&nbsp;</li>
  794. <li>Field&nbsp;|&nbsp;</li>
  795. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  796. <li><a href="#method.detail">Method</a></li>
  797. </ul>
  798. </div>
  799. <a name="skip.navbar.bottom">
  800. <!-- -->
  801. </a></div>
  802. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  803. </body>
  804. </html>