Frames | No Frames |
1: /* =========================================================== 2: * JFreeChart : a free chart library for the Java(tm) platform 3: * =========================================================== 4: * 5: * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors. 6: * 7: * Project Info: http://www.jfree.org/jfreechart/index.html 8: * 9: * This library is free software; you can redistribute it and/or modify it 10: * under the terms of the GNU Lesser General Public License as published by 11: * the Free Software Foundation; either version 2.1 of the License, or 12: * (at your option) any later version. 13: * 14: * This library is distributed in the hope that it will be useful, but 15: * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 16: * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 17: * License for more details. 18: * 19: * You should have received a copy of the GNU Lesser General Public 20: * License along with this library; if not, write to the Free Software 21: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 22: * USA. 23: * 24: * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 25: * in the United States and other countries.] 26: * 27: * ----------------------------- 28: * StandardEntityCollection.java 29: * ----------------------------- 30: * (C) Copyright 2001-2007, by Object Refinery Limited. 31: * 32: * Original Author: David Gilbert (for Object Refinery Limited); 33: * Contributor(s): -; 34: * 35: * Changes 36: * ------- 37: * 23-May-2002 : Version 1 (DG); 38: * 26-Jun-2002 : Added iterator() method (DG); 39: * 03-Oct-2002 : Fixed errors reported by Checkstyle (DG); 40: * 19-May-2004 : Implemented Serializable (DG); 41: * 29-Sep-2004 : Renamed addEntity() --> add() and addEntities() 42: * --> addAll() (DG); 43: * 19-Jan-2005 : Changed storage from Collection --> List (DG); 44: * 20-May-2005 : Fixed bug 1113521 - inefficiency in getEntity() method (DG); 45: * ------------- JFREECHART 1.0.x --------------------------------------------- 46: * 01-Dec-2006 : Implemented PublicCloneable and fixed clone() method (DG); 47: * 48: */ 49: 50: package org.jfree.chart.entity; 51: 52: import java.io.Serializable; 53: import java.util.Collection; 54: import java.util.Collections; 55: import java.util.Iterator; 56: import java.util.List; 57: 58: import org.jfree.util.ObjectUtilities; 59: import org.jfree.util.PublicCloneable; 60: 61: /** 62: * A standard implementation of the {@link EntityCollection} interface. 63: */ 64: public class StandardEntityCollection implements EntityCollection, 65: Cloneable, PublicCloneable, Serializable { 66: 67: /** For serialization. */ 68: private static final long serialVersionUID = 5384773031184897047L; 69: 70: /** Storage for the entities. */ 71: private List entities; 72: 73: /** 74: * Constructs a new entity collection (initially empty). 75: */ 76: public StandardEntityCollection() { 77: this.entities = new java.util.ArrayList(); 78: } 79: 80: /** 81: * Returns the number of entities in the collection. 82: * 83: * @return The entity count. 84: */ 85: public int getEntityCount() { 86: return this.entities.size(); 87: } 88: 89: /** 90: * Returns a chart entity from the collection. 91: * 92: * @param index the entity index. 93: * 94: * @return The entity. 95: * 96: * @see #add(ChartEntity) 97: */ 98: public ChartEntity getEntity(int index) { 99: return (ChartEntity) this.entities.get(index); 100: } 101: 102: /** 103: * Clears all the entities from the collection. 104: */ 105: public void clear() { 106: this.entities.clear(); 107: } 108: 109: /** 110: * Adds an entity to the collection. 111: * 112: * @param entity the entity (<code>null</code> not permitted). 113: */ 114: public void add(ChartEntity entity) { 115: if (entity == null) { 116: throw new IllegalArgumentException("Null 'entity' argument."); 117: } 118: this.entities.add(entity); 119: } 120: 121: /** 122: * Adds all the entities from the specified collection. 123: * 124: * @param collection the collection of entities (<code>null</code> not 125: * permitted). 126: */ 127: public void addAll(EntityCollection collection) { 128: this.entities.addAll(collection.getEntities()); 129: } 130: 131: /** 132: * Returns the last entity in the list with an area that encloses the 133: * specified coordinates, or <code>null</code> if there is no such entity. 134: * 135: * @param x the x coordinate. 136: * @param y the y coordinate. 137: * 138: * @return The entity (possibly <code>null</code>). 139: */ 140: public ChartEntity getEntity(double x, double y) { 141: int entityCount = this.entities.size(); 142: for (int i = entityCount - 1; i >= 0; i--) { 143: ChartEntity entity = (ChartEntity) this.entities.get(i); 144: if (entity.getArea().contains(x, y)) { 145: return entity; 146: } 147: } 148: return null; 149: } 150: 151: /** 152: * Returns the entities in an unmodifiable collection. 153: * 154: * @return The entities. 155: */ 156: public Collection getEntities() { 157: return Collections.unmodifiableCollection(this.entities); 158: } 159: 160: /** 161: * Returns an iterator for the entities in the collection. 162: * 163: * @return An iterator. 164: */ 165: public Iterator iterator() { 166: return this.entities.iterator(); 167: } 168: 169: /** 170: * Tests this object for equality with an arbitrary object. 171: * 172: * @param obj the object to test against (<code>null</code> permitted). 173: * 174: * @return A boolean. 175: */ 176: public boolean equals(Object obj) { 177: if (obj == this) { 178: return true; 179: } 180: if (obj instanceof StandardEntityCollection) { 181: StandardEntityCollection that = (StandardEntityCollection) obj; 182: return ObjectUtilities.equal(this.entities, that.entities); 183: } 184: return false; 185: } 186: 187: /** 188: * Returns a clone of this entity collection. 189: * 190: * @return A clone. 191: * 192: * @throws CloneNotSupportedException if the object cannot be cloned. 193: */ 194: public Object clone() throws CloneNotSupportedException { 195: StandardEntityCollection clone 196: = (StandardEntityCollection) super.clone(); 197: clone.entities = new java.util.ArrayList(this.entities.size()); 198: for (int i = 0; i < this.entities.size(); i++) { 199: ChartEntity entity = (ChartEntity) this.entities.get(i); 200: clone.entities.add(entity.clone()); 201: } 202: return clone; 203: } 204: 205: }