Package org.geotools.feature

Interface FeatureIndex

All Superinterfaces:
CollectionListener
public interface FeatureIndex extends CollectionListener
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, Ian Schneider

  • Method Details

    • getFeatures

      Iterator getFeatures()
      Gets an "in order" Iterator of the Features as indexed.
      Returns:
      An Iterator of the Features within this index.

    • find

      Collection find(Object key) throws IllegalArgumentException
      Find all the Features within this index using a key.
      Parameters:
      key - A key to look up the Features with.
      Returns:
      A java.util.Collection containing the matches. May be empty.
      Throws:
      IllegalArgumentException - If the key is incompatable with this index.

    • findFirst

      SimpleFeature findFirst(Object key) throws IllegalArgumentException
      Find the first Feature using the given key.
      Parameters:
      key - A key to look up the Feature with.
      Returns:
      A Feature, or null if none is found.
      Throws:
      IllegalArgumentException - If the key is incompatable with this index.