SpatialIndexFeatureCollection (Geotools modules 23-SNAPSHOT API)

Object
- SpatialIndexFeatureCollection

All Implemented Interfaces:

SimpleFeatureCollection, FeatureCollection<SimpleFeatureType,SimpleFeature>
```
public class SpatialIndexFeatureCollection
extends Object
implements SimpleFeatureCollection
```
FeatureCollection used to stage information for display using a SpatialIndex.
Please note that this feature collection cannot be modified after the spatial index is created.

Author:

Jody

Field Summary

Fields
Modifier and Type	Field and Description
`protected STRtree`	`index` SpatialIndex holding the contents of the FeatureCollection
`protected List<CollectionListener>`	`listeners` Listeners
`protected SimpleFeatureType`	`schema`

Constructor Summary

Constructors
Constructor and Description
`SpatialIndexFeatureCollection()`
`SpatialIndexFeatureCollection(SimpleFeatureCollection copy)`
`SpatialIndexFeatureCollection(SimpleFeatureType schema)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accepts(FeatureVisitor visitor, ProgressListener listener)` Visit the contents of a feature collection.
`boolean`	`add(SimpleFeature feature)`
`boolean`	`addAll(Collection<? extends SimpleFeature> collection)`
`boolean`	`addAll(FeatureCollection<? extends SimpleFeatureType,? extends SimpleFeature> collection)`
`void`	`addListener(CollectionListener listener)`
`void`	`clear()`
`void`	`close(FeatureIterator<SimpleFeature> close)`
`void`	`close(Iterator<SimpleFeature> close)`
`boolean`	`contains(Object obj)`
`boolean`	`containsAll(Collection<?> collection)`
`SimpleFeatureIterator`	`features()` Obtain a SimpleFeatureIterator of the Features within this SimpleFeatureCollection.
`protected void`	`fire(SimpleFeature[] features, int eventType)`
`ReferencedEnvelope`	`getBounds()` Get the total bounds of this collection which is calculated by doing a union of the bounds of each feature inside of it
`String`	`getID()` ID used when serializing to GML
`SimpleFeatureType`	`getSchema()` The schema for the child feature members of this collection.
`boolean`	`isEmpty()` Returns `true` if this feature collection contains no features.
`Iterator<SimpleFeature>`	`iterator()`
`void`	`purge()`
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> c)`
`void`	`removeListener(CollectionListener listener)`
`boolean`	`retainAll(Collection<?> c)`
`int`	`size()` Will build the STRtree index if required.
`SimpleFeatureCollection`	`sort(SortBy order)` Obtained sorted contents.
`SimpleFeatureCollection`	`subCollection(Filter filter)` SimpleFeatureCollection "view" indicated by provided filter.
`Object[]`	`toArray()`
`<O> O[]`	`toArray(O[] array)`

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - index
```
protected STRtree index
```
    SpatialIndex holding the contents of the FeatureCollection
  - schema
```
protected SimpleFeatureType schema
```
  - listeners
```
protected List<CollectionListener> listeners
```
    Listeners
- Constructor Detail
  - SpatialIndexFeatureCollection
```
public SpatialIndexFeatureCollection()
```
  - SpatialIndexFeatureCollection
```
public SpatialIndexFeatureCollection(SimpleFeatureType schema)
```
  - SpatialIndexFeatureCollection
```
public SpatialIndexFeatureCollection(SimpleFeatureCollection copy)
                              throws IOException
```
    Throws:
    
    IOException
- Method Detail
  - addListener
```
public void addListener(CollectionListener listener)
                 throws NullPointerException
```
    Throws:
    
    NullPointerException
  - removeListener
```
public void removeListener(CollectionListener listener)
                    throws NullPointerException
```
    Throws:
    
    NullPointerException
  - fire
```
protected void fire(SimpleFeature[] features,
                    int eventType)
```
  - features
```
public SimpleFeatureIterator features()
```
    Description copied from interface: SimpleFeatureCollection
    Obtain a SimpleFeatureIterator of the Features within this SimpleFeatureCollection.
    The implementation of FeatureIterator must adhere to the rules of fail-fast concurrent modification. In addition (to allow for resource backed collections) the SimpleFeatureIterator.close() method must be called.
    Example use:
```
 SimpleFeatureIterator iterator=collection.features();
 try {
     while( iterator.hasNext()  ){
          SimpleFeature feature = iterator.next();
          System.out.println( feature.getID() );
     }
 }
 finally {
     iterator.close();
 }
 
```
    Specified by:
    
    features in interface SimpleFeatureCollection
    
    Specified by:
    
    features in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Returns:
    
    A FeatureIterator.
  - sort
```
public SimpleFeatureCollection sort(SortBy order)
```
    Description copied from interface: FeatureCollection
    
    Obtained sorted contents.
    This method may not be supported by all implementations, consider the use of FeatureSource.features( Query ).
    
    Specified by:
    
    sort in interface SimpleFeatureCollection
    
    Specified by:
    
    sort in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Parameters:
    
    order - Sort order
    
    Returns:
    
    FeatureCollection sorted in the indicated order
  - subCollection
```
public SimpleFeatureCollection subCollection(Filter filter)
```
    Description copied from interface: FeatureCollection
    SimpleFeatureCollection "view" indicated by provided filter.
    The contents of the returned SimpleFeatureCollection are determined by applying the provider Filter to the entire contents of this FeatureCollection. The result is "live" and modifications will be shared.
    This method is used cut down on the number of filter based methods required for a useful SimpleFeatureCollection construct. The FeatureCollections returned really should be considered as a temporary "view" used to control the range of a removeAll, or modify operation.
    Example Use:
```
 collection.subCollection( filter ).clear();
 
```
    The above recommended use is agreement with the Collections API precident of List.subList( start, end ).
    The results of subCollection:
    - are to be considered unordered
    - may be an ordered FeatureList if requested when sortBy is indicated
    Specified by:
    
    subCollection in interface SimpleFeatureCollection
    
    Specified by:
    
    subCollection in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Returns:
    
    SimpleFeatureCollection identified as subset.
    
    See Also:
    
    FeatureList
  - accepts
```
public void accepts(FeatureVisitor visitor,
                    ProgressListener listener)
             throws IOException
```
    Description copied from interface: FeatureCollection
    
    Visit the contents of a feature collection.
    The order of traversal is dependent on the FeatureCollection implementation; some collections are able to make efficient use of an internal index in order to quickly visit features located in the same region.
    
    Specified by:
    
    accepts in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Parameters:
    
    visitor - Closure applied to each feature in turn.
    
    listener - Used to report progress, may be used to interrupt the operation
    
    Throws:
    
    IOException
  - add
```
public boolean add(SimpleFeature feature)
```
  - addAll
```
public boolean addAll(Collection<? extends SimpleFeature> collection)
```
  - addAll
```
public boolean addAll(FeatureCollection<? extends SimpleFeatureType,? extends SimpleFeature> collection)
```
  - clear
```
public void clear()
```
  - close
```
public void close(FeatureIterator<SimpleFeature> close)
```
  - close
```
public void close(Iterator<SimpleFeature> close)
```
  - contains
```
public boolean contains(Object obj)
```
    Specified by:
    
    contains in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    See Also:
    
    Collection.contains(Object)
  - containsAll
```
public boolean containsAll(Collection<?> collection)
```
    Specified by:
    
    containsAll in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    See Also:
    
    Collection.containsAll(Collection)
  - getBounds
```
public ReferencedEnvelope getBounds()
```
    Description copied from interface: FeatureCollection
    
    Get the total bounds of this collection which is calculated by doing a union of the bounds of each feature inside of it
    
    Specified by:
    
    getBounds in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Returns:
    
    An Envelope containing the total bounds of this collection.
  - getID
```
public String getID()
```
    Description copied from interface: FeatureCollection
    
    ID used when serializing to GML
    
    Specified by:
    
    getID in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
  - getSchema
```
public SimpleFeatureType getSchema()
```
    Description copied from interface: FeatureCollection
    The schema for the child feature members of this collection.
    Represents the most general FeatureType in common to all the features in this collection.
    - For a collection backed by a shapefiles (or database tables) the FeatureType returned by getSchema() will complete describe each and every child in the collection.
    - For mixed content FeatureCollections you will need to check the FeatureType of each Feature as it is retrived from the collection
    - The degenerate case returns the "_Feature" FeatureType, where the only thing known is that the contents are Features.
    Specified by:
    
    getSchema in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Returns:
    
    FeatureType describing the "common" schema to all child features of this collection
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: FeatureCollection
    
    Returns true if this feature collection contains no features.
    
    Specified by:
    
    isEmpty in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    Returns:
    
    true if this collection contains no features
  - iterator
```
public Iterator<SimpleFeature> iterator()
```
  - purge
```
public void purge()
```
  - remove
```
public boolean remove(Object o)
```
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
  - size
```
public int size()
```
    Will build the STRtree index if required.
    
    Specified by:
    
    size in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    See Also:
    
    Collection.size()
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    See Also:
    
    Collection.toArray()
  - toArray
```
public <O> O[] toArray(O[] array)
```
    Specified by:
    
    toArray in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
    
    See Also:
    
    Collection.toArray(Object[])

Class SpatialIndexFeatureCollection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

index

schema

listeners

Constructor Detail

SpatialIndexFeatureCollection

SpatialIndexFeatureCollection

SpatialIndexFeatureCollection

Method Detail

addListener

removeListener

fire

features

sort

subCollection

accepts

add

addAll

addAll

clear

close

close

contains

containsAll

getBounds

getID

getSchema

isEmpty

iterator

purge

remove

removeAll

retainAll

size

toArray

toArray