123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <html lang="en">
- <head>
- <title>Source code</title>
- <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
- </head>
- <body>
- <div class="sourceContainer">
- <pre><span class="sourceLineNo">001</span>/* ===========================================================<a name="line.1"></a>
- <span class="sourceLineNo">002</span> * JFreeChart : a free chart library for the Java(tm) platform<a name="line.2"></a>
- <span class="sourceLineNo">003</span> * ===========================================================<a name="line.3"></a>
- <span class="sourceLineNo">004</span> *<a name="line.4"></a>
- <span class="sourceLineNo">005</span> * (C) Copyright 2000-2013, by Object Refinery Limited and Contributors.<a name="line.5"></a>
- <span class="sourceLineNo">006</span> *<a name="line.6"></a>
- <span class="sourceLineNo">007</span> * Project Info: http://www.jfree.org/jfreechart/index.html<a name="line.7"></a>
- <span class="sourceLineNo">008</span> *<a name="line.8"></a>
- <span class="sourceLineNo">009</span> * This library is free software; you can redistribute it and/or modify it<a name="line.9"></a>
- <span class="sourceLineNo">010</span> * under the terms of the GNU Lesser General Public License as published by<a name="line.10"></a>
- <span class="sourceLineNo">011</span> * the Free Software Foundation; either version 2.1 of the License, or<a name="line.11"></a>
- <span class="sourceLineNo">012</span> * (at your option) any later version.<a name="line.12"></a>
- <span class="sourceLineNo">013</span> *<a name="line.13"></a>
- <span class="sourceLineNo">014</span> * This library is distributed in the hope that it will be useful, but<a name="line.14"></a>
- <span class="sourceLineNo">015</span> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY<a name="line.15"></a>
- <span class="sourceLineNo">016</span> * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public<a name="line.16"></a>
- <span class="sourceLineNo">017</span> * License for more details.<a name="line.17"></a>
- <span class="sourceLineNo">018</span> *<a name="line.18"></a>
- <span class="sourceLineNo">019</span> * You should have received a copy of the GNU Lesser General Public<a name="line.19"></a>
- <span class="sourceLineNo">020</span> * License along with this library; if not, write to the Free Software<a name="line.20"></a>
- <span class="sourceLineNo">021</span> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,<a name="line.21"></a>
- <span class="sourceLineNo">022</span> * USA.<a name="line.22"></a>
- <span class="sourceLineNo">023</span> *<a name="line.23"></a>
- <span class="sourceLineNo">024</span> * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. <a name="line.24"></a>
- <span class="sourceLineNo">025</span> * Other names may be trademarks of their respective owners.]<a name="line.25"></a>
- <span class="sourceLineNo">026</span> *<a name="line.26"></a>
- <span class="sourceLineNo">027</span> * -----------------------<a name="line.27"></a>
- <span class="sourceLineNo">028</span> * TimeSeriesDataItem.java<a name="line.28"></a>
- <span class="sourceLineNo">029</span> * -----------------------<a name="line.29"></a>
- <span class="sourceLineNo">030</span> * (C) Copyright 2001-2013, by Object Refinery Limited.<a name="line.30"></a>
- <span class="sourceLineNo">031</span> *<a name="line.31"></a>
- <span class="sourceLineNo">032</span> * Original Author: David Gilbert (for Object Refinery Limited);<a name="line.32"></a>
- <span class="sourceLineNo">033</span> * Contributor(s): -;<a name="line.33"></a>
- <span class="sourceLineNo">034</span> *<a name="line.34"></a>
- <span class="sourceLineNo">035</span> * Changes<a name="line.35"></a>
- <span class="sourceLineNo">036</span> * -------<a name="line.36"></a>
- <span class="sourceLineNo">037</span> * 11-Oct-2001 : Version 1 (DG);<a name="line.37"></a>
- <span class="sourceLineNo">038</span> * 15-Nov-2001 : Updated Javadoc comments (DG);<a name="line.38"></a>
- <span class="sourceLineNo">039</span> * 29-Nov-2001 : Added cloning (DG);<a name="line.39"></a>
- <span class="sourceLineNo">040</span> * 24-Jun-2002 : Removed unnecessary import (DG);<a name="line.40"></a>
- <span class="sourceLineNo">041</span> * 07-Oct-2002 : Fixed errors reported by Checkstyle (DG);<a name="line.41"></a>
- <span class="sourceLineNo">042</span> * 13-Mar-2003 : Renamed TimeSeriesDataPair --> TimeSeriesDataItem, moved to<a name="line.42"></a>
- <span class="sourceLineNo">043</span> * com.jrefinery.data.time package, implemented Serializable (DG)<a name="line.43"></a>
- <span class="sourceLineNo">044</span> * ------------- JFREECHART 1.0.x ---------------------------------------------<a name="line.44"></a>
- <span class="sourceLineNo">045</span> * 09-Jun-2009 : Tidied up equals() (DG);<a name="line.45"></a>
- <span class="sourceLineNo">046</span> * 03-Jul-2013 : Use ParamChecks (DG);<a name="line.46"></a>
- <span class="sourceLineNo">047</span> * <a name="line.47"></a>
- <span class="sourceLineNo">048</span> */<a name="line.48"></a>
- <span class="sourceLineNo">049</span><a name="line.49"></a>
- <span class="sourceLineNo">050</span>package org.jfree.data.time;<a name="line.50"></a>
- <span class="sourceLineNo">051</span><a name="line.51"></a>
- <span class="sourceLineNo">052</span>import java.io.Serializable;<a name="line.52"></a>
- <span class="sourceLineNo">053</span>import org.jfree.chart.util.ParamChecks;<a name="line.53"></a>
- <span class="sourceLineNo">054</span>import org.jfree.util.ObjectUtilities;<a name="line.54"></a>
- <span class="sourceLineNo">055</span><a name="line.55"></a>
- <span class="sourceLineNo">056</span>/**<a name="line.56"></a>
- <span class="sourceLineNo">057</span> * Represents one data item in a time series.<a name="line.57"></a>
- <span class="sourceLineNo">058</span> * <P><a name="line.58"></a>
- <span class="sourceLineNo">059</span> * The time period can be any of the following:<a name="line.59"></a>
- <span class="sourceLineNo">060</span> * <ul><a name="line.60"></a>
- <span class="sourceLineNo">061</span> * <li>{@link Year}</li><a name="line.61"></a>
- <span class="sourceLineNo">062</span> * <li>{@link Quarter}</li><a name="line.62"></a>
- <span class="sourceLineNo">063</span> * <li>{@link Month}</li><a name="line.63"></a>
- <span class="sourceLineNo">064</span> * <li>{@link Week}</li><a name="line.64"></a>
- <span class="sourceLineNo">065</span> * <li>{@link Day}</li><a name="line.65"></a>
- <span class="sourceLineNo">066</span> * <li>{@link Hour}</li><a name="line.66"></a>
- <span class="sourceLineNo">067</span> * <li>{@link Minute}</li><a name="line.67"></a>
- <span class="sourceLineNo">068</span> * <li>{@link Second}</li><a name="line.68"></a>
- <span class="sourceLineNo">069</span> * <li>{@link Millisecond}</li><a name="line.69"></a>
- <span class="sourceLineNo">070</span> * <li>{@link FixedMillisecond}</li><a name="line.70"></a>
- <span class="sourceLineNo">071</span> * </ul><a name="line.71"></a>
- <span class="sourceLineNo">072</span> *<a name="line.72"></a>
- <span class="sourceLineNo">073</span> * The time period is an immutable property of the data item. Data items will<a name="line.73"></a>
- <span class="sourceLineNo">074</span> * often be sorted within a list, and allowing the time period to be changed<a name="line.74"></a>
- <span class="sourceLineNo">075</span> * could destroy the sort order.<a name="line.75"></a>
- <span class="sourceLineNo">076</span> * <P><a name="line.76"></a>
- <span class="sourceLineNo">077</span> * Implements the <code>Comparable</code> interface so that standard Java<a name="line.77"></a>
- <span class="sourceLineNo">078</span> * sorting can be used to keep the data items in order.<a name="line.78"></a>
- <span class="sourceLineNo">079</span> *<a name="line.79"></a>
- <span class="sourceLineNo">080</span> */<a name="line.80"></a>
- <span class="sourceLineNo">081</span>public class TimeSeriesDataItem implements Cloneable, Comparable, Serializable {<a name="line.81"></a>
- <span class="sourceLineNo">082</span><a name="line.82"></a>
- <span class="sourceLineNo">083</span> /** For serialization. */<a name="line.83"></a>
- <span class="sourceLineNo">084</span> private static final long serialVersionUID = -2235346966016401302L;<a name="line.84"></a>
- <span class="sourceLineNo">085</span><a name="line.85"></a>
- <span class="sourceLineNo">086</span> /** The time period. */<a name="line.86"></a>
- <span class="sourceLineNo">087</span> private RegularTimePeriod period;<a name="line.87"></a>
- <span class="sourceLineNo">088</span><a name="line.88"></a>
- <span class="sourceLineNo">089</span> /** The value associated with the time period. */<a name="line.89"></a>
- <span class="sourceLineNo">090</span> private Number value;<a name="line.90"></a>
- <span class="sourceLineNo">091</span><a name="line.91"></a>
- <span class="sourceLineNo">092</span> /**<a name="line.92"></a>
- <span class="sourceLineNo">093</span> * Constructs a new data item that associates a value with a time period.<a name="line.93"></a>
- <span class="sourceLineNo">094</span> *<a name="line.94"></a>
- <span class="sourceLineNo">095</span> * @param period the time period (<code>null</code> not permitted).<a name="line.95"></a>
- <span class="sourceLineNo">096</span> * @param value the value (<code>null</code> permitted).<a name="line.96"></a>
- <span class="sourceLineNo">097</span> */<a name="line.97"></a>
- <span class="sourceLineNo">098</span> public TimeSeriesDataItem(RegularTimePeriod period, Number value) {<a name="line.98"></a>
- <span class="sourceLineNo">099</span> ParamChecks.nullNotPermitted(period, "period");<a name="line.99"></a>
- <span class="sourceLineNo">100</span> this.period = period;<a name="line.100"></a>
- <span class="sourceLineNo">101</span> this.value = value;<a name="line.101"></a>
- <span class="sourceLineNo">102</span> }<a name="line.102"></a>
- <span class="sourceLineNo">103</span><a name="line.103"></a>
- <span class="sourceLineNo">104</span> /**<a name="line.104"></a>
- <span class="sourceLineNo">105</span> * Constructs a new data item that associates a value with a time period.<a name="line.105"></a>
- <span class="sourceLineNo">106</span> *<a name="line.106"></a>
- <span class="sourceLineNo">107</span> * @param period the time period (<code>null</code> not permitted).<a name="line.107"></a>
- <span class="sourceLineNo">108</span> * @param value the value associated with the time period.<a name="line.108"></a>
- <span class="sourceLineNo">109</span> */<a name="line.109"></a>
- <span class="sourceLineNo">110</span> public TimeSeriesDataItem(RegularTimePeriod period, double value) {<a name="line.110"></a>
- <span class="sourceLineNo">111</span> this(period, new Double(value));<a name="line.111"></a>
- <span class="sourceLineNo">112</span> }<a name="line.112"></a>
- <span class="sourceLineNo">113</span><a name="line.113"></a>
- <span class="sourceLineNo">114</span> /**<a name="line.114"></a>
- <span class="sourceLineNo">115</span> * Returns the time period.<a name="line.115"></a>
- <span class="sourceLineNo">116</span> *<a name="line.116"></a>
- <span class="sourceLineNo">117</span> * @return The time period (never <code>null</code>).<a name="line.117"></a>
- <span class="sourceLineNo">118</span> */<a name="line.118"></a>
- <span class="sourceLineNo">119</span> public RegularTimePeriod getPeriod() {<a name="line.119"></a>
- <span class="sourceLineNo">120</span> return this.period;<a name="line.120"></a>
- <span class="sourceLineNo">121</span> }<a name="line.121"></a>
- <span class="sourceLineNo">122</span><a name="line.122"></a>
- <span class="sourceLineNo">123</span> /**<a name="line.123"></a>
- <span class="sourceLineNo">124</span> * Returns the value.<a name="line.124"></a>
- <span class="sourceLineNo">125</span> *<a name="line.125"></a>
- <span class="sourceLineNo">126</span> * @return The value (<code>null</code> possible).<a name="line.126"></a>
- <span class="sourceLineNo">127</span> *<a name="line.127"></a>
- <span class="sourceLineNo">128</span> * @see #setValue(java.lang.Number)<a name="line.128"></a>
- <span class="sourceLineNo">129</span> */<a name="line.129"></a>
- <span class="sourceLineNo">130</span> public Number getValue() {<a name="line.130"></a>
- <span class="sourceLineNo">131</span> return this.value;<a name="line.131"></a>
- <span class="sourceLineNo">132</span> }<a name="line.132"></a>
- <span class="sourceLineNo">133</span><a name="line.133"></a>
- <span class="sourceLineNo">134</span> /**<a name="line.134"></a>
- <span class="sourceLineNo">135</span> * Sets the value for this data item.<a name="line.135"></a>
- <span class="sourceLineNo">136</span> *<a name="line.136"></a>
- <span class="sourceLineNo">137</span> * @param value the value (<code>null</code> permitted).<a name="line.137"></a>
- <span class="sourceLineNo">138</span> *<a name="line.138"></a>
- <span class="sourceLineNo">139</span> * @see #getValue()<a name="line.139"></a>
- <span class="sourceLineNo">140</span> */<a name="line.140"></a>
- <span class="sourceLineNo">141</span> public void setValue(Number value) {<a name="line.141"></a>
- <span class="sourceLineNo">142</span> this.value = value;<a name="line.142"></a>
- <span class="sourceLineNo">143</span> }<a name="line.143"></a>
- <span class="sourceLineNo">144</span><a name="line.144"></a>
- <span class="sourceLineNo">145</span> /**<a name="line.145"></a>
- <span class="sourceLineNo">146</span> * Tests this object for equality with an arbitrary object.<a name="line.146"></a>
- <span class="sourceLineNo">147</span> *<a name="line.147"></a>
- <span class="sourceLineNo">148</span> * @param obj the other object (<code>null</code> permitted).<a name="line.148"></a>
- <span class="sourceLineNo">149</span> *<a name="line.149"></a>
- <span class="sourceLineNo">150</span> * @return A boolean.<a name="line.150"></a>
- <span class="sourceLineNo">151</span> */<a name="line.151"></a>
- <span class="sourceLineNo">152</span> @Override<a name="line.152"></a>
- <span class="sourceLineNo">153</span> public boolean equals(Object obj) {<a name="line.153"></a>
- <span class="sourceLineNo">154</span> if (this == obj) {<a name="line.154"></a>
- <span class="sourceLineNo">155</span> return true;<a name="line.155"></a>
- <span class="sourceLineNo">156</span> }<a name="line.156"></a>
- <span class="sourceLineNo">157</span> if (!(obj instanceof TimeSeriesDataItem)) {<a name="line.157"></a>
- <span class="sourceLineNo">158</span> return false;<a name="line.158"></a>
- <span class="sourceLineNo">159</span> }<a name="line.159"></a>
- <span class="sourceLineNo">160</span> TimeSeriesDataItem that = (TimeSeriesDataItem) obj;<a name="line.160"></a>
- <span class="sourceLineNo">161</span> if (!ObjectUtilities.equal(this.period, that.period)) {<a name="line.161"></a>
- <span class="sourceLineNo">162</span> return false;<a name="line.162"></a>
- <span class="sourceLineNo">163</span> }<a name="line.163"></a>
- <span class="sourceLineNo">164</span> if (!ObjectUtilities.equal(this.value, that.value)) {<a name="line.164"></a>
- <span class="sourceLineNo">165</span> return false;<a name="line.165"></a>
- <span class="sourceLineNo">166</span> }<a name="line.166"></a>
- <span class="sourceLineNo">167</span> return true;<a name="line.167"></a>
- <span class="sourceLineNo">168</span> }<a name="line.168"></a>
- <span class="sourceLineNo">169</span><a name="line.169"></a>
- <span class="sourceLineNo">170</span> /**<a name="line.170"></a>
- <span class="sourceLineNo">171</span> * Returns a hash code.<a name="line.171"></a>
- <span class="sourceLineNo">172</span> *<a name="line.172"></a>
- <span class="sourceLineNo">173</span> * @return A hash code.<a name="line.173"></a>
- <span class="sourceLineNo">174</span> */<a name="line.174"></a>
- <span class="sourceLineNo">175</span> @Override<a name="line.175"></a>
- <span class="sourceLineNo">176</span> public int hashCode() {<a name="line.176"></a>
- <span class="sourceLineNo">177</span> int result;<a name="line.177"></a>
- <span class="sourceLineNo">178</span> result = (this.period != null ? this.period.hashCode() : 0);<a name="line.178"></a>
- <span class="sourceLineNo">179</span> result = 29 * result + (this.value != null ? this.value.hashCode() : 0);<a name="line.179"></a>
- <span class="sourceLineNo">180</span> return result;<a name="line.180"></a>
- <span class="sourceLineNo">181</span> }<a name="line.181"></a>
- <span class="sourceLineNo">182</span><a name="line.182"></a>
- <span class="sourceLineNo">183</span> /**<a name="line.183"></a>
- <span class="sourceLineNo">184</span> * Returns an integer indicating the order of this data pair object<a name="line.184"></a>
- <span class="sourceLineNo">185</span> * relative to another object.<a name="line.185"></a>
- <span class="sourceLineNo">186</span> * <P><a name="line.186"></a>
- <span class="sourceLineNo">187</span> * For the order we consider only the timing:<a name="line.187"></a>
- <span class="sourceLineNo">188</span> * negative == before, zero == same, positive == after.<a name="line.188"></a>
- <span class="sourceLineNo">189</span> *<a name="line.189"></a>
- <span class="sourceLineNo">190</span> * @param o1 The object being compared to.<a name="line.190"></a>
- <span class="sourceLineNo">191</span> *<a name="line.191"></a>
- <span class="sourceLineNo">192</span> * @return An integer indicating the order of the data item object<a name="line.192"></a>
- <span class="sourceLineNo">193</span> * relative to another object.<a name="line.193"></a>
- <span class="sourceLineNo">194</span> */<a name="line.194"></a>
- <span class="sourceLineNo">195</span> @Override<a name="line.195"></a>
- <span class="sourceLineNo">196</span> public int compareTo(Object o1) {<a name="line.196"></a>
- <span class="sourceLineNo">197</span><a name="line.197"></a>
- <span class="sourceLineNo">198</span> int result;<a name="line.198"></a>
- <span class="sourceLineNo">199</span><a name="line.199"></a>
- <span class="sourceLineNo">200</span> // CASE 1 : Comparing to another TimeSeriesDataItem object<a name="line.200"></a>
- <span class="sourceLineNo">201</span> // -------------------------------------------------------<a name="line.201"></a>
- <span class="sourceLineNo">202</span> if (o1 instanceof TimeSeriesDataItem) {<a name="line.202"></a>
- <span class="sourceLineNo">203</span> TimeSeriesDataItem datapair = (TimeSeriesDataItem) o1;<a name="line.203"></a>
- <span class="sourceLineNo">204</span> result = getPeriod().compareTo(datapair.getPeriod());<a name="line.204"></a>
- <span class="sourceLineNo">205</span> }<a name="line.205"></a>
- <span class="sourceLineNo">206</span><a name="line.206"></a>
- <span class="sourceLineNo">207</span> // CASE 2 : Comparing to a general object<a name="line.207"></a>
- <span class="sourceLineNo">208</span> // ---------------------------------------------<a name="line.208"></a>
- <span class="sourceLineNo">209</span> else {<a name="line.209"></a>
- <span class="sourceLineNo">210</span> // consider time periods to be ordered after general objects<a name="line.210"></a>
- <span class="sourceLineNo">211</span> result = 1;<a name="line.211"></a>
- <span class="sourceLineNo">212</span> }<a name="line.212"></a>
- <span class="sourceLineNo">213</span><a name="line.213"></a>
- <span class="sourceLineNo">214</span> return result;<a name="line.214"></a>
- <span class="sourceLineNo">215</span><a name="line.215"></a>
- <span class="sourceLineNo">216</span> }<a name="line.216"></a>
- <span class="sourceLineNo">217</span><a name="line.217"></a>
- <span class="sourceLineNo">218</span> /**<a name="line.218"></a>
- <span class="sourceLineNo">219</span> * Clones the data item. Note: there is no need to clone the period or<a name="line.219"></a>
- <span class="sourceLineNo">220</span> * value since they are immutable classes.<a name="line.220"></a>
- <span class="sourceLineNo">221</span> *<a name="line.221"></a>
- <span class="sourceLineNo">222</span> * @return A clone of the data item.<a name="line.222"></a>
- <span class="sourceLineNo">223</span> */<a name="line.223"></a>
- <span class="sourceLineNo">224</span> @Override<a name="line.224"></a>
- <span class="sourceLineNo">225</span> public Object clone() {<a name="line.225"></a>
- <span class="sourceLineNo">226</span> Object clone = null;<a name="line.226"></a>
- <span class="sourceLineNo">227</span> try {<a name="line.227"></a>
- <span class="sourceLineNo">228</span> clone = super.clone();<a name="line.228"></a>
- <span class="sourceLineNo">229</span> }<a name="line.229"></a>
- <span class="sourceLineNo">230</span> catch (CloneNotSupportedException e) { // won't get here...<a name="line.230"></a>
- <span class="sourceLineNo">231</span> e.printStackTrace();<a name="line.231"></a>
- <span class="sourceLineNo">232</span> }<a name="line.232"></a>
- <span class="sourceLineNo">233</span> return clone;<a name="line.233"></a>
- <span class="sourceLineNo">234</span> }<a name="line.234"></a>
- <span class="sourceLineNo">235</span><a name="line.235"></a>
- <span class="sourceLineNo">236</span>}<a name="line.236"></a>
- </pre>
- </div>
- </body>
- </html>
|