segmentedtimeline.segmentrange.html

jfreechart1。0。2的api。

<FONT color="green">136</FONT>     * Additionally the &lt;code&gt;startTime&lt;/code&gt;, or start of the first Segment of <a name="line.136"></a>
<FONT color="green">137</FONT>     * the smallest segment group needs to be defined. This startTime could be <a name="line.137"></a>
<FONT color="green">138</FONT>     * relative to January 1, 1970, 00:00:00 GMT or any other date. This creates a <a name="line.138"></a>
<FONT color="green">139</FONT>     * point of reference to start counting Segment Groups. For example, for the <a name="line.139"></a>
<FONT color="green">140</FONT>     * working days SegmentedTimeline, the &lt;code&gt;startTime&lt;/code&gt; could be <a name="line.140"></a>
<FONT color="green">141</FONT>     * 00:00:00 GMT of the first Monday after January 1, 1970. In this class, the <a name="line.141"></a>
<FONT color="green">142</FONT>     * constant FIRST_MONDAY_AFTER_1900 refers to a reference point of the first <a name="line.142"></a>
<FONT color="green">143</FONT>     * Monday of the last century.<a name="line.143"></a>
<FONT color="green">144</FONT>     * &lt;p&gt;<a name="line.144"></a>
<FONT color="green">145</FONT>     * A SegmentedTimeline can include a baseTimeline. This combination of <a name="line.145"></a>
<FONT color="green">146</FONT>     * timelines allows the creation of more complex timelines. For example, in <a name="line.146"></a>
<FONT color="green">147</FONT>     * order to implement a SegmentedTimeline for an intraday stock trading <a name="line.147"></a>
<FONT color="green">148</FONT>     * application, where the trading period is defined as 9:00 AM through 4:00 PM <a name="line.148"></a>
<FONT color="green">149</FONT>     * Monday through Friday, two SegmentedTimelines are used. The first one (the <a name="line.149"></a>
<FONT color="green">150</FONT>     * baseTimeline) would be a working day SegmentedTimeline (daily timeline <a name="line.150"></a>
<FONT color="green">151</FONT>     * Monday through Friday). On top of this baseTimeline, a second one is defined<a name="line.151"></a>
<FONT color="green">152</FONT>     * that maps the 9:00 AM to 4:00 PM period. Because the baseTimeline defines a <a name="line.152"></a>
<FONT color="green">153</FONT>     * timeline of Monday through Friday, the resulting (combined) timeline will <a name="line.153"></a>
<FONT color="green">154</FONT>     * expose the period 9:00 AM through 4:00 PM only on Monday through Friday, <a name="line.154"></a>
<FONT color="green">155</FONT>     * and will remove all other intermediate intervals.<a name="line.155"></a>
<FONT color="green">156</FONT>     * &lt;P&gt;<a name="line.156"></a>
<FONT color="green">157</FONT>     * Two factory methods newMondayThroughFridayTimeline() and<a name="line.157"></a>
<FONT color="green">158</FONT>     * newFifteenMinuteTimeline() are provided as examples to create special<a name="line.158"></a>
<FONT color="green">159</FONT>     * SegmentedTimelines.<a name="line.159"></a>
<FONT color="green">160</FONT>     *<a name="line.160"></a>
<FONT color="green">161</FONT>     * @see org.jfree.chart.axis.DateAxis<a name="line.161"></a>
<FONT color="green">162</FONT>     *<a name="line.162"></a>
<FONT color="green">163</FONT>     * @author Bill Kelemen<a name="line.163"></a>
<FONT color="green">164</FONT>     */<a name="line.164"></a>
<FONT color="green">165</FONT>    public class SegmentedTimeline implements Timeline, Cloneable, Serializable {<a name="line.165"></a>
<FONT color="green">166</FONT>    <a name="line.166"></a>
<FONT color="green">167</FONT>        /** For serialization. */<a name="line.167"></a>
<FONT color="green">168</FONT>        private static final long serialVersionUID = 1093779862539903110L;<a name="line.168"></a>
<FONT color="green">169</FONT>        <a name="line.169"></a>
<FONT color="green">170</FONT>        ////////////////////////////////////////////////////////////////////////////<a name="line.170"></a>
<FONT color="green">171</FONT>        // predetermined segments sizes<a name="line.171"></a>
<FONT color="green">172</FONT>        ////////////////////////////////////////////////////////////////////////////<a name="line.172"></a>
<FONT color="green">173</FONT>    <a name="line.173"></a>
<FONT color="green">174</FONT>        /** Defines a day segment size in ms. */<a name="line.174"></a>
<FONT color="green">175</FONT>        public static final long DAY_SEGMENT_SIZE = 24 * 60 * 60 * 1000;<a name="line.175"></a>
<FONT color="green">176</FONT>    <a name="line.176"></a>
<FONT color="green">177</FONT>        /** Defines a one hour segment size in ms. */<a name="line.177"></a>
<FONT color="green">178</FONT>        public static final long HOUR_SEGMENT_SIZE = 60 * 60 * 1000;<a name="line.178"></a>
<FONT color="green">179</FONT>    <a name="line.179"></a>
<FONT color="green">180</FONT>        /** Defines a 15-minute segment size in ms. */<a name="line.180"></a>
<FONT color="green">181</FONT>        public static final long FIFTEEN_MINUTE_SEGMENT_SIZE = 15 * 60 * 1000;<a name="line.181"></a>
<FONT color="green">182</FONT>    <a name="line.182"></a>
<FONT color="green">183</FONT>        /** Defines a one-minute segment size in ms. */<a name="line.183"></a>
<FONT color="green">184</FONT>        public static final long MINUTE_SEGMENT_SIZE = 60 * 1000;<a name="line.184"></a>
<FONT color="green">185</FONT>    <a name="line.185"></a>
<FONT color="green">186</FONT>        ////////////////////////////////////////////////////////////////////////////<a name="line.186"></a>
<FONT color="green">187</FONT>        // other constants<a name="line.187"></a>
<FONT color="green">188</FONT>        ////////////////////////////////////////////////////////////////////////////<a name="line.188"></a>
<FONT color="green">189</FONT>    <a name="line.189"></a>
<FONT color="green">190</FONT>        /**<a name="line.190"></a>
<FONT color="green">191</FONT>         * Utility constant that defines the startTime as the first monday after <a name="line.191"></a>
<FONT color="green">192</FONT>         * 1/1/1970.  This should be used when creating a SegmentedTimeline for <a name="line.192"></a>
<FONT color="green">193</FONT>         * Monday through Friday. See static block below for calculation of this <a name="line.193"></a>
<FONT color="green">194</FONT>         * constant.<a name="line.194"></a>
<FONT color="green">195</FONT>         */<a name="line.195"></a>
<FONT color="green">196</FONT>        public static long FIRST_MONDAY_AFTER_1900;<a name="line.196"></a>
<FONT color="green">197</FONT>    <a name="line.197"></a>
<FONT color="green">198</FONT>        /**<a name="line.198"></a>
<FONT color="green">199</FONT>         * Utility TimeZone object that has no DST and an offset equal to the <a name="line.199"></a>
<FONT color="green">200</FONT>         * default TimeZone. This allows easy arithmetic between days as each one <a name="line.200"></a>
<FONT color="green">201</FONT>         * will have equal size.<a name="line.201"></a>
<FONT color="green">202</FONT>         */<a name="line.202"></a>
<FONT color="green">203</FONT>        public static TimeZone NO_DST_TIME_ZONE;<a name="line.203"></a>
<FONT color="green">204</FONT>    <a name="line.204"></a>
<FONT color="green">205</FONT>        /**<a name="line.205"></a>
<FONT color="green">206</FONT>         * This is the default time zone where the application is running. See <a name="line.206"></a>
<FONT color="green">207</FONT>         * getTime() below where we make use of certain transformations between <a name="line.207"></a>
<FONT color="green">208</FONT>         * times in the default time zone and the no-dst time zone used for our <a name="line.208"></a>
<FONT color="green">209</FONT>         * calculations.<a name="line.209"></a>
<FONT color="green">210</FONT>         */<a name="line.210"></a>
<FONT color="green">211</FONT>        public static TimeZone DEFAULT_TIME_ZONE = TimeZone.getDefault();<a name="line.211"></a>
<FONT color="green">212</FONT>    <a name="line.212"></a>
<FONT color="green">213</FONT>        /**<a name="line.213"></a>
<FONT color="green">214</FONT>         * This will be a utility calendar that has no DST but is shifted relative <a name="line.214"></a>
<FONT color="green">215</FONT>         * to the default time zone's offset.<a name="line.215"></a>
<FONT color="green">216</FONT>         */<a name="line.216"></a>
<FONT color="green">217</FONT>        private Calendar workingCalendarNoDST <a name="line.217"></a>
<FONT color="green">218</FONT>            = new GregorianCalendar(NO_DST_TIME_ZONE);<a name="line.218"></a>
<FONT color="green">219</FONT>    <a name="line.219"></a>
<FONT color="green">220</FONT>        /**<a name="line.220"></a>
<FONT color="green">221</FONT>         * This will be a utility calendar that used the default time zone.<a name="line.221"></a>
<FONT color="green">222</FONT>         */<a name="line.222"></a>
<FONT color="green">223</FONT>        private Calendar workingCalendar = Calendar.getInstance();<a name="line.223"></a>
<FONT color="green">224</FONT>    <a name="line.224"></a>
<FONT color="green">225</FONT>        ////////////////////////////////////////////////////////////////////////////<a name="line.225"></a>
<FONT color="green">226</FONT>        // private attributes<a name="line.226"></a>
<FONT color="green">227</FONT>        ////////////////////////////////////////////////////////////////////////////<a name="line.227"></a>
<FONT color="green">228</FONT>    <a name="line.228"></a>
<FONT color="green">229</FONT>        /** Segment size in ms. */<a name="line.229"></a>
<FONT color="green">230</FONT>        private long segmentSize;<a name="line.230"></a>
<FONT color="green">231</FONT>    <a name="line.231"></a>
<FONT color="green">232</FONT>        /** Number of consecutive segments to include in a segment group. */<a name="line.232"></a>
<FONT color="green">233</FONT>        private int segmentsIncluded;<a name="line.233"></a>
<FONT color="green">234</FONT>    <a name="line.234"></a>
<FONT color="green">235</FONT>        /** Number of consecutive segments to exclude in a segment group. */<a name="line.235"></a>
<FONT color="green">236</FONT>        private int segmentsExcluded;<a name="line.236"></a>
<FONT color="green">237</FONT>    <a name="line.237"></a>
<FONT color="green">238</FONT>        /** Number of segments in a group (segmentsIncluded + segmentsExcluded). */<a name="line.238"></a>
<FONT color="green">239</FONT>        private int groupSegmentCount;<a name="line.239"></a>
<FONT color="green">240</FONT>    <a name="line.240"></a>
<FONT color="green">241</FONT>        /** <a name="line.241"></a>
<FONT color="green">242</FONT>         * Start of time reference from time zero (1/1/1970). <a name="line.242"></a>
<FONT color="green">243</FONT>         * This is the start of segment #0. <a name="line.243"></a>
<FONT color="green">244</FONT>         */<a name="line.244"></a>
<FONT color="green">245</FONT>        private long startTime;<a name="line.245"></a>
<FONT color="green">246</FONT>    <a name="line.246"></a>
<FONT color="green">247</FONT>        /** Consecutive ms in segmentsIncluded (segmentsIncluded * segmentSize). */<a name="line.247"></a>
<FONT color="green">248</FONT>        private long segmentsIncludedSize;<a name="line.248"></a>
<FONT color="green">249</FONT>    <a name="line.249"></a>
<FONT color="green">250</FONT>        /** Consecutive ms in segmentsExcluded (segmentsExcluded * segmentSize). */<a name="line.250"></a>
<FONT color="green">251</FONT>        private long segmentsExcludedSize;<a name="line.251"></a>
<FONT color="green">252</FONT>    <a name="line.252"></a>
<FONT color="green">253</FONT>        /** ms in a segment group (segmentsIncludedSize + segmentsExcludedSize). */<a name="line.253"></a>
<FONT color="green">254</FONT>        private long segmentsGroupSize;<a name="line.254"></a>
<FONT color="green">255</FONT>    <a name="line.255"></a>
<FONT color="green">256</FONT>        /**<a name="line.256"></a>
<FONT color="green">257</FONT>         * List of exception segments (exceptions segments that would otherwise be<a name="line.257"></a>
<FONT color="green">258</FONT>         * included based on the periodic (included, excluded) grouping).<a name="line.258"></a>
<FONT color="green">259</FONT>         */<a name="line.259"></a>
<FONT color="green">260</FONT>        private List exceptionSegments = new ArrayList();<a name="line.260"></a>
<FONT color="green">261</FONT>    <a name="line.261"></a>
<FONT color="green">262</FONT>        /**<a name="line.262"></a>
<FONT color="green">263</FONT>         * This base timeline is used to specify exceptions at a higher level. For <a name="line.263"></a>
<FONT color="green">264</FONT>         * example, if we are a intraday timeline and want to exclude holidays, <a name="line.264"></a>
<FONT color="green">265</FONT>         * instead of having to exclude all intraday segments for the holiday, <a name="line.265"></a>
<FONT color="green">266</FONT>         * segments from this base timeline can be excluded. This baseTimeline is <a name="line.266"></a>
<FONT color="green">267</FONT>         * always optional and is only a convenience method.<a name="line.267"></a>
<FONT color="green">268</FONT>         * &lt;p&gt;<a name="line.268"></a>
<FONT color="green">269</FONT>         * Additionally, all excluded segments from this baseTimeline will be <a name="line.269"></a>
<FONT color="green">270</FONT>         * considered exceptions at this level.<a name="line.270"></a>
<FONT color="green">271</FONT>         */<a name="line.271"></a>
<FONT color="green">272</FONT>        private SegmentedTimeline baseTimeline;<a name="line.272"></a>
<FONT color="green">273</FONT>    <a name="line.273"></a>