org.geotools.data.store
Class ContentFeatureCollection

Object
  extended by ContentFeatureCollection
All Implemented Interfaces:
SimpleFeatureCollection, FeatureCollection<SimpleFeatureType,SimpleFeature>

public class ContentFeatureCollection
extends Object
implements SimpleFeatureCollection

A FeatureCollection that completely delegates to a backing FetaureSource#getReader

Author:
Jody Garnett (Refractions Research, Inc.)

Nested Class Summary
static class ContentFeatureCollection.WrappingFeatureIterator
           
 
Field Summary
protected  ContentFeatureSource featureSource
          feature store the collection originated from.
protected  SimpleFeatureType featureType
          feature (possibly retyped from feautre source original) type
protected static Logger LOGGER
           
protected  Query query
           
protected  ContentState state
          state of the feature source
 
Constructor Summary
protected ContentFeatureCollection(ContentFeatureSource featureSource, Query query)
           
 
Method Summary
 void accepts(FeatureVisitor visitor, ProgressListener progress)
          Visit the contents of a feature collection.
 boolean contains(Object o)
          Returns true if this collection contains the specified element.
 boolean containsAll(Collection<?> c)
          Returns true if this collection contains all of the elements in the specified collection.
 SimpleFeatureIterator features()
          Obtain a SimpleFeatureIterator of the Features within this SimpleFeatureCollection.
 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.
 boolean remove(Object o)
           
 int size()
          Please note this operation may be expensive when working with remote content.
 SimpleFeatureCollection sort(SortBy order)
           
 SimpleFeatureCollection sort(SortBy sort)
          Obtained sorted contents.
 SimpleFeatureCollection subCollection(Filter filter)
          SimpleFeatureCollection "view" indicated by provided filter.
 Object[] toArray()
          Array of all the elements.
<T> T[]
toArray(T[] array)
           
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOGGER

protected static final Logger LOGGER

featureSource

protected ContentFeatureSource featureSource
feature store the collection originated from.


query

protected Query query

featureType

protected SimpleFeatureType featureType
feature (possibly retyped from feautre source original) type


state

protected ContentState state
state of the feature source

Constructor Detail

ContentFeatureCollection

protected ContentFeatureCollection(ContentFeatureSource featureSource,
                                   Query query)
Method Detail

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.

Specified by:
getSchema in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
Returns:
FeatureType describing the "common" schema to all child features of this collection

accepts

public void accepts(FeatureVisitor visitor,
                    ProgressListener progress)
             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.
progress - Used to report progress, may be used to interrupt the operation
Throws:
IOException

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.

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.

size

public int size()
Description copied from interface: FeatureCollection
Please note this operation may be expensive when working with remote content.

Specified by:
size in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
See Also:
Collection.size()

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

sort

public SimpleFeatureCollection sort(SortBy order)

sort

public SimpleFeatureCollection sort(SortBy sort)
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:
sort - 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:

Specified by:
subCollection in interface SimpleFeatureCollection
Specified by:
subCollection in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
Returns:
SimpleFeatureCollection identified as subset.
See Also:
FeatureList

contains

public boolean contains(Object o)
Returns true if this collection contains the specified element. .

This implementation iterates over the elements in the collection, checking each element in turn for equality with the specified element.

Specified by:
contains in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
Parameters:
o - object to be checked for containment in this collection.
Returns:
true if this collection contains the specified element.
See Also:
Collection.contains(Object)

containsAll

public boolean containsAll(Collection<?> c)
Returns true if this collection contains all of the elements in the specified collection.

Specified by:
containsAll in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
Parameters:
c - collection to be checked for containment in this collection.
Returns:
true if this collection contains all of the elements in the specified collection.
Throws:
NullPointerException - if the specified collection is null.
See Also:
contains(Object)

remove

public boolean remove(Object o)

toArray

public Object[] toArray()
Array of all the elements.

Specified by:
toArray in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
Returns:
an array containing all of the elements in this collection.
See Also:
Collection.toArray()

toArray

public <T> T[] toArray(T[] array)
Specified by:
toArray in interface FeatureCollection<SimpleFeatureType,SimpleFeature>
See Also:
Collection.toArray(Object[])

getID

public String getID()
Description copied from interface: FeatureCollection
ID used when serializing to GML

Specified by:
getID in interface FeatureCollection<SimpleFeatureType,SimpleFeature>


Copyright © 1996-2014 Geotools. All Rights Reserved.