ComparableObjectSeries.html 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html lang="en">
  3. <head>
  4. <title>Source code</title>
  5. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  6. </head>
  7. <body>
  8. <div class="sourceContainer">
  9. <pre><span class="sourceLineNo">001</span>/* ===========================================================<a name="line.1"></a>
  10. <span class="sourceLineNo">002</span> * JFreeChart : a free chart library for the Java(tm) platform<a name="line.2"></a>
  11. <span class="sourceLineNo">003</span> * ===========================================================<a name="line.3"></a>
  12. <span class="sourceLineNo">004</span> *<a name="line.4"></a>
  13. <span class="sourceLineNo">005</span> * (C) Copyright 2000-2013, by Object Refinery Limited and Contributors.<a name="line.5"></a>
  14. <span class="sourceLineNo">006</span> *<a name="line.6"></a>
  15. <span class="sourceLineNo">007</span> * Project Info: http://www.jfree.org/jfreechart/index.html<a name="line.7"></a>
  16. <span class="sourceLineNo">008</span> *<a name="line.8"></a>
  17. <span class="sourceLineNo">009</span> * This library is free software; you can redistribute it and/or modify it<a name="line.9"></a>
  18. <span class="sourceLineNo">010</span> * under the terms of the GNU Lesser General Public License as published by<a name="line.10"></a>
  19. <span class="sourceLineNo">011</span> * the Free Software Foundation; either version 2.1 of the License, or<a name="line.11"></a>
  20. <span class="sourceLineNo">012</span> * (at your option) any later version.<a name="line.12"></a>
  21. <span class="sourceLineNo">013</span> *<a name="line.13"></a>
  22. <span class="sourceLineNo">014</span> * This library is distributed in the hope that it will be useful, but<a name="line.14"></a>
  23. <span class="sourceLineNo">015</span> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY<a name="line.15"></a>
  24. <span class="sourceLineNo">016</span> * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public<a name="line.16"></a>
  25. <span class="sourceLineNo">017</span> * License for more details.<a name="line.17"></a>
  26. <span class="sourceLineNo">018</span> *<a name="line.18"></a>
  27. <span class="sourceLineNo">019</span> * You should have received a copy of the GNU Lesser General Public<a name="line.19"></a>
  28. <span class="sourceLineNo">020</span> * License along with this library; if not, write to the Free Software<a name="line.20"></a>
  29. <span class="sourceLineNo">021</span> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,<a name="line.21"></a>
  30. <span class="sourceLineNo">022</span> * USA.<a name="line.22"></a>
  31. <span class="sourceLineNo">023</span> *<a name="line.23"></a>
  32. <span class="sourceLineNo">024</span> * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. <a name="line.24"></a>
  33. <span class="sourceLineNo">025</span> * Other names may be trademarks of their respective owners.]<a name="line.25"></a>
  34. <span class="sourceLineNo">026</span> *<a name="line.26"></a>
  35. <span class="sourceLineNo">027</span> * ---------------------------<a name="line.27"></a>
  36. <span class="sourceLineNo">028</span> * ComparableObjectSeries.java<a name="line.28"></a>
  37. <span class="sourceLineNo">029</span> * ---------------------------<a name="line.29"></a>
  38. <span class="sourceLineNo">030</span> * (C) Copyright 2006-2013, by Object Refinery Limited.<a name="line.30"></a>
  39. <span class="sourceLineNo">031</span> *<a name="line.31"></a>
  40. <span class="sourceLineNo">032</span> * Original Author: David Gilbert (for Object Refinery Limited);<a name="line.32"></a>
  41. <span class="sourceLineNo">033</span> * Contributor(s): -;<a name="line.33"></a>
  42. <span class="sourceLineNo">034</span> *<a name="line.34"></a>
  43. <span class="sourceLineNo">035</span> * Changes<a name="line.35"></a>
  44. <span class="sourceLineNo">036</span> * -------<a name="line.36"></a>
  45. <span class="sourceLineNo">037</span> * 19-Oct-2006 : New class (DG);<a name="line.37"></a>
  46. <span class="sourceLineNo">038</span> * 31-Oct-2007 : Implemented faster hashCode() (DG);<a name="line.38"></a>
  47. <span class="sourceLineNo">039</span> * 27-Nov-2007 : Changed clear() from protected to public (DG);<a name="line.39"></a>
  48. <span class="sourceLineNo">040</span> *<a name="line.40"></a>
  49. <span class="sourceLineNo">041</span> */<a name="line.41"></a>
  50. <span class="sourceLineNo">042</span><a name="line.42"></a>
  51. <span class="sourceLineNo">043</span>package org.jfree.data;<a name="line.43"></a>
  52. <span class="sourceLineNo">044</span><a name="line.44"></a>
  53. <span class="sourceLineNo">045</span>import java.io.Serializable;<a name="line.45"></a>
  54. <span class="sourceLineNo">046</span>import java.util.Collections;<a name="line.46"></a>
  55. <span class="sourceLineNo">047</span>import java.util.List;<a name="line.47"></a>
  56. <span class="sourceLineNo">048</span>import org.jfree.chart.util.ParamChecks;<a name="line.48"></a>
  57. <span class="sourceLineNo">049</span><a name="line.49"></a>
  58. <span class="sourceLineNo">050</span>import org.jfree.data.general.Series;<a name="line.50"></a>
  59. <span class="sourceLineNo">051</span>import org.jfree.data.general.SeriesChangeEvent;<a name="line.51"></a>
  60. <span class="sourceLineNo">052</span>import org.jfree.data.general.SeriesException;<a name="line.52"></a>
  61. <span class="sourceLineNo">053</span>import org.jfree.util.ObjectUtilities;<a name="line.53"></a>
  62. <span class="sourceLineNo">054</span><a name="line.54"></a>
  63. <span class="sourceLineNo">055</span>/**<a name="line.55"></a>
  64. <span class="sourceLineNo">056</span> * A (possibly ordered) list of (Comparable, Object) data items.<a name="line.56"></a>
  65. <span class="sourceLineNo">057</span> *<a name="line.57"></a>
  66. <span class="sourceLineNo">058</span> * @since 1.0.3<a name="line.58"></a>
  67. <span class="sourceLineNo">059</span> */<a name="line.59"></a>
  68. <span class="sourceLineNo">060</span>public class ComparableObjectSeries extends Series<a name="line.60"></a>
  69. <span class="sourceLineNo">061</span> implements Cloneable, Serializable {<a name="line.61"></a>
  70. <span class="sourceLineNo">062</span><a name="line.62"></a>
  71. <span class="sourceLineNo">063</span> /** Storage for the data items in the series. */<a name="line.63"></a>
  72. <span class="sourceLineNo">064</span> protected List data;<a name="line.64"></a>
  73. <span class="sourceLineNo">065</span><a name="line.65"></a>
  74. <span class="sourceLineNo">066</span> /** The maximum number of items for the series. */<a name="line.66"></a>
  75. <span class="sourceLineNo">067</span> private int maximumItemCount = Integer.MAX_VALUE;<a name="line.67"></a>
  76. <span class="sourceLineNo">068</span><a name="line.68"></a>
  77. <span class="sourceLineNo">069</span> /** A flag that controls whether the items are automatically sorted. */<a name="line.69"></a>
  78. <span class="sourceLineNo">070</span> private boolean autoSort;<a name="line.70"></a>
  79. <span class="sourceLineNo">071</span><a name="line.71"></a>
  80. <span class="sourceLineNo">072</span> /** A flag that controls whether or not duplicate x-values are allowed. */<a name="line.72"></a>
  81. <span class="sourceLineNo">073</span> private boolean allowDuplicateXValues;<a name="line.73"></a>
  82. <span class="sourceLineNo">074</span><a name="line.74"></a>
  83. <span class="sourceLineNo">075</span> /**<a name="line.75"></a>
  84. <span class="sourceLineNo">076</span> * Creates a new empty series. By default, items added to the series will<a name="line.76"></a>
  85. <span class="sourceLineNo">077</span> * be sorted into ascending order by x-value, and duplicate x-values will<a name="line.77"></a>
  86. <span class="sourceLineNo">078</span> * be allowed (these defaults can be modified with another constructor.<a name="line.78"></a>
  87. <span class="sourceLineNo">079</span> *<a name="line.79"></a>
  88. <span class="sourceLineNo">080</span> * @param key the series key (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.80"></a>
  89. <span class="sourceLineNo">081</span> */<a name="line.81"></a>
  90. <span class="sourceLineNo">082</span> public ComparableObjectSeries(Comparable key) {<a name="line.82"></a>
  91. <span class="sourceLineNo">083</span> this(key, true, true);<a name="line.83"></a>
  92. <span class="sourceLineNo">084</span> }<a name="line.84"></a>
  93. <span class="sourceLineNo">085</span><a name="line.85"></a>
  94. <span class="sourceLineNo">086</span> /**<a name="line.86"></a>
  95. <span class="sourceLineNo">087</span> * Constructs a new series that contains no data. You can specify<a name="line.87"></a>
  96. <span class="sourceLineNo">088</span> * whether or not duplicate x-values are allowed for the series.<a name="line.88"></a>
  97. <span class="sourceLineNo">089</span> *<a name="line.89"></a>
  98. <span class="sourceLineNo">090</span> * @param key the series key (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.90"></a>
  99. <span class="sourceLineNo">091</span> * @param autoSort a flag that controls whether or not the items in the<a name="line.91"></a>
  100. <span class="sourceLineNo">092</span> * series are sorted.<a name="line.92"></a>
  101. <span class="sourceLineNo">093</span> * @param allowDuplicateXValues a flag that controls whether duplicate<a name="line.93"></a>
  102. <span class="sourceLineNo">094</span> * x-values are allowed.<a name="line.94"></a>
  103. <span class="sourceLineNo">095</span> */<a name="line.95"></a>
  104. <span class="sourceLineNo">096</span> public ComparableObjectSeries(Comparable key, boolean autoSort,<a name="line.96"></a>
  105. <span class="sourceLineNo">097</span> boolean allowDuplicateXValues) {<a name="line.97"></a>
  106. <span class="sourceLineNo">098</span> super(key);<a name="line.98"></a>
  107. <span class="sourceLineNo">099</span> this.data = new java.util.ArrayList();<a name="line.99"></a>
  108. <span class="sourceLineNo">100</span> this.autoSort = autoSort;<a name="line.100"></a>
  109. <span class="sourceLineNo">101</span> this.allowDuplicateXValues = allowDuplicateXValues;<a name="line.101"></a>
  110. <span class="sourceLineNo">102</span> }<a name="line.102"></a>
  111. <span class="sourceLineNo">103</span><a name="line.103"></a>
  112. <span class="sourceLineNo">104</span> /**<a name="line.104"></a>
  113. <span class="sourceLineNo">105</span> * Returns the flag that controls whether the items in the series are<a name="line.105"></a>
  114. <span class="sourceLineNo">106</span> * automatically sorted. There is no setter for this flag, it must be<a name="line.106"></a>
  115. <span class="sourceLineNo">107</span> * defined in the series constructor.<a name="line.107"></a>
  116. <span class="sourceLineNo">108</span> *<a name="line.108"></a>
  117. <span class="sourceLineNo">109</span> * @return A boolean.<a name="line.109"></a>
  118. <span class="sourceLineNo">110</span> */<a name="line.110"></a>
  119. <span class="sourceLineNo">111</span> public boolean getAutoSort() {<a name="line.111"></a>
  120. <span class="sourceLineNo">112</span> return this.autoSort;<a name="line.112"></a>
  121. <span class="sourceLineNo">113</span> }<a name="line.113"></a>
  122. <span class="sourceLineNo">114</span><a name="line.114"></a>
  123. <span class="sourceLineNo">115</span> /**<a name="line.115"></a>
  124. <span class="sourceLineNo">116</span> * Returns a flag that controls whether duplicate x-values are allowed.<a name="line.116"></a>
  125. <span class="sourceLineNo">117</span> * This flag can only be set in the constructor.<a name="line.117"></a>
  126. <span class="sourceLineNo">118</span> *<a name="line.118"></a>
  127. <span class="sourceLineNo">119</span> * @return A boolean.<a name="line.119"></a>
  128. <span class="sourceLineNo">120</span> */<a name="line.120"></a>
  129. <span class="sourceLineNo">121</span> public boolean getAllowDuplicateXValues() {<a name="line.121"></a>
  130. <span class="sourceLineNo">122</span> return this.allowDuplicateXValues;<a name="line.122"></a>
  131. <span class="sourceLineNo">123</span> }<a name="line.123"></a>
  132. <span class="sourceLineNo">124</span><a name="line.124"></a>
  133. <span class="sourceLineNo">125</span> /**<a name="line.125"></a>
  134. <span class="sourceLineNo">126</span> * Returns the number of items in the series.<a name="line.126"></a>
  135. <span class="sourceLineNo">127</span> *<a name="line.127"></a>
  136. <span class="sourceLineNo">128</span> * @return The item count.<a name="line.128"></a>
  137. <span class="sourceLineNo">129</span> */<a name="line.129"></a>
  138. <span class="sourceLineNo">130</span> @Override<a name="line.130"></a>
  139. <span class="sourceLineNo">131</span> public int getItemCount() {<a name="line.131"></a>
  140. <span class="sourceLineNo">132</span> return this.data.size();<a name="line.132"></a>
  141. <span class="sourceLineNo">133</span> }<a name="line.133"></a>
  142. <span class="sourceLineNo">134</span><a name="line.134"></a>
  143. <span class="sourceLineNo">135</span> /**<a name="line.135"></a>
  144. <span class="sourceLineNo">136</span> * Returns the maximum number of items that will be retained in the series.<a name="line.136"></a>
  145. <span class="sourceLineNo">137</span> * The default value is &lt;code&gt;Integer.MAX_VALUE&lt;/code&gt;.<a name="line.137"></a>
  146. <span class="sourceLineNo">138</span> *<a name="line.138"></a>
  147. <span class="sourceLineNo">139</span> * @return The maximum item count.<a name="line.139"></a>
  148. <span class="sourceLineNo">140</span> * @see #setMaximumItemCount(int)<a name="line.140"></a>
  149. <span class="sourceLineNo">141</span> */<a name="line.141"></a>
  150. <span class="sourceLineNo">142</span> public int getMaximumItemCount() {<a name="line.142"></a>
  151. <span class="sourceLineNo">143</span> return this.maximumItemCount;<a name="line.143"></a>
  152. <span class="sourceLineNo">144</span> }<a name="line.144"></a>
  153. <span class="sourceLineNo">145</span><a name="line.145"></a>
  154. <span class="sourceLineNo">146</span> /**<a name="line.146"></a>
  155. <span class="sourceLineNo">147</span> * Sets the maximum number of items that will be retained in the series.<a name="line.147"></a>
  156. <span class="sourceLineNo">148</span> * If you add a new item to the series such that the number of items will<a name="line.148"></a>
  157. <span class="sourceLineNo">149</span> * exceed the maximum item count, then the first element in the series is<a name="line.149"></a>
  158. <span class="sourceLineNo">150</span> * automatically removed, ensuring that the maximum item count is not<a name="line.150"></a>
  159. <span class="sourceLineNo">151</span> * exceeded.<a name="line.151"></a>
  160. <span class="sourceLineNo">152</span> * &lt;p&gt;<a name="line.152"></a>
  161. <span class="sourceLineNo">153</span> * Typically this value is set before the series is populated with data,<a name="line.153"></a>
  162. <span class="sourceLineNo">154</span> * but if it is applied later, it may cause some items to be removed from<a name="line.154"></a>
  163. <span class="sourceLineNo">155</span> * the series (in which case a {@link SeriesChangeEvent} will be sent to<a name="line.155"></a>
  164. <span class="sourceLineNo">156</span> * all registered listeners.<a name="line.156"></a>
  165. <span class="sourceLineNo">157</span> *<a name="line.157"></a>
  166. <span class="sourceLineNo">158</span> * @param maximum the maximum number of items for the series.<a name="line.158"></a>
  167. <span class="sourceLineNo">159</span> */<a name="line.159"></a>
  168. <span class="sourceLineNo">160</span> public void setMaximumItemCount(int maximum) {<a name="line.160"></a>
  169. <span class="sourceLineNo">161</span> this.maximumItemCount = maximum;<a name="line.161"></a>
  170. <span class="sourceLineNo">162</span> boolean dataRemoved = false;<a name="line.162"></a>
  171. <span class="sourceLineNo">163</span> while (this.data.size() &gt; maximum) {<a name="line.163"></a>
  172. <span class="sourceLineNo">164</span> this.data.remove(0);<a name="line.164"></a>
  173. <span class="sourceLineNo">165</span> dataRemoved = true;<a name="line.165"></a>
  174. <span class="sourceLineNo">166</span> }<a name="line.166"></a>
  175. <span class="sourceLineNo">167</span> if (dataRemoved) {<a name="line.167"></a>
  176. <span class="sourceLineNo">168</span> fireSeriesChanged();<a name="line.168"></a>
  177. <span class="sourceLineNo">169</span> }<a name="line.169"></a>
  178. <span class="sourceLineNo">170</span> }<a name="line.170"></a>
  179. <span class="sourceLineNo">171</span><a name="line.171"></a>
  180. <span class="sourceLineNo">172</span> /**<a name="line.172"></a>
  181. <span class="sourceLineNo">173</span> * Adds new data to the series and sends a {@link SeriesChangeEvent} to<a name="line.173"></a>
  182. <span class="sourceLineNo">174</span> * all registered listeners.<a name="line.174"></a>
  183. <span class="sourceLineNo">175</span> * &lt;P&gt;<a name="line.175"></a>
  184. <span class="sourceLineNo">176</span> * Throws an exception if the x-value is a duplicate AND the<a name="line.176"></a>
  185. <span class="sourceLineNo">177</span> * allowDuplicateXValues flag is false.<a name="line.177"></a>
  186. <span class="sourceLineNo">178</span> *<a name="line.178"></a>
  187. <span class="sourceLineNo">179</span> * @param x the x-value (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.179"></a>
  188. <span class="sourceLineNo">180</span> * @param y the y-value (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.180"></a>
  189. <span class="sourceLineNo">181</span> */<a name="line.181"></a>
  190. <span class="sourceLineNo">182</span> protected void add(Comparable x, Object y) {<a name="line.182"></a>
  191. <span class="sourceLineNo">183</span> // argument checking delegated...<a name="line.183"></a>
  192. <span class="sourceLineNo">184</span> add(x, y, true);<a name="line.184"></a>
  193. <span class="sourceLineNo">185</span> }<a name="line.185"></a>
  194. <span class="sourceLineNo">186</span><a name="line.186"></a>
  195. <span class="sourceLineNo">187</span> /**<a name="line.187"></a>
  196. <span class="sourceLineNo">188</span> * Adds new data to the series and, if requested, sends a<a name="line.188"></a>
  197. <span class="sourceLineNo">189</span> * {@link SeriesChangeEvent} to all registered listeners.<a name="line.189"></a>
  198. <span class="sourceLineNo">190</span> * &lt;P&gt;<a name="line.190"></a>
  199. <span class="sourceLineNo">191</span> * Throws an exception if the x-value is a duplicate AND the<a name="line.191"></a>
  200. <span class="sourceLineNo">192</span> * allowDuplicateXValues flag is false.<a name="line.192"></a>
  201. <span class="sourceLineNo">193</span> *<a name="line.193"></a>
  202. <span class="sourceLineNo">194</span> * @param x the x-value (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.194"></a>
  203. <span class="sourceLineNo">195</span> * @param y the y-value (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.195"></a>
  204. <span class="sourceLineNo">196</span> * @param notify a flag the controls whether or not a<a name="line.196"></a>
  205. <span class="sourceLineNo">197</span> * {@link SeriesChangeEvent} is sent to all registered<a name="line.197"></a>
  206. <span class="sourceLineNo">198</span> * listeners.<a name="line.198"></a>
  207. <span class="sourceLineNo">199</span> */<a name="line.199"></a>
  208. <span class="sourceLineNo">200</span> protected void add(Comparable x, Object y, boolean notify) {<a name="line.200"></a>
  209. <span class="sourceLineNo">201</span> // delegate argument checking to XYDataItem...<a name="line.201"></a>
  210. <span class="sourceLineNo">202</span> ComparableObjectItem item = new ComparableObjectItem(x, y);<a name="line.202"></a>
  211. <span class="sourceLineNo">203</span> add(item, notify);<a name="line.203"></a>
  212. <span class="sourceLineNo">204</span> }<a name="line.204"></a>
  213. <span class="sourceLineNo">205</span><a name="line.205"></a>
  214. <span class="sourceLineNo">206</span> /**<a name="line.206"></a>
  215. <span class="sourceLineNo">207</span> * Adds a data item to the series and, if requested, sends a<a name="line.207"></a>
  216. <span class="sourceLineNo">208</span> * {@link SeriesChangeEvent} to all registered listeners.<a name="line.208"></a>
  217. <span class="sourceLineNo">209</span> *<a name="line.209"></a>
  218. <span class="sourceLineNo">210</span> * @param item the (x, y) item (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.210"></a>
  219. <span class="sourceLineNo">211</span> * @param notify a flag that controls whether or not a<a name="line.211"></a>
  220. <span class="sourceLineNo">212</span> * {@link SeriesChangeEvent} is sent to all registered<a name="line.212"></a>
  221. <span class="sourceLineNo">213</span> * listeners.<a name="line.213"></a>
  222. <span class="sourceLineNo">214</span> */<a name="line.214"></a>
  223. <span class="sourceLineNo">215</span> protected void add(ComparableObjectItem item, boolean notify) {<a name="line.215"></a>
  224. <span class="sourceLineNo">216</span><a name="line.216"></a>
  225. <span class="sourceLineNo">217</span> ParamChecks.nullNotPermitted(item, "item");<a name="line.217"></a>
  226. <span class="sourceLineNo">218</span> if (this.autoSort) {<a name="line.218"></a>
  227. <span class="sourceLineNo">219</span> int index = Collections.binarySearch(this.data, item);<a name="line.219"></a>
  228. <span class="sourceLineNo">220</span> if (index &lt; 0) {<a name="line.220"></a>
  229. <span class="sourceLineNo">221</span> this.data.add(-index - 1, item);<a name="line.221"></a>
  230. <span class="sourceLineNo">222</span> }<a name="line.222"></a>
  231. <span class="sourceLineNo">223</span> else {<a name="line.223"></a>
  232. <span class="sourceLineNo">224</span> if (this.allowDuplicateXValues) {<a name="line.224"></a>
  233. <span class="sourceLineNo">225</span> // need to make sure we are adding *after* any duplicates<a name="line.225"></a>
  234. <span class="sourceLineNo">226</span> int size = this.data.size();<a name="line.226"></a>
  235. <span class="sourceLineNo">227</span> while (index &lt; size<a name="line.227"></a>
  236. <span class="sourceLineNo">228</span> &amp;&amp; item.compareTo(this.data.get(index)) == 0) {<a name="line.228"></a>
  237. <span class="sourceLineNo">229</span> index++;<a name="line.229"></a>
  238. <span class="sourceLineNo">230</span> }<a name="line.230"></a>
  239. <span class="sourceLineNo">231</span> if (index &lt; this.data.size()) {<a name="line.231"></a>
  240. <span class="sourceLineNo">232</span> this.data.add(index, item);<a name="line.232"></a>
  241. <span class="sourceLineNo">233</span> }<a name="line.233"></a>
  242. <span class="sourceLineNo">234</span> else {<a name="line.234"></a>
  243. <span class="sourceLineNo">235</span> this.data.add(item);<a name="line.235"></a>
  244. <span class="sourceLineNo">236</span> }<a name="line.236"></a>
  245. <span class="sourceLineNo">237</span> }<a name="line.237"></a>
  246. <span class="sourceLineNo">238</span> else {<a name="line.238"></a>
  247. <span class="sourceLineNo">239</span> throw new SeriesException("X-value already exists.");<a name="line.239"></a>
  248. <span class="sourceLineNo">240</span> }<a name="line.240"></a>
  249. <span class="sourceLineNo">241</span> }<a name="line.241"></a>
  250. <span class="sourceLineNo">242</span> }<a name="line.242"></a>
  251. <span class="sourceLineNo">243</span> else {<a name="line.243"></a>
  252. <span class="sourceLineNo">244</span> if (!this.allowDuplicateXValues) {<a name="line.244"></a>
  253. <span class="sourceLineNo">245</span> // can't allow duplicate values, so we need to check whether<a name="line.245"></a>
  254. <span class="sourceLineNo">246</span> // there is an item with the given x-value already<a name="line.246"></a>
  255. <span class="sourceLineNo">247</span> int index = indexOf(item.getComparable());<a name="line.247"></a>
  256. <span class="sourceLineNo">248</span> if (index &gt;= 0) {<a name="line.248"></a>
  257. <span class="sourceLineNo">249</span> throw new SeriesException("X-value already exists.");<a name="line.249"></a>
  258. <span class="sourceLineNo">250</span> }<a name="line.250"></a>
  259. <span class="sourceLineNo">251</span> }<a name="line.251"></a>
  260. <span class="sourceLineNo">252</span> this.data.add(item);<a name="line.252"></a>
  261. <span class="sourceLineNo">253</span> }<a name="line.253"></a>
  262. <span class="sourceLineNo">254</span> if (getItemCount() &gt; this.maximumItemCount) {<a name="line.254"></a>
  263. <span class="sourceLineNo">255</span> this.data.remove(0);<a name="line.255"></a>
  264. <span class="sourceLineNo">256</span> }<a name="line.256"></a>
  265. <span class="sourceLineNo">257</span> if (notify) {<a name="line.257"></a>
  266. <span class="sourceLineNo">258</span> fireSeriesChanged();<a name="line.258"></a>
  267. <span class="sourceLineNo">259</span> }<a name="line.259"></a>
  268. <span class="sourceLineNo">260</span> }<a name="line.260"></a>
  269. <span class="sourceLineNo">261</span><a name="line.261"></a>
  270. <span class="sourceLineNo">262</span> /**<a name="line.262"></a>
  271. <span class="sourceLineNo">263</span> * Returns the index of the item with the specified x-value, or a negative<a name="line.263"></a>
  272. <span class="sourceLineNo">264</span> * index if the series does not contain an item with that x-value. Be<a name="line.264"></a>
  273. <span class="sourceLineNo">265</span> * aware that for an unsorted series, the index is found by iterating<a name="line.265"></a>
  274. <span class="sourceLineNo">266</span> * through all items in the series.<a name="line.266"></a>
  275. <span class="sourceLineNo">267</span> *<a name="line.267"></a>
  276. <span class="sourceLineNo">268</span> * @param x the x-value (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.268"></a>
  277. <span class="sourceLineNo">269</span> *<a name="line.269"></a>
  278. <span class="sourceLineNo">270</span> * @return The index.<a name="line.270"></a>
  279. <span class="sourceLineNo">271</span> */<a name="line.271"></a>
  280. <span class="sourceLineNo">272</span> public int indexOf(Comparable x) {<a name="line.272"></a>
  281. <span class="sourceLineNo">273</span> if (this.autoSort) {<a name="line.273"></a>
  282. <span class="sourceLineNo">274</span> return Collections.binarySearch(this.data, new ComparableObjectItem(<a name="line.274"></a>
  283. <span class="sourceLineNo">275</span> x, null));<a name="line.275"></a>
  284. <span class="sourceLineNo">276</span> }<a name="line.276"></a>
  285. <span class="sourceLineNo">277</span> else {<a name="line.277"></a>
  286. <span class="sourceLineNo">278</span> for (int i = 0; i &lt; this.data.size(); i++) {<a name="line.278"></a>
  287. <span class="sourceLineNo">279</span> ComparableObjectItem item = (ComparableObjectItem)<a name="line.279"></a>
  288. <span class="sourceLineNo">280</span> this.data.get(i);<a name="line.280"></a>
  289. <span class="sourceLineNo">281</span> if (item.getComparable().equals(x)) {<a name="line.281"></a>
  290. <span class="sourceLineNo">282</span> return i;<a name="line.282"></a>
  291. <span class="sourceLineNo">283</span> }<a name="line.283"></a>
  292. <span class="sourceLineNo">284</span> }<a name="line.284"></a>
  293. <span class="sourceLineNo">285</span> return -1;<a name="line.285"></a>
  294. <span class="sourceLineNo">286</span> }<a name="line.286"></a>
  295. <span class="sourceLineNo">287</span> }<a name="line.287"></a>
  296. <span class="sourceLineNo">288</span><a name="line.288"></a>
  297. <span class="sourceLineNo">289</span> /**<a name="line.289"></a>
  298. <span class="sourceLineNo">290</span> * Updates an item in the series.<a name="line.290"></a>
  299. <span class="sourceLineNo">291</span> *<a name="line.291"></a>
  300. <span class="sourceLineNo">292</span> * @param x the x-value (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.292"></a>
  301. <span class="sourceLineNo">293</span> * @param y the y-value (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.293"></a>
  302. <span class="sourceLineNo">294</span> *<a name="line.294"></a>
  303. <span class="sourceLineNo">295</span> * @throws SeriesException if there is no existing item with the specified<a name="line.295"></a>
  304. <span class="sourceLineNo">296</span> * x-value.<a name="line.296"></a>
  305. <span class="sourceLineNo">297</span> */<a name="line.297"></a>
  306. <span class="sourceLineNo">298</span> protected void update(Comparable x, Object y) {<a name="line.298"></a>
  307. <span class="sourceLineNo">299</span> int index = indexOf(x);<a name="line.299"></a>
  308. <span class="sourceLineNo">300</span> if (index &lt; 0) {<a name="line.300"></a>
  309. <span class="sourceLineNo">301</span> throw new SeriesException("No observation for x = " + x);<a name="line.301"></a>
  310. <span class="sourceLineNo">302</span> }<a name="line.302"></a>
  311. <span class="sourceLineNo">303</span> else {<a name="line.303"></a>
  312. <span class="sourceLineNo">304</span> ComparableObjectItem item = getDataItem(index);<a name="line.304"></a>
  313. <span class="sourceLineNo">305</span> item.setObject(y);<a name="line.305"></a>
  314. <span class="sourceLineNo">306</span> fireSeriesChanged();<a name="line.306"></a>
  315. <span class="sourceLineNo">307</span> }<a name="line.307"></a>
  316. <span class="sourceLineNo">308</span> }<a name="line.308"></a>
  317. <span class="sourceLineNo">309</span><a name="line.309"></a>
  318. <span class="sourceLineNo">310</span> /**<a name="line.310"></a>
  319. <span class="sourceLineNo">311</span> * Updates the value of an item in the series and sends a<a name="line.311"></a>
  320. <span class="sourceLineNo">312</span> * {@link SeriesChangeEvent} to all registered listeners.<a name="line.312"></a>
  321. <span class="sourceLineNo">313</span> *<a name="line.313"></a>
  322. <span class="sourceLineNo">314</span> * @param index the item (zero based index).<a name="line.314"></a>
  323. <span class="sourceLineNo">315</span> * @param y the new value (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.315"></a>
  324. <span class="sourceLineNo">316</span> */<a name="line.316"></a>
  325. <span class="sourceLineNo">317</span> protected void updateByIndex(int index, Object y) {<a name="line.317"></a>
  326. <span class="sourceLineNo">318</span> ComparableObjectItem item = getDataItem(index);<a name="line.318"></a>
  327. <span class="sourceLineNo">319</span> item.setObject(y);<a name="line.319"></a>
  328. <span class="sourceLineNo">320</span> fireSeriesChanged();<a name="line.320"></a>
  329. <span class="sourceLineNo">321</span> }<a name="line.321"></a>
  330. <span class="sourceLineNo">322</span><a name="line.322"></a>
  331. <span class="sourceLineNo">323</span> /**<a name="line.323"></a>
  332. <span class="sourceLineNo">324</span> * Return the data item with the specified index.<a name="line.324"></a>
  333. <span class="sourceLineNo">325</span> *<a name="line.325"></a>
  334. <span class="sourceLineNo">326</span> * @param index the index.<a name="line.326"></a>
  335. <span class="sourceLineNo">327</span> *<a name="line.327"></a>
  336. <span class="sourceLineNo">328</span> * @return The data item with the specified index.<a name="line.328"></a>
  337. <span class="sourceLineNo">329</span> */<a name="line.329"></a>
  338. <span class="sourceLineNo">330</span> protected ComparableObjectItem getDataItem(int index) {<a name="line.330"></a>
  339. <span class="sourceLineNo">331</span> return (ComparableObjectItem) this.data.get(index);<a name="line.331"></a>
  340. <span class="sourceLineNo">332</span> }<a name="line.332"></a>
  341. <span class="sourceLineNo">333</span><a name="line.333"></a>
  342. <span class="sourceLineNo">334</span> /**<a name="line.334"></a>
  343. <span class="sourceLineNo">335</span> * Deletes a range of items from the series and sends a<a name="line.335"></a>
  344. <span class="sourceLineNo">336</span> * {@link SeriesChangeEvent} to all registered listeners.<a name="line.336"></a>
  345. <span class="sourceLineNo">337</span> *<a name="line.337"></a>
  346. <span class="sourceLineNo">338</span> * @param start the start index (zero-based).<a name="line.338"></a>
  347. <span class="sourceLineNo">339</span> * @param end the end index (zero-based).<a name="line.339"></a>
  348. <span class="sourceLineNo">340</span> */<a name="line.340"></a>
  349. <span class="sourceLineNo">341</span> protected void delete(int start, int end) {<a name="line.341"></a>
  350. <span class="sourceLineNo">342</span> for (int i = start; i &lt;= end; i++) {<a name="line.342"></a>
  351. <span class="sourceLineNo">343</span> this.data.remove(start);<a name="line.343"></a>
  352. <span class="sourceLineNo">344</span> }<a name="line.344"></a>
  353. <span class="sourceLineNo">345</span> fireSeriesChanged();<a name="line.345"></a>
  354. <span class="sourceLineNo">346</span> }<a name="line.346"></a>
  355. <span class="sourceLineNo">347</span><a name="line.347"></a>
  356. <span class="sourceLineNo">348</span> /**<a name="line.348"></a>
  357. <span class="sourceLineNo">349</span> * Removes all data items from the series and, unless the series is<a name="line.349"></a>
  358. <span class="sourceLineNo">350</span> * already empty, sends a {@link SeriesChangeEvent} to all registered<a name="line.350"></a>
  359. <span class="sourceLineNo">351</span> * listeners.<a name="line.351"></a>
  360. <span class="sourceLineNo">352</span> */<a name="line.352"></a>
  361. <span class="sourceLineNo">353</span> public void clear() {<a name="line.353"></a>
  362. <span class="sourceLineNo">354</span> if (this.data.size() &gt; 0) {<a name="line.354"></a>
  363. <span class="sourceLineNo">355</span> this.data.clear();<a name="line.355"></a>
  364. <span class="sourceLineNo">356</span> fireSeriesChanged();<a name="line.356"></a>
  365. <span class="sourceLineNo">357</span> }<a name="line.357"></a>
  366. <span class="sourceLineNo">358</span> }<a name="line.358"></a>
  367. <span class="sourceLineNo">359</span><a name="line.359"></a>
  368. <span class="sourceLineNo">360</span> /**<a name="line.360"></a>
  369. <span class="sourceLineNo">361</span> * Removes the item at the specified index and sends a<a name="line.361"></a>
  370. <span class="sourceLineNo">362</span> * {@link SeriesChangeEvent} to all registered listeners.<a name="line.362"></a>
  371. <span class="sourceLineNo">363</span> *<a name="line.363"></a>
  372. <span class="sourceLineNo">364</span> * @param index the index.<a name="line.364"></a>
  373. <span class="sourceLineNo">365</span> *<a name="line.365"></a>
  374. <span class="sourceLineNo">366</span> * @return The item removed.<a name="line.366"></a>
  375. <span class="sourceLineNo">367</span> */<a name="line.367"></a>
  376. <span class="sourceLineNo">368</span> protected ComparableObjectItem remove(int index) {<a name="line.368"></a>
  377. <span class="sourceLineNo">369</span> ComparableObjectItem result = (ComparableObjectItem) this.data.remove(<a name="line.369"></a>
  378. <span class="sourceLineNo">370</span> index);<a name="line.370"></a>
  379. <span class="sourceLineNo">371</span> fireSeriesChanged();<a name="line.371"></a>
  380. <span class="sourceLineNo">372</span> return result;<a name="line.372"></a>
  381. <span class="sourceLineNo">373</span> }<a name="line.373"></a>
  382. <span class="sourceLineNo">374</span><a name="line.374"></a>
  383. <span class="sourceLineNo">375</span> /**<a name="line.375"></a>
  384. <span class="sourceLineNo">376</span> * Removes the item with the specified x-value and sends a<a name="line.376"></a>
  385. <span class="sourceLineNo">377</span> * {@link SeriesChangeEvent} to all registered listeners.<a name="line.377"></a>
  386. <span class="sourceLineNo">378</span> *<a name="line.378"></a>
  387. <span class="sourceLineNo">379</span> * @param x the x-value.<a name="line.379"></a>
  388. <span class="sourceLineNo">380</span><a name="line.380"></a>
  389. <span class="sourceLineNo">381</span> * @return The item removed.<a name="line.381"></a>
  390. <span class="sourceLineNo">382</span> */<a name="line.382"></a>
  391. <span class="sourceLineNo">383</span> public ComparableObjectItem remove(Comparable x) {<a name="line.383"></a>
  392. <span class="sourceLineNo">384</span> return remove(indexOf(x));<a name="line.384"></a>
  393. <span class="sourceLineNo">385</span> }<a name="line.385"></a>
  394. <span class="sourceLineNo">386</span><a name="line.386"></a>
  395. <span class="sourceLineNo">387</span> /**<a name="line.387"></a>
  396. <span class="sourceLineNo">388</span> * Tests this series for equality with an arbitrary object.<a name="line.388"></a>
  397. <span class="sourceLineNo">389</span> *<a name="line.389"></a>
  398. <span class="sourceLineNo">390</span> * @param obj the object to test against for equality<a name="line.390"></a>
  399. <span class="sourceLineNo">391</span> * (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.391"></a>
  400. <span class="sourceLineNo">392</span> *<a name="line.392"></a>
  401. <span class="sourceLineNo">393</span> * @return A boolean.<a name="line.393"></a>
  402. <span class="sourceLineNo">394</span> */<a name="line.394"></a>
  403. <span class="sourceLineNo">395</span> @Override<a name="line.395"></a>
  404. <span class="sourceLineNo">396</span> public boolean equals(Object obj) {<a name="line.396"></a>
  405. <span class="sourceLineNo">397</span> if (obj == this) {<a name="line.397"></a>
  406. <span class="sourceLineNo">398</span> return true;<a name="line.398"></a>
  407. <span class="sourceLineNo">399</span> }<a name="line.399"></a>
  408. <span class="sourceLineNo">400</span> if (!(obj instanceof ComparableObjectSeries)) {<a name="line.400"></a>
  409. <span class="sourceLineNo">401</span> return false;<a name="line.401"></a>
  410. <span class="sourceLineNo">402</span> }<a name="line.402"></a>
  411. <span class="sourceLineNo">403</span> if (!super.equals(obj)) {<a name="line.403"></a>
  412. <span class="sourceLineNo">404</span> return false;<a name="line.404"></a>
  413. <span class="sourceLineNo">405</span> }<a name="line.405"></a>
  414. <span class="sourceLineNo">406</span> ComparableObjectSeries that = (ComparableObjectSeries) obj;<a name="line.406"></a>
  415. <span class="sourceLineNo">407</span> if (this.maximumItemCount != that.maximumItemCount) {<a name="line.407"></a>
  416. <span class="sourceLineNo">408</span> return false;<a name="line.408"></a>
  417. <span class="sourceLineNo">409</span> }<a name="line.409"></a>
  418. <span class="sourceLineNo">410</span> if (this.autoSort != that.autoSort) {<a name="line.410"></a>
  419. <span class="sourceLineNo">411</span> return false;<a name="line.411"></a>
  420. <span class="sourceLineNo">412</span> }<a name="line.412"></a>
  421. <span class="sourceLineNo">413</span> if (this.allowDuplicateXValues != that.allowDuplicateXValues) {<a name="line.413"></a>
  422. <span class="sourceLineNo">414</span> return false;<a name="line.414"></a>
  423. <span class="sourceLineNo">415</span> }<a name="line.415"></a>
  424. <span class="sourceLineNo">416</span> if (!ObjectUtilities.equal(this.data, that.data)) {<a name="line.416"></a>
  425. <span class="sourceLineNo">417</span> return false;<a name="line.417"></a>
  426. <span class="sourceLineNo">418</span> }<a name="line.418"></a>
  427. <span class="sourceLineNo">419</span> return true;<a name="line.419"></a>
  428. <span class="sourceLineNo">420</span> }<a name="line.420"></a>
  429. <span class="sourceLineNo">421</span><a name="line.421"></a>
  430. <span class="sourceLineNo">422</span> /**<a name="line.422"></a>
  431. <span class="sourceLineNo">423</span> * Returns a hash code.<a name="line.423"></a>
  432. <span class="sourceLineNo">424</span> *<a name="line.424"></a>
  433. <span class="sourceLineNo">425</span> * @return A hash code.<a name="line.425"></a>
  434. <span class="sourceLineNo">426</span> */<a name="line.426"></a>
  435. <span class="sourceLineNo">427</span> @Override<a name="line.427"></a>
  436. <span class="sourceLineNo">428</span> public int hashCode() {<a name="line.428"></a>
  437. <span class="sourceLineNo">429</span> int result = super.hashCode();<a name="line.429"></a>
  438. <span class="sourceLineNo">430</span> // it is too slow to look at every data item, so let's just look at<a name="line.430"></a>
  439. <span class="sourceLineNo">431</span> // the first, middle and last items...<a name="line.431"></a>
  440. <span class="sourceLineNo">432</span> int count = getItemCount();<a name="line.432"></a>
  441. <span class="sourceLineNo">433</span> if (count &gt; 0) {<a name="line.433"></a>
  442. <span class="sourceLineNo">434</span> ComparableObjectItem item = getDataItem(0);<a name="line.434"></a>
  443. <span class="sourceLineNo">435</span> result = 29 * result + item.hashCode();<a name="line.435"></a>
  444. <span class="sourceLineNo">436</span> }<a name="line.436"></a>
  445. <span class="sourceLineNo">437</span> if (count &gt; 1) {<a name="line.437"></a>
  446. <span class="sourceLineNo">438</span> ComparableObjectItem item = getDataItem(count - 1);<a name="line.438"></a>
  447. <span class="sourceLineNo">439</span> result = 29 * result + item.hashCode();<a name="line.439"></a>
  448. <span class="sourceLineNo">440</span> }<a name="line.440"></a>
  449. <span class="sourceLineNo">441</span> if (count &gt; 2) {<a name="line.441"></a>
  450. <span class="sourceLineNo">442</span> ComparableObjectItem item = getDataItem(count / 2);<a name="line.442"></a>
  451. <span class="sourceLineNo">443</span> result = 29 * result + item.hashCode();<a name="line.443"></a>
  452. <span class="sourceLineNo">444</span> }<a name="line.444"></a>
  453. <span class="sourceLineNo">445</span> result = 29 * result + this.maximumItemCount;<a name="line.445"></a>
  454. <span class="sourceLineNo">446</span> result = 29 * result + (this.autoSort ? 1 : 0);<a name="line.446"></a>
  455. <span class="sourceLineNo">447</span> result = 29 * result + (this.allowDuplicateXValues ? 1 : 0);<a name="line.447"></a>
  456. <span class="sourceLineNo">448</span> return result;<a name="line.448"></a>
  457. <span class="sourceLineNo">449</span> }<a name="line.449"></a>
  458. <span class="sourceLineNo">450</span><a name="line.450"></a>
  459. <span class="sourceLineNo">451</span>}<a name="line.451"></a>
  460. </pre>
  461. </div>
  462. </body>
  463. </html>