Cursor (Groovy Documentation)

geoscript.layer.Cursor

All Implemented Interfaces and Traits:: java.util.Iterator

class Cursor
extends java.lang.Object
implements java.util.Iterator

A Cursor is a Iterator over a Feature objects.

Most often you will get a Cursor by calling the getCursor() method of a Layer

 Shapefile shp = new Shapefile('states.shp')
 Cursor c = shp.cursor
 while(c.hasNext()) {
      Feature f = c.next()
 }
 c.close()

Authors:: Jared Erickson

Properties Summary

Properties
Type	Name and description
`FeatureCollection<SimpleFeatureType, SimpleFeature>`	`col` The GeoTools FeatureCollection

Constructor Summary

Constructors
Constructor and description
`Cursor (Map options, FeatureCollection<SimpleFeatureType, SimpleFeature> col)` Create a new Cursor with a FeatureCollection
`Cursor (Map options, FeatureCollection<SimpleFeatureType, SimpleFeature> col, Layer layer)` Create a new Cursor with a FeatureCollection and a Layer

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`close()` Closes the Cursor.
	`protected void`	`createIterator()` Create the FeatureIterator based on the FeatureCollection and options
	`boolean`	`hasNext()` Whether there are Features remaining
	`Feature`	`next()` Get the next Feature
	`java.util.List<Feature>`	`read(int n)` Read n features into a List
	`void`	`remove()` This method is unsupported and throws an UnsupportedOperationException
	`void`	`reset()` Reset and read the Features again.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - FeatureCollection<SimpleFeatureType, SimpleFeature> col
    
    The GeoTools FeatureCollection
- Constructor Detail
  - Cursor(Map options, FeatureCollection<SimpleFeatureType, SimpleFeature> col)
    
    Create a new Cursor with a FeatureCollection
    Parameters:
    options - A Map of options (sort - a List of Strings, start - is 0 based, max - the max number of features)
    col - The GeoTools FeatureCollection
  - Cursor(Map options, FeatureCollection<SimpleFeatureType, SimpleFeature> col, Layer layer)
    
    Create a new Cursor with a FeatureCollection and a Layer
    Parameters:
    options - A Map of options (sort - a List of Strings, start - is 0 based, max - the max number of features)
    col - The GeoTools FeatureCollection
    layer - The Geoscript Layer
- Method Detail
  - void close()
    
    Closes the Cursor. This should always be called.
  - protected void createIterator()
    
    Create the FeatureIterator based on the FeatureCollection and options
  - boolean hasNext()
    
    Whether there are Features remaining
    Returns:
    Whether there are Features remaining
  - Feature next()
    
    Get the next Feature
    Returns:
    The next Feature
  - java.util.List<Feature> read(int n)
    
    Read n features into a List
    Parameters:
    n - The number of features to read
    Returns:
    A List of Features
  - void remove()
    
    This method is unsupported and throws an UnsupportedOperationException
  - void reset()
    
    Reset and read the Features again.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Cursor

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

FeatureCollection<SimpleFeatureType, SimpleFeature> col

Constructor Detail

Cursor(Map options, FeatureCollection<SimpleFeatureType, SimpleFeature> col)

Cursor(Map options, FeatureCollection<SimpleFeatureType, SimpleFeature> col, Layer layer)

Method Detail

void close()

protected void createIterator()

boolean hasNext()

Feature next()

java.util.List<Feature> read(int n)

void remove()

void reset()