org.geotools.feature
Interface FeatureCollection<T extends FeatureType,F extends Feature>

All Known Subinterfaces:

RandomFeatureAccess, SimpleFeatureCollection, XmlFeatureCollection

All Known Implementing Classes:

AbstractFeatureCollection, AdaptorFeatureCollection, ArcSdeFeatureCollection, CollectionFeatureSource.SubCollection, CompositeFeatureCollection, ContentFeatureCollection, DataFeatureCollection, DecoratingFeatureCollection, DecoratingSimpleFeatureCollection, DefaultFeatureCollection, DefaultFeatureResults, EmptyFeatureCollection, FilteringFeatureCollection, FilteringSimpleFeatureCollection, ForceCoordinateSystemFeatureResults, GMLFeatureCollection, IndexedFeatureResults, ListFeatureCollection, MappingFeatureCollection, MaxFeaturesFeatureCollection, MaxSimpleFeatureCollection, MemoryFeatureCollection, PreGeneralizedFeatureCollection, PropertyValueCollection, ReprojectFeatureResults, ReprojectingFeatureCollection, ReTypingFeatureCollection, SampleDataAccessFeatureCollection, SortedSimpleFeatureCollection, SpatialIndexFeatureCollection, SubFeatureCollection, SubFeatureList, TreeSetFeatureCollection, WFSFeatureSource.WFSFeatureResults

public interface FeatureCollection<T extends FeatureType,F extends Feature>

Collection of features, often handled as a result set.

Where possible FeatureCollection is method compatible with Collection. In keeping with the rules set for by Collection, some methods are optional, and may throw an UnsupportedOperationException.

SimpleFeatureCollection house rules:

• Each iterator is considered a connection which my be closed (see example below)
• Features are not specifically ordered within the SimpleFeatureCollection
• Two instances cannot exist with the same FeatureId

FeatureIterator close

FeatureCollection provides streaming access. With this in mind we have a restriction on the use of FeatureIterator: You must call FeatureIterator.close(). This allows FeatureCollection to clean up any operating system resources used to access information.

Example (safe) use:

 FeatureIterator iterator = collection.features();
 try {
     while( iterator.hasNext() ){
          Feature feature = iterator.hasNext();
          System.out.println( feature.getID() );
     }
 }
 finally {
     iterator.close();
 }
 

Handy Tip: Although many resource backed collections will choose to release resources at when the iterator has reached the end of its contents this is not something you should rely on.

FeatureCollection Implementation Tips

Try and close up resources when you can detect that an Iterator is no longer in use.

FeatureCollection is used in two fashions, as a result set, where each iterator acts as a cursor over the content. Also as a predefined query which can be refined further. An example is using featureCollection.subCollection( Filter ) or featureCollection.sort( SortBy ) before listing features out of a FeatureCollection.

Author:

Ian Turton, CCG, Rob Hranac, VFNY, Ian Schneider, USDA-ARS, Jody Garnett, Refractions Research, Inc.

See Also:

org.geotools.Feature

Method Summary

void	accepts(FeatureVisitor visitor, ProgressListener progress) Visit the contents of a feature collection.
boolean	add(F obj) Deprecated. Assumes modification Collection in memory - use FeatureSource
boolean	addAll(Collection<? extends F> collection) Deprecated. Assumes modification Collection in memory - use FeatureSource
boolean	addAll(FeatureCollection<? extends T,? extends F> resource) Deprecated. Assume modification Collection in memory - use FeatureSource
void	addListener(CollectionListener listener) Deprecated. Use FeatureSource.addFeatureListener(org.geotools.data.FeatureListener) to monitor change
void	clear() Deprecated. Assumes modification Collection in memory - use FeatureSource
void	close(FeatureIterator<F> close) Deprecated. Please FeatureIterator.close()
void	close(Iterator<F> close) Deprecated. Please use features() to obtain a FeatureIterator
boolean	contains(Object o)
boolean	containsAll(Collection<?> o)
FeatureIterator<F>	features() Obtain a FeatureIterator of the Features within this collection.
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
T	getSchema() The schema for the child feature members of this collection.
boolean	isEmpty()
Iterator<F>	iterator() Deprecated. Please use features() to obtain a closable FeatureIterator
void	purge() Deprecated. Please use features() to obtain a FeatureIterator
boolean	remove(Object o) Deprecated. Assumes modification Collection in memory - use FeatureSource
boolean	removeAll(Collection<?> c) Deprecated. Assumes modification Collection in memory - use FeatureSource
void	removeListener(CollectionListener listener) Deprecated. Use FeatureSource.removeFeatureListener(org.geotools.data.FeatureListener) to monitor change
boolean	retainAll(Collection<?> c) Deprecated. Assumes modification Collection in memory - use FeatureSource
int	size() Please note this operation may be expensive when working with remote content.
FeatureCollection<T,F>	sort(SortBy order) Obtained sorted contents.
FeatureCollection<T,F>	subCollection(Filter filter) SimpleFeatureCollection "view" indicated by provided filter.
Object[]	toArray()
<O> O[]	toArray(O[] a)

Method Detail

features

FeatureIterator<F> features()

Obtain a FeatureIterator of the Features within this collection.

The implementation of Collection must adhere to the rules of fail-fast concurrent modification. In addition (to allow for resource backed collections, the close( Iterator ) method must be called.

This is almost equivalent to:

• a Type-Safe call to: getAttribute(getFeatureType().getAttributeType(0).getName()).iterator();.
• A Java 5:Iterator<Feature>

Example (safe) use:

 FeatureIterator iterator=collection.features();
 try {
     while( iterator.hasNext()  ){
          Feature feature = iterator.next();
          System.out.println( feature.getID() );
     }
 }
 finally {
     collection.close( iterator );
 }
 

GML Note: The contents of this iterator are considered to be defined by featureMember tags (and/or the single allowed FeatureMembers tag). Please see getFeatureType for more details.

Returns:

A FeatureIterator.

close

void close(FeatureIterator<F> close)

Deprecated. Please FeatureIterator.close()

Clean up after any resources associated with this FeatureIterator in a manner similar to JDO collections.

Example (safe) use:

 Iterator iterator = collection.iterator();
 try {
     for( Iterator i=collection.iterator(); i.hasNext();){
          Feature feature = i.hasNext();
          System.out.println( feature.getID() );
     }
 }
 finally {
     collection.close( iterator );
 }
 

Parameters:

close -

close

void close(Iterator<F> close)

Deprecated. Please use features() to obtain a FeatureIterator

Clean up after any resources associated with this itterator in a manner similar to JDO collections.

Example (safe) use:

 Iterator iterator = collection.iterator();
 try {
     for( Iterator i=collection.iterator(); i.hasNext();){
          Feature feature = (Feature) i.hasNext();
          System.out.println( feature.getID() );
     }
 }
 finally {
     collection.close( iterator );
 }
 

addListener

void addListener(CollectionListener listener)
                 throws NullPointerException

Deprecated. Use FeatureSource.addFeatureListener(org.geotools.data.FeatureListener) to monitor change

Adds a listener for collection events.

When this collection is backed by live data the event notification will follow the guidelines outlined by FeatureListner.

Parameters:

listener - The listener to add

Throws:

NullPointerException - If the listener is null.

removeListener

void removeListener(CollectionListener listener)
                    throws NullPointerException

Deprecated. Use FeatureSource.removeFeatureListener(org.geotools.data.FeatureListener) to monitor change

Removes a listener for collection events.

Parameters:

listener - The listener to remove

Throws:

NullPointerException - If the listener is null.

getSchema

T getSchema()

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.

Returns:

FeatureType describing the "common" schema to all child features of this collection

getID

String getID()

ID used when serializing to GML

accepts

void accepts(FeatureVisitor visitor,
             ProgressListener progress)
             throws IOException

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.

Parameters:

visitor - Closure applied to each feature in turn.

progress - Used to report progress, may be used to interrupt the operation

Throws:

IOException

Since:

2.5

subCollection

FeatureCollection<T,F> subCollection(Filter filter)

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

Parameters:

filter -

Returns:

SimpleFeatureCollection identified as subset.

See Also:

FeatureList

sort

FeatureCollection<T,F> sort(SortBy order)

Obtained sorted contents.

This method may not be supported by all implementations, consider the use of FeatureSource.features( Query ).

Parameters:

order - Sort order

Returns:

FeatureCollection sorted in the indicated order

getBounds

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

Returns:

An Envelope containing the total bounds of this collection.

iterator

Iterator<F> iterator()

Deprecated. Please use features() to obtain a closable FeatureIterator

An iterator over this collection, which must be closed after use.

Collection is not guaranteed to be ordered in any manner.

The implementation of Collection must adhere to the rules of fail-fast concurrent modification. In addition (to allow for resource backed collections, the close( Iterator ) method must be called.

Example (safe) use:

 Iterator iterator = collection.iterator();
 try {
     while( iterator.hasNext();){
          Feature feature = (Feature) iterator.hasNext();
          System.out.println( feature.getID() );
     }
 }
 finally {
     collection.close( iterator );
 }
 

Returns:

Iterator

purge

void purge()

Deprecated. Please use features() to obtain a FeatureIterator

Close any outstanding resources released by this resources.

This method should be used with great caution, it is however available to allow the use of the ResourceCollection with algorthims that are unaware of the need to close iterators after use.

Example of using a normal Collections utility method:

 Collections.sort( collection );
 collection.purge();
 

add

boolean add(F obj)

Deprecated. Assumes modification Collection in memory - use FeatureSource

Add object to this collection.

This method is often not impelmented for collections produced as the result of a query.

Returns:

true of the element was added

See Also:

Collection.add(Object)

addAll

boolean addAll(Collection<? extends F> collection)

Deprecated. Assumes modification Collection in memory - use FeatureSource

Add all the objects to the collection.

This method is often not implemented for collections produced as the results of a query.

See Also:

Collection.addAll(Collection)

addAll

boolean addAll(FeatureCollection<? extends T,? extends F> resource)

Deprecated. Assume modification Collection in memory - use FeatureSource

See Also:

addAll(Collection)

clear

void clear()

Deprecated. Assumes modification Collection in memory - use FeatureSource

See Also:

Collection.clear()

contains

boolean contains(Object o)

See Also:

Collection.contains(Object)

containsAll

boolean containsAll(Collection<?> o)

See Also:

Collection.containsAll(Collection)

isEmpty

boolean isEmpty()

See Also:

Collection.isEmpty()

remove

boolean remove(Object o)

Deprecated. Assumes modification Collection in memory - use FeatureSource

See Also:

Collection.remove(Object)

removeAll

boolean removeAll(Collection<?> c)

Deprecated. Assumes modification Collection in memory - use FeatureSource

See Also:

Collection.removeAll(Collection)

retainAll

boolean retainAll(Collection<?> c)

Deprecated. Assumes modification Collection in memory - use FeatureSource

See Also:

Collection.retainAll(Collection)

size

int size()

Please note this operation may be expensive when working with remote content.

See Also:

Collection.size()

toArray

Object[] toArray()

See Also:

Collection.toArray()

toArray

<O> O[] toArray(O[] a)

See Also:

Collection.toArray(Object[])