org.gvsig.gpe.lib.api.parser

Interface ICoordinateIterator

All Known Subinterfaces:

IGmlCoordinatesIterator, IKmlCoordinatesIterator

All Known Implementing Classes:

CoordinatesSequenceBbox, CoordinatesSequenceGeneralPath, CoordinatesSequencePoint, CoordinatesTypeIterator, CoordinatesTypeIterator, CoordTypeIterator, GmlCoodinatesIterator, KmlCoodinatesIterator, LatLonAltBoxIterator, LatLonBoxIterator, LowerCornerTypeBinding, OrientablePrimitiveCoordinateSequence, PointCoordinatesSequence, PosListTypeIterator, PosTypeIterator

public interface ICoordinateIterator

An iterator over the current geometry being parsed intended to be given to the consumer IGPEContentHandler.

This provides an abstraction for specific format parsers to optimize as needed without imposing a coordinate structure to the consumer application which may be inefficient for its geometry model.

Basically, using this interface allows for the following optimizations:

• Avoid unneeded coordinate parsing where not necessary
• Allows to serve geometry sequences of arbitrary dimensions
• Avoids unnecessary copy of large coordinate buffers from different arrays of doubles, letting the consumer iterate over the coordinates and build its geometries more efficiently

Method Summary

Modifier and Type	Method and Description
int	getDimension() Returns the dimension of the coordinate tuple being served.
boolean	hasNext() Returns whether there are more coordinates in this sequence
void	next(double[] buffer)

Method Detail

hasNext

boolean hasNext()
         throws java.io.IOException

Returns whether there are more coordinates in this sequence

Returns:

Throws:

java.io.IOException

getDimension

int getDimension()

Returns the dimension of the coordinate tuple being served. Consumer code should use it to pass a buffer with the correct lenght to next(double[])

Returns:

next

void next(double[] buffer)
   throws java.io.IOException

Parameters:

buffer - where to store the parsed coordinates. The buffer lenght shall be >= getDimension()

Throws:

java.io.IOException