org.osid.mapping

Interface SpatialUnitList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface SpatialUnitList
extends OsidList

Like all OsidLists, SpatialUnitList provides a means for accessing SpatialUnit elements sequentially either one at a time or many at a time. Examples:

       
       
       while (sul.hasNext()) {
            SpatialUnit unit = sul.getNextSpatialUnit();
       }
       
                   
       
  

or

       
       
       while (sul.hasNext()) {
            SpatialUnit[] units = sul.getNextSpatialUnits(sul.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
SpatialUnit	getNextSpatialUnit() Gets the next SpatialUnit in this list.
SpatialUnit[]	getNextSpatialUnits(long n) Gets the next set of SpatialUnit elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextSpatialUnit

SpatialUnit getNextSpatialUnit()
                               throws OperationFailedException

Gets the next SpatialUnit in this list.

Returns:

the next SpatialUnit in this list. The hasNext() method should be used to test that a next SpatialUnit is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextSpatialUnits

SpatialUnit[] getNextSpatialUnits(long n)
                                  throws OperationFailedException

Gets the next set of SpatialUnit elements in this list. The specified amount must be less than or equal to the return from available().

Parameters:

n - the number of SpatialUnit elements requested which must be less than or equal to available()

Returns:

an array of SpatialUnit elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.