001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2020, 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 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * -----------------------------
028 * StandardEntityCollection.java
029 * -----------------------------
030 * (C) Copyright 2001-2016, by Object Refinery Limited.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 * Changes
036 * -------
037 * 23-May-2002 : Version 1 (DG);
038 * 26-Jun-2002 : Added iterator() method (DG);
039 * 03-Oct-2002 : Fixed errors reported by Checkstyle (DG);
040 * 19-May-2004 : Implemented Serializable (DG);
041 * 29-Sep-2004 : Renamed addEntity() --> add() and addEntities()
042 *               --> addAll() (DG);
043 * 19-Jan-2005 : Changed storage from Collection --> List (DG);
044 * 20-May-2005 : Fixed bug 1113521 - inefficiency in getEntity() method (DG);
045 * ------------- JFREECHART 1.0.x ---------------------------------------------
046 * 01-Dec-2006 : Implemented PublicCloneable and fixed clone() method (DG);
047 * 02-Jul-2013 : Use ParamChecks (DG);
048 *
049 */
050
051package org.jfree.chart.entity;
052
053import java.io.Serializable;
054import java.util.Collection;
055import java.util.Collections;
056import java.util.Iterator;
057import java.util.List;
058import org.jfree.chart.util.ObjectUtils;
059import org.jfree.chart.util.Args;
060import org.jfree.chart.util.PublicCloneable;
061
062/**
063 * A standard implementation of the {@link EntityCollection} interface.
064 */
065public class StandardEntityCollection implements EntityCollection,
066        Cloneable, PublicCloneable, Serializable {
067
068    /** For serialization. */
069    private static final long serialVersionUID = 5384773031184897047L;
070
071    /** Storage for the entities. */
072    private List entities;
073
074    /**
075     * Constructs a new entity collection (initially empty).
076     */
077    public StandardEntityCollection() {
078        this.entities = new java.util.ArrayList();
079    }
080
081    /**
082     * Returns the number of entities in the collection.
083     *
084     * @return The entity count.
085     */
086    @Override
087    public int getEntityCount() {
088        return this.entities.size();
089    }
090
091    /**
092     * Returns a chart entity from the collection.
093     *
094     * @param index  the entity index.
095     *
096     * @return The entity.
097     *
098     * @see #add(ChartEntity)
099     */
100    @Override
101    public ChartEntity getEntity(int index) {
102        return (ChartEntity) this.entities.get(index);
103    }
104
105    /**
106     * Clears all the entities from the collection.
107     */
108    @Override
109    public void clear() {
110        this.entities.clear();
111    }
112
113    /**
114     * Adds an entity to the collection.
115     *
116     * @param entity  the entity ({@code null} not permitted).
117     */
118    @Override
119    public void add(ChartEntity entity) {
120        Args.nullNotPermitted(entity, "entity");
121        this.entities.add(entity);
122    }
123
124    /**
125     * Adds all the entities from the specified collection.
126     *
127     * @param collection  the collection of entities ({@code null} not
128     *     permitted).
129     */
130    @Override
131    public void addAll(EntityCollection collection) {
132        this.entities.addAll(collection.getEntities());
133    }
134
135    /**
136     * Returns the last entity in the list with an area that encloses the
137     * specified coordinates, or {@code null} if there is no such entity.
138     *
139     * @param x  the x coordinate.
140     * @param y  the y coordinate.
141     *
142     * @return The entity (possibly {@code null}).
143     */
144    @Override
145    public ChartEntity getEntity(double x, double y) {
146        int entityCount = this.entities.size();
147        for (int i = entityCount - 1; i >= 0; i--) {
148            ChartEntity entity = (ChartEntity) this.entities.get(i);
149            if (entity.getArea().contains(x, y)) {
150                return entity;
151            }
152        }
153        return null;
154    }
155
156    /**
157     * Returns the entities in an unmodifiable collection.
158     *
159     * @return The entities.
160     */
161    @Override
162    public Collection getEntities() {
163        return Collections.unmodifiableCollection(this.entities);
164    }
165
166    /**
167     * Returns an iterator for the entities in the collection.
168     *
169     * @return An iterator.
170     */
171    @Override
172    public Iterator iterator() {
173        return this.entities.iterator();
174    }
175
176    /**
177     * Tests this object for equality with an arbitrary object.
178     *
179     * @param obj  the object to test against ({@code null} permitted).
180     *
181     * @return A boolean.
182     */
183    @Override
184    public boolean equals(Object obj) {
185        if (obj == this) {
186            return true;
187        }
188        if (obj instanceof StandardEntityCollection) {
189            StandardEntityCollection that = (StandardEntityCollection) obj;
190            return ObjectUtils.equal(this.entities, that.entities);
191        }
192        return false;
193    }
194
195    /**
196     * Returns a clone of this entity collection.
197     *
198     * @return A clone.
199     *
200     * @throws CloneNotSupportedException if the object cannot be cloned.
201     */
202    @Override
203    public Object clone() throws CloneNotSupportedException {
204        StandardEntityCollection clone
205                = (StandardEntityCollection) super.clone();
206        clone.entities = new java.util.ArrayList(this.entities.size());
207        for (int i = 0; i < this.entities.size(); i++) {
208            ChartEntity entity = (ChartEntity) this.entities.get(i);
209            clone.entities.add(entity.clone());
210        }
211        return clone;
212    }
213
214}