timeseries.html

jfreechart1。0。2的api。

<FONT color="green">282</FONT>         * Sets the number of time units in the 'history' for the series.  This <a name="line.282"></a>
<FONT color="green">283</FONT>         * provides one mechanism for automatically dropping old data from the<a name="line.283"></a>
<FONT color="green">284</FONT>         * time series. For example, if a series contains daily data, you might set<a name="line.284"></a>
<FONT color="green">285</FONT>         * the history count to 30.  Then, when you add a new data item, all data<a name="line.285"></a>
<FONT color="green">286</FONT>         * items more than 30 days older than the latest value are automatically <a name="line.286"></a>
<FONT color="green">287</FONT>         * dropped from the series.<a name="line.287"></a>
<FONT color="green">288</FONT>         *<a name="line.288"></a>
<FONT color="green">289</FONT>         * @param periods  the number of time periods.<a name="line.289"></a>
<FONT color="green">290</FONT>         * <a name="line.290"></a>
<FONT color="green">291</FONT>         * @see #getMaximumItemAge()<a name="line.291"></a>
<FONT color="green">292</FONT>         */<a name="line.292"></a>
<FONT color="green">293</FONT>        public void setMaximumItemAge(long periods) {<a name="line.293"></a>
<FONT color="green">294</FONT>            if (periods &lt; 0) {<a name="line.294"></a>
<FONT color="green">295</FONT>                throw new IllegalArgumentException("Negative 'periods' argument.");<a name="line.295"></a>
<FONT color="green">296</FONT>            }<a name="line.296"></a>
<FONT color="green">297</FONT>            this.maximumItemAge = periods;<a name="line.297"></a>
<FONT color="green">298</FONT>            removeAgedItems(true);  // remove old items and notify if necessary<a name="line.298"></a>
<FONT color="green">299</FONT>        }<a name="line.299"></a>
<FONT color="green">300</FONT>    <a name="line.300"></a>
<FONT color="green">301</FONT>        /**<a name="line.301"></a>
<FONT color="green">302</FONT>         * Returns the time period class for this series.<a name="line.302"></a>
<FONT color="green">303</FONT>         * &lt;p&gt;<a name="line.303"></a>
<FONT color="green">304</FONT>         * Only one time period class can be used within a single series (enforced).<a name="line.304"></a>
<FONT color="green">305</FONT>         * If you add a data item with a {@link Year} for the time period, then all<a name="line.305"></a>
<FONT color="green">306</FONT>         * subsequent data items must also have a {@link Year} for the time period.<a name="line.306"></a>
<FONT color="green">307</FONT>         *<a name="line.307"></a>
<FONT color="green">308</FONT>         * @return The time period class (never &lt;code&gt;null&lt;/code&gt;).<a name="line.308"></a>
<FONT color="green">309</FONT>         */<a name="line.309"></a>
<FONT color="green">310</FONT>        public Class getTimePeriodClass() {<a name="line.310"></a>
<FONT color="green">311</FONT>            return this.timePeriodClass;<a name="line.311"></a>
<FONT color="green">312</FONT>        }<a name="line.312"></a>
<FONT color="green">313</FONT>    <a name="line.313"></a>
<FONT color="green">314</FONT>        /**<a name="line.314"></a>
<FONT color="green">315</FONT>         * Returns a data item for the series.<a name="line.315"></a>
<FONT color="green">316</FONT>         *<a name="line.316"></a>
<FONT color="green">317</FONT>         * @param index  the item index (zero-based).<a name="line.317"></a>
<FONT color="green">318</FONT>         *<a name="line.318"></a>
<FONT color="green">319</FONT>         * @return The data item.<a name="line.319"></a>
<FONT color="green">320</FONT>         * <a name="line.320"></a>
<FONT color="green">321</FONT>         * @see #getDataItem(RegularTimePeriod)<a name="line.321"></a>
<FONT color="green">322</FONT>         */<a name="line.322"></a>
<FONT color="green">323</FONT>        public TimeSeriesDataItem getDataItem(int index) {<a name="line.323"></a>
<FONT color="green">324</FONT>            return (TimeSeriesDataItem) this.data.get(index);<a name="line.324"></a>
<FONT color="green">325</FONT>        }<a name="line.325"></a>
<FONT color="green">326</FONT>    <a name="line.326"></a>
<FONT color="green">327</FONT>        /**<a name="line.327"></a>
<FONT color="green">328</FONT>         * Returns the data item for a specific period.<a name="line.328"></a>
<FONT color="green">329</FONT>         *<a name="line.329"></a>
<FONT color="green">330</FONT>         * @param period  the period of interest (&lt;code&gt;null&lt;/code&gt; not allowed).<a name="line.330"></a>
<FONT color="green">331</FONT>         *<a name="line.331"></a>
<FONT color="green">332</FONT>         * @return The data item matching the specified period (or <a name="line.332"></a>
<FONT color="green">333</FONT>         *         &lt;code&gt;null&lt;/code&gt; if there is no match).<a name="line.333"></a>
<FONT color="green">334</FONT>         *<a name="line.334"></a>
<FONT color="green">335</FONT>         * @see #getDataItem(int)<a name="line.335"></a>
<FONT color="green">336</FONT>         */<a name="line.336"></a>
<FONT color="green">337</FONT>        public TimeSeriesDataItem getDataItem(RegularTimePeriod period) {<a name="line.337"></a>
<FONT color="green">338</FONT>            if (period == null) {<a name="line.338"></a>
<FONT color="green">339</FONT>                throw new IllegalArgumentException("Null 'period' argument");<a name="line.339"></a>
<FONT color="green">340</FONT>            }<a name="line.340"></a>
<FONT color="green">341</FONT>            TimeSeriesDataItem dummy = new TimeSeriesDataItem(period, <a name="line.341"></a>
<FONT color="green">342</FONT>                    Integer.MIN_VALUE);<a name="line.342"></a>
<FONT color="green">343</FONT>            int index = Collections.binarySearch(this.data, dummy);<a name="line.343"></a>
<FONT color="green">344</FONT>            if (index &gt;= 0) {<a name="line.344"></a>
<FONT color="green">345</FONT>                return (TimeSeriesDataItem) this.data.get(index);<a name="line.345"></a>
<FONT color="green">346</FONT>            }<a name="line.346"></a>
<FONT color="green">347</FONT>            else {<a name="line.347"></a>
<FONT color="green">348</FONT>                return null;<a name="line.348"></a>
<FONT color="green">349</FONT>            }<a name="line.349"></a>
<FONT color="green">350</FONT>        }<a name="line.350"></a>
<FONT color="green">351</FONT>    <a name="line.351"></a>
<FONT color="green">352</FONT>        /**<a name="line.352"></a>
<FONT color="green">353</FONT>         * Returns the time period at the specified index.<a name="line.353"></a>
<FONT color="green">354</FONT>         *<a name="line.354"></a>
<FONT color="green">355</FONT>         * @param index  the index of the data item.<a name="line.355"></a>
<FONT color="green">356</FONT>         *<a name="line.356"></a>
<FONT color="green">357</FONT>         * @return The time period.<a name="line.357"></a>
<FONT color="green">358</FONT>         */<a name="line.358"></a>
<FONT color="green">359</FONT>        public RegularTimePeriod getTimePeriod(int index) {<a name="line.359"></a>
<FONT color="green">360</FONT>            return getDataItem(index).getPeriod();<a name="line.360"></a>
<FONT color="green">361</FONT>        }<a name="line.361"></a>
<FONT color="green">362</FONT>    <a name="line.362"></a>
<FONT color="green">363</FONT>        /**<a name="line.363"></a>
<FONT color="green">364</FONT>         * Returns a time period that would be the next in sequence on the end of<a name="line.364"></a>
<FONT color="green">365</FONT>         * the time series.<a name="line.365"></a>
<FONT color="green">366</FONT>         *<a name="line.366"></a>
<FONT color="green">367</FONT>         * @return The next time period.<a name="line.367"></a>
<FONT color="green">368</FONT>         */<a name="line.368"></a>
<FONT color="green">369</FONT>        public RegularTimePeriod getNextTimePeriod() {<a name="line.369"></a>
<FONT color="green">370</FONT>            RegularTimePeriod last = getTimePeriod(getItemCount() - 1);<a name="line.370"></a>
<FONT color="green">371</FONT>            return last.next();<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 a collection of all the time periods in the time series.<a name="line.375"></a>
<FONT color="green">376</FONT>         *<a name="line.376"></a>
<FONT color="green">377</FONT>         * @return A collection of all the time periods.<a name="line.377"></a>
<FONT color="green">378</FONT>         */<a name="line.378"></a>
<FONT color="green">379</FONT>        public Collection getTimePeriods() {<a name="line.379"></a>
<FONT color="green">380</FONT>            Collection result = new java.util.ArrayList();<a name="line.380"></a>
<FONT color="green">381</FONT>            for (int i = 0; i &lt; getItemCount(); i++) {<a name="line.381"></a>
<FONT color="green">382</FONT>                result.add(getTimePeriod(i));<a name="line.382"></a>
<FONT color="green">383</FONT>            }<a name="line.383"></a>
<FONT color="green">384</FONT>            return result;<a name="line.384"></a>
<FONT color="green">385</FONT>        }<a name="line.385"></a>
<FONT color="green">386</FONT>    <a name="line.386"></a>
<FONT color="green">387</FONT>        /**<a name="line.387"></a>
<FONT color="green">388</FONT>         * Returns a collection of time periods in the specified series, but not in<a name="line.388"></a>
<FONT color="green">389</FONT>         * this series, and therefore unique to the specified series.<a name="line.389"></a>
<FONT color="green">390</FONT>         *<a name="line.390"></a>
<FONT color="green">391</FONT>         * @param series  the series to check against this one.<a name="line.391"></a>
<FONT color="green">392</FONT>         *<a name="line.392"></a>
<FONT color="green">393</FONT>         * @return The unique time periods.<a name="line.393"></a>
<FONT color="green">394</FONT>         */<a name="line.394"></a>
<FONT color="green">395</FONT>        public Collection getTimePeriodsUniqueToOtherSeries(TimeSeries series) {<a name="line.395"></a>
<FONT color="green">396</FONT>    <a name="line.396"></a>
<FONT color="green">397</FONT>            Collection result = new java.util.ArrayList();<a name="line.397"></a>
<FONT color="green">398</FONT>            for (int i = 0; i &lt; series.getItemCount(); i++) {<a name="line.398"></a>
<FONT color="green">399</FONT>                RegularTimePeriod period = series.getTimePeriod(i);<a name="line.399"></a>
<FONT color="green">400</FONT>                int index = getIndex(period);<a name="line.400"></a>
<FONT color="green">401</FONT>                if (index &lt; 0) {<a name="line.401"></a>
<FONT color="green">402</FONT>                    result.add(period);<a name="line.402"></a>
<FONT color="green">403</FONT>                }<a name="line.403"></a>
<FONT color="green">404</FONT>            }<a name="line.404"></a>
<FONT color="green">405</FONT>            return result;<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>        /**<a name="line.409"></a>
<FONT color="green">410</FONT>         * Returns the index for the item (if any) that corresponds to a time <a name="line.410"></a>
<FONT color="green">411</FONT>         * period.<a name="line.411"></a>
<FONT color="green">412</FONT>         *<a name="line.412"></a>
<FONT color="green">413</FONT>         * @param period  the time period (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.413"></a>
<FONT color="green">414</FONT>         *<a name="line.414"></a>
<FONT color="green">415</FONT>         * @return The index.<a name="line.415"></a>
<FONT color="green">416</FONT>         */<a name="line.416"></a>
<FONT color="green">417</FONT>        public int getIndex(RegularTimePeriod period) {<a name="line.417"></a>
<FONT color="green">418</FONT>            if (period == null) {<a name="line.418"></a>
<FONT color="green">419</FONT>                throw new IllegalArgumentException("Null 'period' argument.");<a name="line.419"></a>
<FONT color="green">420</FONT>            } <a name="line.420"></a>
<FONT color="green">421</FONT>            TimeSeriesDataItem dummy = new TimeSeriesDataItem(<a name="line.421"></a>
<FONT color="green">422</FONT>                  period, Integer.MIN_VALUE);<a name="line.422"></a>
<FONT color="green">423</FONT>            return Collections.binarySearch(this.data, dummy);<a name="line.423"></a>