org.geotools.feature.FeatureIndex Maven / Gradle / Ivy
/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2002-2008, Open Source Geospatial Foundation (OSGeo)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package org.geotools.feature;
import org.opengis.feature.simple.SimpleFeature;
/**
* An Index is built up around a FeatureCollection, using one of the attributes in the
* SimpleFeatureCollection as a comparable reference.
*
* An object in a column can be any object, but must either be a java base-type Object (Integer,
* String, Character, etc.) or implement Comparable.
*
*
An Index built on such a column will sort its array of object references using
* FeatureComparator. Implement this to perform more complex Index building.
*
* @author Ray Gallagher
* @author Ian Schneider
* @version $Id$
*/
public interface FeatureIndex extends CollectionListener {
/**
* Gets an "in order" Iterator of the Features as indexed.
*
* @return An Iterator of the Features within this index.
*/
java.util.Iterator getFeatures();
/**
* Find all the Features within this index using a key.
*
* @return A java.util.Collection containing the matches. May be empty.
* @throws IllegalArgumentException If the key is incompatable with this index.
* @param key A key to look up the Features with.
*/
java.util.Collection find(Object key) throws IllegalArgumentException;
/**
* Find the first Feature using the given key.
*
* @return A Feature, or null if none is found.
* @throws IllegalArgumentException If the key is incompatable with this index.
* @param key A key to look up the Feature with.
*/
SimpleFeature findFirst(Object key) throws IllegalArgumentException;
}