001: /* ===========================================================
002: * JFreeChart : a free chart library for the Java(tm) platform
003: * ===========================================================
004: *
005: * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
006: *
007: * Project Info: http://www.jfree.org/jfreechart/index.html
008: *
009: * This library is free software; you can redistribute it and/or modify it
010: * under the terms of the GNU Lesser General Public License as published by
011: * the Free Software Foundation; either version 2.1 of the License, or
012: * (at your option) any later version.
013: *
014: * This library is distributed in the hope that it will be useful, but
015: * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016: * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017: * License for more details.
018: *
019: * You should have received a copy of the GNU Lesser General Public
020: * License along with this library; if not, write to the Free Software
021: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
022: * USA.
023: *
024: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
025: * in the United States and other countries.]
026: *
027: * ---------------------
028: * XYIntervalSeries.java
029: * ---------------------
030: * (C) Copyright 2006, 2007, by Object Refinery Limited.
031: *
032: * Original Author: David Gilbert (for Object Refinery Limited);
033: * Contributor(s): -;
034: *
035: * $Id: XYIntervalSeries.java,v 1.1.2.3 2007/02/13 14:23:52 mungady Exp $
036: *
037: * Changes
038: * -------
039: * 20-Oct-2006 : Version 1 (DG);
040: * 13-Feb-2007 : Added several new accessor methods (DG);
041: *
042: */
043:
044: package org.jfree.data.xy;
045:
046: import org.jfree.data.ComparableObjectItem;
047: import org.jfree.data.ComparableObjectSeries;
048:
049: /**
050: * A list of (x, x-low, x-high, y, y-low, y-high) data items.
051: *
052: * @since 1.0.3
053: *
054: * @see XYIntervalSeriesCollection
055: */
056: public class XYIntervalSeries extends ComparableObjectSeries {
057:
058: /**
059: * Creates a new empty series. By default, items added to the series will
060: * be sorted into ascending order by x-value, and duplicate x-values will
061: * be allowed (these defaults can be modified with another constructor).
062: *
063: * @param key the series key (<code>null</code> not permitted).
064: */
065: public XYIntervalSeries(Comparable key) {
066: this (key, true, true);
067: }
068:
069: /**
070: * Constructs a new xy-series that contains no data. You can specify
071: * whether or not duplicate x-values are allowed for the series.
072: *
073: * @param key the series key (<code>null</code> not permitted).
074: * @param autoSort a flag that controls whether or not the items in the
075: * series are sorted.
076: * @param allowDuplicateXValues a flag that controls whether duplicate
077: * x-values are allowed.
078: */
079: public XYIntervalSeries(Comparable key, boolean autoSort,
080: boolean allowDuplicateXValues) {
081: super (key, autoSort, allowDuplicateXValues);
082: }
083:
084: /**
085: * Adds a data item to the series.
086: *
087: * @param x the x-value.
088: * @param xLow the lower bound of the x-interval.
089: * @param xHigh the upper bound of the x-interval.
090: * @param y the y-value.
091: * @param yLow the lower bound of the y-interval.
092: * @param yHigh the upper bound of the y-interval.
093: */
094: public void add(double x, double xLow, double xHigh, double y,
095: double yLow, double yHigh) {
096: super .add(
097: new XYIntervalDataItem(x, xLow, xHigh, y, yLow, yHigh),
098: true);
099: }
100:
101: /**
102: * Returns the x-value for the specified item.
103: *
104: * @param index the item index.
105: *
106: * @return The x-value (never <code>null</code>).
107: */
108: public Number getX(int index) {
109: XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
110: return item.getX();
111: }
112:
113: /**
114: * Returns the lower bound of the x-interval for the specified item in the
115: * series.
116: *
117: * @param index the item index.
118: *
119: * @return The lower bound of the x-interval.
120: *
121: * @since 1.0.5
122: */
123: public double getXLowValue(int index) {
124: XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
125: return item.getXLowValue();
126: }
127:
128: /**
129: * Returns the upper bound of the x-interval for the specified item in the
130: * series.
131: *
132: * @param index the item index.
133: *
134: * @return The upper bound of the x-interval.
135: *
136: * @since 1.0.5
137: */
138: public double getXHighValue(int index) {
139: XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
140: return item.getXHighValue();
141: }
142:
143: /**
144: * Returns the y-value for the specified item.
145: *
146: * @param index the item index.
147: *
148: * @return The y-value.
149: */
150: public double getYValue(int index) {
151: XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
152: return item.getYValue();
153: }
154:
155: /**
156: * Returns the lower bound of the Y-interval for the specified item in the
157: * series.
158: *
159: * @param index the item index.
160: *
161: * @return The lower bound of the Y-interval.
162: *
163: * @since 1.0.5
164: */
165: public double getYLowValue(int index) {
166: XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
167: return item.getYLowValue();
168: }
169:
170: /**
171: * Returns the upper bound of the y-interval for the specified item in the
172: * series.
173: *
174: * @param index the item index.
175: *
176: * @return The upper bound of the y-interval.
177: *
178: * @since 1.0.5
179: */
180: public double getYHighValue(int index) {
181: XYIntervalDataItem item = (XYIntervalDataItem) getDataItem(index);
182: return item.getYHighValue();
183: }
184:
185: /**
186: * Returns the data item at the specified index.
187: *
188: * @param index the item index.
189: *
190: * @return The data item.
191: */
192: public ComparableObjectItem getDataItem(int index) {
193: return super.getDataItem(index);
194: }
195:
196: }
|