extentindex.java

来自「openmap java写的开源数字地图程序. 用applet实现,可以像g」· Java 代码 · 共 65 行

/*
 *                     RESTRICTED RIGHTS LEGEND
 *
 *                        BBNT Solutions LLC
 *                        A Verizon Company
 *                        10 Moulton Street
 *                       Cambridge, MA 02138
 *                         [phone]
 *
 * Copyright BBNT Solutions LLC 2005 All Rights Reserved
 * 
 */

package com.bbn.openmap.geo;

import java.util.Iterator;

/**
 * A Collection of Regions that supports indexed subsets. That is, in
 * addition to acting like a normal collection, it also allows getting
 * an iterator that will return a superset of all intersecting regions
 * that is a subset of the whole collection.
 * 
 * @author [e-mail]
 */
public interface ExtentIndex extends java.util.Collection {
    /**
     * report on the maximum horizontalRange supported by this index.
     */
    double indexHorizontalRange();
    
    /**
     * Add a extent to the index.
     * @param region
     * @return true if Region successfully added, false if not.
     */
    boolean addExtent(GeoExtent region);
    
    /**
     * Remove a region from the index.
     * @param region
     * @return true if the region was found and removed.
     */
    boolean removeExtent(GeoExtent region);
    
    /**
     * Resets the index to an empty state. 
     */
    void clear();

    /**
     * return an iterator listing a subset of the whole collection
     * that is a superset of the actual matches. A valid (but
     * inefficient) implementation would return an iterator over the
     * whole collection.
     * 
     * Implementation should match anything that is likely to match -
     * this will generally include, for instance, additional space
     * around the actual segment to accommodate buffer zones around
     * the segment.
     */
    Iterator iterator(GeoExtent extent);

}