org.geotools.feature.collection

Class ClippedFeatureCollection

Object

DecoratingSimpleFeatureCollection

ClippedFeatureCollection

All Implemented Interfaces:

SimpleFeatureCollection, FeatureCollection<SimpleFeatureType,SimpleFeature>

public class ClippedFeatureCollection
extends DecoratingSimpleFeatureCollection

SimpleFeatureCollection wrapper that clip (crops) features according to the clip geometry passed. Can preserve the Z dimension.

Author:

Andrea Aime - GeoSolutions

Field Summary

Fields

Modifier and Type	Field and Description
protected Geometry	clip
protected boolean	preserveZ
protected SimpleFeatureType	targetSchema

Fields inherited from class DecoratingSimpleFeatureCollection

delegate

Constructor Summary

Constructors

Constructor and Description
ClippedFeatureCollection(SimpleFeatureCollection delegate, Geometry clip, boolean preserveZ)

Method Summary

Modifier and Type	Method and Description
SimpleFeatureIterator	features() Obtain a SimpleFeatureIterator of the Features within this SimpleFeatureCollection.
SimpleFeatureType	getSchema() The schema for the child feature members of this collection.
int	size() Please note this operation may be expensive when working with remote content.

Methods inherited from class DecoratingSimpleFeatureCollection

accepts, canDelegate, contains, containsAll, equals, getBounds, getID, hashCode, isEmpty, sort, subCollection, toArray, toArray

Methods inherited from class Object

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

Field Detail

clip

protected Geometry clip

targetSchema

protected SimpleFeatureType targetSchema

preserveZ

protected boolean preserveZ

Constructor Detail

ClippedFeatureCollection

public ClippedFeatureCollection(SimpleFeatureCollection delegate,
                                Geometry clip,
                                boolean preserveZ)

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.

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

Overrides:

getSchema in class DecoratingSimpleFeatureCollection

Returns:

FeatureType describing the "common" schema to all child features of this 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>

Overrides:

features in class DecoratingSimpleFeatureCollection

Returns:

A FeatureIterator.

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>

Overrides:

size in class DecoratingSimpleFeatureCollection

See Also:

Collection.size()