org.geotools.data.gen

Class PreGeneralizedFeatureCollection

Object

PreGeneralizedFeatureCollection

All Implemented Interfaces:

SimpleFeatureCollection, FeatureCollection<SimpleFeatureType,SimpleFeature>

public class PreGeneralizedFeatureCollection
extends Object
implements SimpleFeatureCollection

Author:

Christian Mueller

Implementation of FeatureCollection for PreGeneralizedSimpleFeature

This collection is read only, modifying methods result in UnsupportedOperationException

Field Summary

Fields

Modifier and Type	Field and Description
protected SimpleFeatureCollection	backendCollection
protected String	backendGeomPropertyName
protected SimpleFeatureType	featureType
protected String	geomPropertyName
protected int[]	indexMapping
protected SimpleFeatureType	returnedFeatureType

Constructor Summary

Constructors

Constructor and Description
PreGeneralizedFeatureCollection(SimpleFeatureCollection backendCollection, SimpleFeatureType featureType, SimpleFeatureType returnedFeatureType, int[] indexMapping, String geomPropertyName, String backendGeomPropertyName)

Method Summary

Modifier and Type	Method and Description
void	accepts(FeatureVisitor visitor, ProgressListener progress) Visit the contents of a feature collection.
boolean	contains(Object feature)
boolean	containsAll(Collection coll)
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.
int	size() Please note this operation may be expensive when working with remote content.
SimpleFeatureCollection	sort(SortBy sortBy) Obtained sorted contents.
SimpleFeatureCollection	subCollection(Filter filter) SimpleFeatureCollection "view" indicated by provided filter.
Object[]	toArray()
<O> O[]	toArray(O[] a)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

backendCollection

protected SimpleFeatureCollection backendCollection

featureType

protected SimpleFeatureType featureType

returnedFeatureType

protected SimpleFeatureType returnedFeatureType

geomPropertyName

protected String geomPropertyName

backendGeomPropertyName

protected String backendGeomPropertyName

indexMapping

protected int[] indexMapping

Constructor Detail

PreGeneralizedFeatureCollection

public PreGeneralizedFeatureCollection(SimpleFeatureCollection backendCollection,
                                       SimpleFeatureType featureType,
                                       SimpleFeatureType returnedFeatureType,
                                       int[] indexMapping,
                                       String geomPropertyName,
                                       String backendGeomPropertyName)

Method Detail

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

contains

public boolean contains(Object feature)

Specified by:

contains in interface FeatureCollection<SimpleFeatureType,SimpleFeature>

See Also:

Collection.contains(Object)

containsAll

public boolean containsAll(Collection coll)

Specified by:

containsAll in interface FeatureCollection<SimpleFeatureType,SimpleFeature>

See Also:

Collection.containsAll(Collection)

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.

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

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()

sort

public SimpleFeatureCollection sort(SortBy sortBy)

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:

sortBy - 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

toArray

public Object[] toArray()

Specified by:

toArray in interface FeatureCollection<SimpleFeatureType,SimpleFeature>

See Also:

Collection.toArray()

toArray

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

Specified by:

toArray in interface FeatureCollection<SimpleFeatureType,SimpleFeature>

See Also:

Collection.toArray(Object[])