segmentedtimeline.segment.html

jfreechart1。0。2的api。

<FONT color="green">274</FONT>        /** A flag that controls whether or not to adjust for daylight saving. */<a name="line.274"></a>
<FONT color="green">275</FONT>        private boolean adjustForDaylightSaving = false;<a name="line.275"></a>
<FONT color="green">276</FONT>        <a name="line.276"></a>
<FONT color="green">277</FONT>        ////////////////////////////////////////////////////////////////////////////<a name="line.277"></a>
<FONT color="green">278</FONT>        // static block<a name="line.278"></a>
<FONT color="green">279</FONT>        ////////////////////////////////////////////////////////////////////////////<a name="line.279"></a>
<FONT color="green">280</FONT>    <a name="line.280"></a>
<FONT color="green">281</FONT>        static {<a name="line.281"></a>
<FONT color="green">282</FONT>            // make a time zone with no DST for our Calendar calculations<a name="line.282"></a>
<FONT color="green">283</FONT>            int offset = TimeZone.getDefault().getRawOffset();<a name="line.283"></a>
<FONT color="green">284</FONT>            NO_DST_TIME_ZONE = new SimpleTimeZone(offset, "UTC-" + offset);<a name="line.284"></a>
<FONT color="green">285</FONT>            <a name="line.285"></a>
<FONT color="green">286</FONT>            // calculate midnight of first monday after 1/1/1900 relative to <a name="line.286"></a>
<FONT color="green">287</FONT>            // current locale<a name="line.287"></a>
<FONT color="green">288</FONT>            Calendar cal = new GregorianCalendar(NO_DST_TIME_ZONE);<a name="line.288"></a>
<FONT color="green">289</FONT>            cal.set(1900, 0, 1, 0, 0, 0);<a name="line.289"></a>
<FONT color="green">290</FONT>            cal.set(Calendar.MILLISECOND, 0);<a name="line.290"></a>
<FONT color="green">291</FONT>            while (cal.get(Calendar.DAY_OF_WEEK) != Calendar.MONDAY) {<a name="line.291"></a>
<FONT color="green">292</FONT>                cal.add(Calendar.DATE, 1);<a name="line.292"></a>
<FONT color="green">293</FONT>            }<a name="line.293"></a>
<FONT color="green">294</FONT>            // FIRST_MONDAY_AFTER_1900 = cal.getTime().getTime();  <a name="line.294"></a>
<FONT color="green">295</FONT>            // preceding code won't work with JDK 1.3<a name="line.295"></a>
<FONT color="green">296</FONT>            FIRST_MONDAY_AFTER_1900 = cal.getTime().getTime();<a name="line.296"></a>
<FONT color="green">297</FONT>        }<a name="line.297"></a>
<FONT color="green">298</FONT>    <a name="line.298"></a>
<FONT color="green">299</FONT>        ////////////////////////////////////////////////////////////////////////////<a name="line.299"></a>
<FONT color="green">300</FONT>        // constructors and factory methods<a name="line.300"></a>
<FONT color="green">301</FONT>        ////////////////////////////////////////////////////////////////////////////<a name="line.301"></a>
<FONT color="green">302</FONT>    <a name="line.302"></a>
<FONT color="green">303</FONT>        /**<a name="line.303"></a>
<FONT color="green">304</FONT>         * Constructs a new segmented timeline, optionaly using another segmented<a name="line.304"></a>
<FONT color="green">305</FONT>         * timeline as its base. This chaining of SegmentedTimelines allows further<a name="line.305"></a>
<FONT color="green">306</FONT>         * segmentation into smaller timelines.<a name="line.306"></a>
<FONT color="green">307</FONT>         *<a name="line.307"></a>
<FONT color="green">308</FONT>         * If a base<a name="line.308"></a>
<FONT color="green">309</FONT>         *<a name="line.309"></a>
<FONT color="green">310</FONT>         * @param segmentSize the size of a segment in ms. This time unit will be<a name="line.310"></a>
<FONT color="green">311</FONT>         *        used to compute the included and excluded segments of the <a name="line.311"></a>
<FONT color="green">312</FONT>         *        timeline.<a name="line.312"></a>
<FONT color="green">313</FONT>         * @param segmentsIncluded Number of consecutive segments to include.<a name="line.313"></a>
<FONT color="green">314</FONT>         * @param segmentsExcluded Number of consecutive segments to exclude.<a name="line.314"></a>
<FONT color="green">315</FONT>         */<a name="line.315"></a>
<FONT color="green">316</FONT>        public SegmentedTimeline(long segmentSize,<a name="line.316"></a>
<FONT color="green">317</FONT>                                 int segmentsIncluded,<a name="line.317"></a>
<FONT color="green">318</FONT>                                 int segmentsExcluded) {<a name="line.318"></a>
<FONT color="green">319</FONT>    <a name="line.319"></a>
<FONT color="green">320</FONT>            this.segmentSize = segmentSize;<a name="line.320"></a>
<FONT color="green">321</FONT>            this.segmentsIncluded = segmentsIncluded;<a name="line.321"></a>
<FONT color="green">322</FONT>            this.segmentsExcluded = segmentsExcluded;<a name="line.322"></a>
<FONT color="green">323</FONT>    <a name="line.323"></a>
<FONT color="green">324</FONT>            this.groupSegmentCount = this.segmentsIncluded + this.segmentsExcluded;<a name="line.324"></a>
<FONT color="green">325</FONT>            this.segmentsIncludedSize = this.segmentsIncluded * this.segmentSize;<a name="line.325"></a>
<FONT color="green">326</FONT>            this.segmentsExcludedSize = this.segmentsExcluded * this.segmentSize;<a name="line.326"></a>
<FONT color="green">327</FONT>            this.segmentsGroupSize = this.segmentsIncludedSize <a name="line.327"></a>
<FONT color="green">328</FONT>                                     + this.segmentsExcludedSize;<a name="line.328"></a>
<FONT color="green">329</FONT>    <a name="line.329"></a>
<FONT color="green">330</FONT>        }<a name="line.330"></a>
<FONT color="green">331</FONT>    <a name="line.331"></a>
<FONT color="green">332</FONT>        /**<a name="line.332"></a>
<FONT color="green">333</FONT>         * Factory method to create a Monday through Friday SegmentedTimeline.<a name="line.333"></a>
<FONT color="green">334</FONT>         * &lt;P&gt;<a name="line.334"></a>
<FONT color="green">335</FONT>         * The &lt;code&gt;startTime&lt;/code&gt; of the resulting timeline will be midnight <a name="line.335"></a>
<FONT color="green">336</FONT>         * of the first Monday after 1/1/1900.<a name="line.336"></a>
<FONT color="green">337</FONT>         *<a name="line.337"></a>
<FONT color="green">338</FONT>         * @return A fully initialized SegmentedTimeline.<a name="line.338"></a>
<FONT color="green">339</FONT>         */<a name="line.339"></a>
<FONT color="green">340</FONT>        public static SegmentedTimeline newMondayThroughFridayTimeline() {<a name="line.340"></a>
<FONT color="green">341</FONT>            SegmentedTimeline timeline <a name="line.341"></a>
<FONT color="green">342</FONT>                = new SegmentedTimeline(DAY_SEGMENT_SIZE, 5, 2);<a name="line.342"></a>
<FONT color="green">343</FONT>            timeline.setStartTime(FIRST_MONDAY_AFTER_1900);<a name="line.343"></a>
<FONT color="green">344</FONT>            return timeline;<a name="line.344"></a>
<FONT color="green">345</FONT>        }<a name="line.345"></a>
<FONT color="green">346</FONT>    <a name="line.346"></a>
<FONT color="green">347</FONT>        /**<a name="line.347"></a>
<FONT color="green">348</FONT>         * Factory method to create a 15-min, 9:00 AM thought 4:00 PM, Monday <a name="line.348"></a>
<FONT color="green">349</FONT>         * through Friday SegmentedTimeline.<a name="line.349"></a>
<FONT color="green">350</FONT>         * &lt;P&gt;<a name="line.350"></a>
<FONT color="green">351</FONT>         * This timeline uses a segmentSize of FIFTEEN_MIN_SEGMENT_SIZE. The <a name="line.351"></a>
<FONT color="green">352</FONT>         * segment group is defined as 28 included segments (9:00 AM through <a name="line.352"></a>
<FONT color="green">353</FONT>         * 4:00 PM) and 68 excluded segments (4:00 PM through 9:00 AM the next day).<a name="line.353"></a>
<FONT color="green">354</FONT>         * &lt;P&gt;<a name="line.354"></a>
<FONT color="green">355</FONT>         * In order to exclude Saturdays and Sundays it uses a baseTimeline that <a name="line.355"></a>
<FONT color="green">356</FONT>         * only includes Monday through Friday days.<a name="line.356"></a>
<FONT color="green">357</FONT>         * &lt;P&gt;<a name="line.357"></a>
<FONT color="green">358</FONT>         * The &lt;code&gt;startTime&lt;/code&gt; of the resulting timeline will be 9:00 AM <a name="line.358"></a>
<FONT color="green">359</FONT>         * after the startTime of the baseTimeline. This will correspond to 9:00 AM<a name="line.359"></a>
<FONT color="green">360</FONT>         * of the first Monday after 1/1/1900.<a name="line.360"></a>
<FONT color="green">361</FONT>         *<a name="line.361"></a>
<FONT color="green">362</FONT>         * @return A fully initialized SegmentedTimeline.<a name="line.362"></a>
<FONT color="green">363</FONT>         */<a name="line.363"></a>
<FONT color="green">364</FONT>        public static SegmentedTimeline newFifteenMinuteTimeline() {<a name="line.364"></a>
<FONT color="green">365</FONT>            SegmentedTimeline timeline <a name="line.365"></a>
<FONT color="green">366</FONT>                = new SegmentedTimeline(FIFTEEN_MINUTE_SEGMENT_SIZE, 28, 68);<a name="line.366"></a>
<FONT color="green">367</FONT>            timeline.setStartTime(<a name="line.367"></a>
<FONT color="green">368</FONT>                FIRST_MONDAY_AFTER_1900 + 36 * timeline.getSegmentSize()<a name="line.368"></a>
<FONT color="green">369</FONT>            );<a name="line.369"></a>
<FONT color="green">370</FONT>            timeline.setBaseTimeline(newMondayThroughFridayTimeline());<a name="line.370"></a>
<FONT color="green">371</FONT>            return timeline;<a name="line.371"></a>
<FONT color="green">372</FONT>        }<a name="line.372"></a>
<FONT color="green">373</FONT>        <a name="line.373"></a>
<FONT color="green">374</FONT>        /**<a name="line.374"></a>
<FONT color="green">375</FONT>         * Returns the flag that controls whether or not the daylight saving <a name="line.375"></a>
<FONT color="green">376</FONT>         * adjustment is applied.<a name="line.376"></a>
<FONT color="green">377</FONT>         * <a name="line.377"></a>
<FONT color="green">378</FONT>         * @return A boolean.<a name="line.378"></a>
<FONT color="green">379</FONT>         */<a name="line.379"></a>
<FONT color="green">380</FONT>        public boolean getAdjustForDaylightSaving() {<a name="line.380"></a>
<FONT color="green">381</FONT>            return this.adjustForDaylightSaving;   <a name="line.381"></a>
<FONT color="green">382</FONT>        }<a name="line.382"></a>
<FONT color="green">383</FONT>        <a name="line.383"></a>
<FONT color="green">384</FONT>        /**<a name="line.384"></a>
<FONT color="green">385</FONT>         * Sets the flag that controls whether or not the daylight saving adjustment<a name="line.385"></a>
<FONT color="green">386</FONT>         * is applied.<a name="line.386"></a>
<FONT color="green">387</FONT>         * <a name="line.387"></a>
<FONT color="green">388</FONT>         * @param adjust  the flag.<a name="line.388"></a>
<FONT color="green">389</FONT>         */<a name="line.389"></a>
<FONT color="green">390</FONT>        public void setAdjustForDaylightSaving(boolean adjust) {<a name="line.390"></a>
<FONT color="green">391</FONT>            this.adjustForDaylightSaving = adjust;   <a name="line.391"></a>
<FONT color="green">392</FONT>        }<a name="line.392"></a>
<FONT color="green">393</FONT>    <a name="line.393"></a>
<FONT color="green">394</FONT>        ////////////////////////////////////////////////////////////////////////////<a name="line.394"></a>
<FONT color="green">395</FONT>        // operations<a name="line.395"></a>
<FONT color="green">396</FONT>        ////////////////////////////////////////////////////////////////////////////<a name="line.396"></a>
<FONT color="green">397</FONT>    <a name="line.397"></a>
<FONT color="green">398</FONT>        /**<a name="line.398"></a>
<FONT color="green">399</FONT>         * Sets the start time for the timeline. This is the beginning of segment <a name="line.399"></a>
<FONT color="green">400</FONT>         * zero.<a name="line.400"></a>
<FONT color="green">401</FONT>         *<a name="line.401"></a>
<FONT color="green">402</FONT>         * @param millisecond  the start time (encoded as in java.util.Date).<a name="line.402"></a>
<FONT color="green">403</FONT>         */<a name="line.403"></a>
<FONT color="green">404</FONT>        public void setStartTime(long millisecond) {<a name="line.404"></a>
<FONT color="green">405</FONT>            this.startTime = millisecond;<a name="line.405"></a>
<FONT color="green">406</FONT>        }<a name="line.406"></a>
<FONT color="green">407</FONT>    <a name="line.407"></a>
<FONT color="green">408</FONT>        /**<a name="line.408"></a>
<FONT color="green">409</FONT>         * Returns the start time for the timeline. This is the beginning of <a name="line.409"></a>
<FONT color="green">410</FONT>         * segment zero.<a name="line.410"></a>
<FONT color="green">411</FONT>         * <a name="line.411"></a>