org.jfree.chart.entity
Interface EntityCollection

All Known Implementing Classes:
StandardEntityCollection

public interface EntityCollection

Defines the methods that a collection of entities is required to implement.


Method Summary
 void addEntities(EntityCollection collection)
          Adds the entities from another collection to this collection.
 void addEntity(ChartEntity entity)
          Adds an entity to the collection.
 void clear()
          Clears all entities.
 java.util.Collection getEntities()
          Returns the entities in an unmodifiable collection.
 ChartEntity getEntity(double x, double y)
          Returns an entity whose area contains the specified point.
 java.util.Iterator iterator()
          Returns an iterator for the entities in the collection.
 

Method Detail

clear

public void clear()
Clears all entities.


addEntity

public void addEntity(ChartEntity entity)
Adds an entity to the collection.

Parameters:
entity - the entity.

addEntities

public void addEntities(EntityCollection collection)
Adds the entities from another collection to this collection.

Parameters:
collection - the other collection.

getEntity

public ChartEntity getEntity(double x,
                             double y)
Returns an entity whose area contains the specified point.

Parameters:
x - the x coordinate.
y - the y coordinate.
Returns:
The entity.

getEntities

public java.util.Collection getEntities()
Returns the entities in an unmodifiable collection.

Returns:
The entities.

iterator

public java.util.Iterator iterator()
Returns an iterator for the entities in the collection.

Returns:
An iterator.