IlvDBFeatureIterator (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.maps.datasource.IlvMapDelegateFeatureIterator
- - ilog.views.maps.datasource.ibm.IlvDBFeatureIterator

All Implemented Interfaces:

IlvPersistentObject, IlvMapFeatureIterator, IlvMapReusableFeatureIterator, IlvMapRegionOfInterestIterator

Direct Known Subclasses:

DB2FeatureIterator, InformixFeatureIterator
```
public abstract class IlvDBFeatureIterator
extends IlvMapDelegateFeatureIterator
implements IlvMapRegionOfInterestIterator, IlvPersistentObject
```
A reusable iterator for a DB2 or INFORMIX data source.

Since:

JViews 8.7

Constructor Summary

Constructors
Constructor and Description
`IlvDBFeatureIterator(IlvDBDataSource dataSource)` Creates a new `IlvDBFeatureIterator`.
`IlvDBFeatureIterator(IlvInputStream stream)` Reads an iterator from an `IlvInputStream`.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dispose()` Releases the resources allocated by the feature iterator (files, connections, and so on).
`protected abstract String`	`getAsBinaryFunctionName()` Returns the name of the function that transforms a blob column into binary.
`protected String`	`getAttrColumnList()` Get a comma separated list of column names for the non-geometry attributes.
`protected abstract String`	`getBoundsQuery()` Returns the SELECT statement that returns the bounds of the geometric data contained in the table.
`IlvCoordinateSystem`	`getCoordinateSystem()` Returns the spatial reference system that describes the coordinate system of geometric coordinates of the map features.
`String`	`getCoordinateSystemWKTDefinition()` Returns the WKT definition of the coordinate system.
`String`	`getGeometryColumnName()` Returns the name of the table column where geometry is defined.
`Rectangle2D`	`getLatLonBounds()` Returns the bounds of all objects returned by this feature iterator.
`IlvThreadedActivityMonitor`	`getMonitor()` Gets the activity monitor attached to the iterator.
`IlvMapFeature`	`getNextFeature()` Returns the next map feature of the iterator or `null` if the iteration is finished.
`protected abstract String`	`getRegionPredicate()` Returns the WHERE clause that limits the selection to within the region of interest.
`protected Double`	`getRegionXMax()` Returns one of the four projected coordinates which this iterator should take into account.
`protected Double`	`getRegionXMin()` Returns one of the four projected coordinates which this iterator should take into account.
`protected Double`	`getRegionYMax()` Returns one of the four projected coordinates which this iterator should take into account.
`protected Double`	`getRegionYMin()` Returns one of the four projected coordinates which this iterator should take into account.
`String`	`getSchemaTableName()` Returns the database table name to iterate through.
`Integer`	`getSrsId()` Returns the id of the coordinate system for the geometry.
`boolean`	`isGeoreferenced()` Returns `true` if the map reader can provide the source projection of its map features.
`void`	`restart()` Rewinds the iterator for a new use.
`void`	`setMonitor(IlvThreadedActivityMonitor monitor)` Changes the activity monitor that displays progress for that iterator.
`void`	`setRegionOfInterest(double minX, double minY, double maxX, double maxY)` Sets the region of interest to return features for.
`void`	`write(IlvOutputStream stream)` Writes the attributes of a persistent object.

Methods inherited from class ilog.views.maps.datasource.IlvMapDelegateFeatureIterator
getDefaultFeatureRenderer, getDelegate, getLowerRightCorner, getUpperLeftCorner, setDelegate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ilog.views.maps.IlvMapFeatureIterator
getDefaultFeatureRenderer, getLowerRightCorner, getUpperLeftCorner

- Constructor Detail
  - IlvDBFeatureIterator
```
public IlvDBFeatureIterator(IlvInputStream stream)
                     throws IlvReadFileException,
                            SQLException,
                            IOException
```
    Reads an iterator from an IlvInputStream.
    
    Parameters:
    
    stream - The stream to read from.
    
    Throws:
    
    IlvReadFileException - if there is a problem reading from stream.
    
    SQLException
    
    IOException
  - IlvDBFeatureIterator
```
public IlvDBFeatureIterator(IlvDBDataSource dataSource)
                     throws IOException,
                            SQLException
```
    Creates a new IlvDBFeatureIterator. We will always assume that a feature iterator has an open and valid database connection.
    
    Parameters:
    
    dataSource - the data source to iterate through.
    
    Throws:
    
    IOException
    
    SQLException
- Method Detail
  - write
```
public void write(IlvOutputStream stream)
           throws IOException
```
    Writes the attributes of a persistent object.
    
    Specified by:
    
    write in interface IlvPersistentObject
    
    Parameters:
    
    stream - the output stream
    
    Throws:
    
    IOException - thrown when an exception occurs during the write operation for this object.
  - getMonitor
```
public IlvThreadedActivityMonitor getMonitor()
```
    Gets the activity monitor attached to the iterator.
    
    Returns:
    
    the activity monitor attached to the iterator.
  - setMonitor
```
public void setMonitor(IlvThreadedActivityMonitor monitor)
```
    Changes the activity monitor that displays progress for that iterator.
    
    Parameters:
    
    monitor - the activity monitor
  - getRegionXMax
```
protected Double getRegionXMax()
```
    Returns one of the four projected coordinates which this iterator should take into account.
    
    Returns:
    
    the maximum X coordinate
  - getRegionXMin
```
protected Double getRegionXMin()
```
    Returns one of the four projected coordinates which this iterator should take into account.
    
    Returns:
    
    the minimum X coordinate.
  - getRegionYMax
```
protected Double getRegionYMax()
```
    Returns one of the four projected coordinates which this iterator should take into account.
    
    Returns:
    
    the maximum Y coordinate.
  - getRegionYMin
```
protected Double getRegionYMin()
```
    Returns one of the four projected coordinates which this iterator should take into account.
    
    Returns:
    
    the minimum Y coordinate.
  - dispose
```
public void dispose()
```
    Releases the resources allocated by the feature iterator (files, connections, and so on).
    
    Specified by:
    
    dispose in interface IlvMapFeatureIterator
    
    Overrides:
    
    dispose in class IlvMapDelegateFeatureIterator
    
    See Also:
    
    IlvMapFeatureIterator.dispose()
  - getAttrColumnList
```
protected String getAttrColumnList()
```
    Get a comma separated list of column names for the non-geometry attributes.
    
    Returns:
    
    a comma separated list of all the table columns.
  - getCoordinateSystem
```
public IlvCoordinateSystem getCoordinateSystem()
```
    Returns the spatial reference system that describes the coordinate system of geometric coordinates of the map features.
    
    Specified by:
    
    getCoordinateSystem in interface IlvMapFeatureIterator
    
    Overrides:
    
    getCoordinateSystem in class IlvMapDelegateFeatureIterator
    
    Returns:
    
    The coordinate system, or null if the coordinate system is unknown.
    
    See Also:
    
    IlvMapFeatureIterator.getCoordinateSystem()
  - getLatLonBounds
```
public Rectangle2D getLatLonBounds()
```
    Returns the bounds of all objects returned by this feature iterator.
    
    Specified by:
    
    getLatLonBounds in interface IlvMapRegionOfInterestIterator
    
    Returns:
    
    IlvRect The bounds of all objects.
  - getNextFeature
```
public IlvMapFeature getNextFeature()
```
    Returns the next map feature of the iterator or null if the iteration is finished. The returned map feature must be considered as volatile and can be modified by the reader during the next call to its getNextFeature function.
    
    Specified by:
    
    getNextFeature in interface IlvMapFeatureIterator
    
    Overrides:
    
    getNextFeature in class IlvMapDelegateFeatureIterator
    
    See Also:
    
    IlvMapFeatureIterator.getNextFeature()
  - getBoundsQuery
```
protected abstract String getBoundsQuery()
```
    Returns the SELECT statement that returns the bounds of the geometric data contained in the table.
    
    Returns:
    
    a Select statement.
  - getRegionPredicate
```
protected abstract String getRegionPredicate()
```
    Returns the WHERE clause that limits the selection to within the region of interest.
    
    Returns:
    
    a WHERE clause.
  - getAsBinaryFunctionName
```
protected abstract String getAsBinaryFunctionName()
```
    Returns the name of the function that transforms a blob column into binary.
    
    Returns:
    
    a function name.
  - isGeoreferenced
```
public boolean isGeoreferenced()
```
    Returns true if the map reader can provide the source projection of its map features.
    
    Specified by:
    
    isGeoreferenced in interface IlvMapFeatureIterator
    
    Overrides:
    
    isGeoreferenced in class IlvMapDelegateFeatureIterator
    
    See Also:
    
    IlvMapFeatureIterator.isGeoreferenced()
  - restart
```
public void restart()
```
    Rewinds the iterator for a new use.
    
    Specified by:
    
    restart in interface IlvMapReusableFeatureIterator
    
    Specified by:
    
    restart in class IlvMapDelegateFeatureIterator
    
    See Also:
    
    IlvMapReusableFeatureIterator.restart()
  - setRegionOfInterest
```
public void setRegionOfInterest(double minX,
                                double minY,
                                double maxX,
                                double maxY)
```
    Sets the region of interest to return features for. After this method is called, the IlvMapFeatureIterator.getNextFeature() method should not return any feature which geometry is outside this area.
    
    Specified by:
    
    setRegionOfInterest in interface IlvMapRegionOfInterestIterator
    
    Parameters:
    
    minX - longitude min in radians.
    
    minY - latitude min in radians.
    
    maxX - longitude max in radians.
    
    maxY - latitude max in radians.
  - getSchemaTableName
```
public String getSchemaTableName()
```
    Returns the database table name to iterate through.
    
    Returns:
    
    the database table name to iterate through.
  - getGeometryColumnName
```
public String getGeometryColumnName()
```
    Returns the name of the table column where geometry is defined.
    
    Returns:
    
    the column name.
  - getSrsId
```
public Integer getSrsId()
```
    Returns the id of the coordinate system for the geometry.
    
    Returns:
    
    the ID of coordinate system.
  - getCoordinateSystemWKTDefinition
```
public String getCoordinateSystemWKTDefinition()
```
    Returns the WKT definition of the coordinate system.
    
    Returns:
    
    the WKT definition of the coordinate system.

Class IlvDBFeatureIterator

Constructor Summary

Method Summary

Methods inherited from class ilog.views.maps.datasource.IlvMapDelegateFeatureIterator

Methods inherited from class java.lang.Object

Methods inherited from interface ilog.views.maps.IlvMapFeatureIterator

Constructor Detail

IlvDBFeatureIterator

IlvDBFeatureIterator

Method Detail

write

getMonitor

setMonitor

getRegionXMax

getRegionXMin

getRegionYMax

getRegionYMin

dispose

getAttrColumnList

getCoordinateSystem

getLatLonBounds

getNextFeature

getBoundsQuery

getRegionPredicate

getAsBinaryFunctionName

isGeoreferenced

restart

setRegionOfInterest

getSchemaTableName

getGeometryColumnName

getSrsId

getCoordinateSystemWKTDefinition