org.geotools.feature.collection

Class ClippingFeatureIterator

Object

DecoratingFeatureIterator<SimpleFeature>

DecoratingSimpleFeatureIterator

ClippingFeatureIterator

All Implemented Interfaces:

Closeable, AutoCloseable, SimpleFeatureIterator, FeatureIterator<SimpleFeature>

public class ClippingFeatureIterator
extends DecoratingSimpleFeatureIterator

Decorates a SimpleFeatureIterator with one that return features if intersect the Geometry passed with the Hint.GEOMETRY_CLIP

Constructor Summary

Constructors

Constructor and Description
ClippingFeatureIterator(SimpleFeatureIterator iterator) Wrap the provided FeatureIterator.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this iterator and releases any system resources associated with it.
boolean	hasNext() Does another Feature exist in this Iteration.
SimpleFeature	next() Get the next Feature in this iteration.

Methods inherited from class Object

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

Constructor Detail

ClippingFeatureIterator

public ClippingFeatureIterator(SimpleFeatureIterator iterator)

Wrap the provided FeatureIterator.

Parameters:

iterator - Iterator to be used as a delegate.

Method Detail

next

public SimpleFeature next()
                   throws NoSuchElementException

Description copied from interface: FeatureIterator

Get the next Feature in this iteration.

Specified by:

next in interface FeatureIterator<SimpleFeature>

Overrides:

next in class DecoratingFeatureIterator<SimpleFeature>

Returns:

The next Feature

Throws:

NoSuchElementException - If no more Features exist.

hasNext

public boolean hasNext()

Description copied from interface: FeatureIterator

Does another Feature exist in this Iteration.

Iterator defin: Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Specified by:

hasNext in interface FeatureIterator<SimpleFeature>

Overrides:

hasNext in class DecoratingFeatureIterator<SimpleFeature>

Returns:

true if more Features exist, false otherwise.

close

public void close()

Description copied from interface: FeatureIterator

Closes this iterator and releases any system resources associated with it.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface FeatureIterator<SimpleFeature>

Overrides:

close in class DecoratingFeatureIterator<SimpleFeature>