cytoscape.geom.spacial
Interface MutableSpacialIndex2D

All Superinterfaces:

SpacialIndex2D

All Known Implementing Classes:

RTree

public interface MutableSpacialIndex2D
extends SpacialIndex2D

A spacial index for objects in two dimensions, with support for insertions and deletions.

Method Summary

boolean	delete(int objKey) Deletes the specified data entry from this structure.
void	empty() Empties this structure of all entries.
void	insert(int objKey, float xMin, float yMin, float xMax, float yMax) Inserts a new data entry into this structure; the entry's extents are specified by the input parameters.

Methods inherited from interface cytoscape.geom.spacial.SpacialIndex2D

exists, queryOverlap, size

Method Detail

empty

void empty()

Empties this structure of all entries.

insert

void insert(int objKey,
            float xMin,
            float yMin,
            float xMax,
            float yMax)

Inserts a new data entry into this structure; the entry's extents are specified by the input parameters. "Extents" is a short way of saying "minimum bounding rectangle". The minimum bounding rectangle of an entry is axis-aligned, meaning that its sides are parallel to the axes of the data space.

Parameters:

objKey - a user-defined unique identifier used to refer to the entry being inserted in later operations; this identifier must be non-negative.

xMin - the minimum X coordinate of the entry's extents rectangle.

yMin - the minimum Y coordinate of the entry's extents rectangle.

xMax - the maximum X coordinate of the entry's extents rectangle.

yMax - the maximum Y coordinate of the entry's extents rectangle.

Throws:

IllegalStateException - if objKey is already used for an existing entry in this structure.

IllegalArgumentException - if objKey is negative, if xMin is not less than or equal to xMax, or if yMin is not less than or equal to yMax.

delete

boolean delete(int objKey)

Deletes the specified data entry from this structure.

Parameters:

objKey - a user-defined identifier that was potentially used in a previous insertion.

Returns:

true if and only if objKey existed in this structure prior to this method invocation.