org.geotools.data
Class MaxFeatureReader

java.lang.Object
  org.geotools.data.MaxFeatureReader

All Implemented Interfaces:

FeatureReader

public class MaxFeatureReader

extends java.lang.Object

implements FeatureReader

Basic support for a FeatureReader that limits itself to the number of features passed in.

Version:

$Id: MaxFeatureReader.java 17701 2006-01-23 00:00:51Z desruisseaux $

Author:

Chris Holmes

Field Summary

protected int	counter
protected FeatureReader	featureReader
protected int	maxFeatures

Constructor Summary

MaxFeatureReader(FeatureReader featureReader, int maxFeatures)
Creates a new instance of MaxFeatureReader

Method Summary

void	close() Release the underlying resources associated with this stream.
FeatureType	getFeatureType() Return the FeatureType this reader has been configured to create.
boolean	hasNext()
Feature	next() Reads the next Feature in the FeatureReader.

Methods inherited from class java.lang.Object

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

Field Detail

featureReader

protected final FeatureReader featureReader

maxFeatures

protected final int maxFeatures

counter

protected int counter

Constructor Detail

MaxFeatureReader

public MaxFeatureReader(FeatureReader featureReader,
                        int maxFeatures)

Creates a new instance of MaxFeatureReader

Parameters:

featureReader - FeatureReader being maxed

maxFeatures - DOCUMENT ME!

Method Detail

next

public Feature next()
             throws java.io.IOException,
                    IllegalAttributeException,
                    java.util.NoSuchElementException

Description copied from interface: FeatureReader

Reads the next Feature in the FeatureReader.

Specified by:

next in interface FeatureReader

Returns:

The next feature in the reader.

Throws:

java.util.NoSuchElementException - If there are no more Features in the Reader.

IllegalAttributeException - If the attributes read do not comply with the FeatureType.

java.io.IOException - If an error occurs reading the Feature.

close

public void close()
           throws java.io.IOException

Description copied from interface: FeatureReader

Release the underlying resources associated with this stream.

Specified by:

close in interface FeatureReader

Throws:

java.io.IOException - DOCUMENT ME!

getFeatureType

public FeatureType getFeatureType()

Description copied from interface: FeatureReader

Return the FeatureType this reader has been configured to create.

Specified by:

getFeatureType in interface FeatureReader

Returns:

the FeatureType of the Features this FeatureReader will create.

hasNext

public boolean hasNext()
                throws java.io.IOException

Specified by:

hasNext in interface FeatureReader

Returns:

true if the featureReader has not passed the max and still has more features.

Throws:

java.io.IOException - If the reader we are filtering encounters a problem