IlvS57Reader (Rogue Wave JViews 9.0 API)

java.lang.Object
- ilog.views.maps.defense.format.s57.IlvS57Reader

All Implemented Interfaces:

IlvPersistentObject, IlvMapFeatureIterator, IlvMapReusableFeatureIterator, IlvMapRegionOfInterestIterator
```
public class IlvS57Reader
extends Object
implements IlvMapRegionOfInterestIterator, IlvPersistentObject
```
This class reads an S57 file or catalog and provides the selected map features.

Since:

JViews 8.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AGENCY_ATTR` Name of the feature attribute that contains agency name.
`protected ArrayList<ilog.views.maps.defense.format.s57.S57Reader.FRIDRecord>`	`allFeatures` the current list of features
`static String`	`CODE_ATTR` Name of the feature attribute that contains S57 object code number.
`static String`	`CODENAME_ATTR` Name of the feature attribute that contains S57 object code name.
`static String`	`GROUP_ATTR` Name of the feature attribute that contains S57 group number.
`static String`	`ID_ATTR` Name of the feature attribute that contains S57 object id.
`static String`	`TYPE_ATTR` Name of the feature attribute that contains primitive type.

Constructor Summary

Constructors
Constructor and Description
`IlvS57Reader()` Creates a new `IlvS57Reader`.
`IlvS57Reader(IlvInputStream stream)` Reconstructs an S57 reader from parameters read from an input stream.
`IlvS57Reader(String fileName)` Reads an S57 file (if `fileName` ends with 000) or a catalog.
`IlvS57Reader(URL url)` Reads an S57 file (if `fileName` ends with 000) or a catalog.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearFeatures()` Clears all the features read.
`IlvMapRegionOfInterestIterator`	`deriveReader(IlvFeatureClassInformation vfeatureClass, IlvGeometryClassFilter vgeometryClass)` Creates a derived reader that only returns features with the selected feature class and geometry class.
`void`	`dispose()` Releases the resources allocated by the feature iterator (files, connections, and so on).
`static String`	`findAttributeNameFromLabel(String label)` A utility method to retrieve the S57 attribute identifier from the attribute label.
`IlvCoordinateSystem`	`getCoordinateSystem()` Returns the spatial reference system that describes the coordinate system of geometric coordinates of the map features.
`IlvFeatureRenderer`	`getDefaultFeatureRenderer()` Returns a renderer that can be used to translate the map features returned by this iterator into graphic objects.
`ilog.views.maps.defense.format.s57.S57Reader.FRIDRecord[]`	`getFeatures()`
`Rectangle2D`	`getLatLonBounds()` Computes the bounds for all the features read.
`IlvCoordinate`	`getLowerRightCorner()` Returns the lower right corner of the rectangle containing all the map feature of the list, or `null` if the iterator cannot provide this information.
`IlvThreadMonitoringData`	`getMonitoringData()` Returns the thread monitoring information.
`IlvMapFeature`	`getNextFeature()` Returns the next map feature of the iterator or `null` if the iteration is finished.
`IlvCoordinate`	`getUpperLeftCorner()` Returns the upper left corner of the rectangle containing all the map features of the list, or `null` if the iterator cannot provide this information.
`boolean`	`isGeoreferenced()` Returns `true` if the map reader can provide the source projection of its map features.
`void`	`readCatalog(URL catalogURL, boolean skipNon000Files, IlvThreadMonitoringData data)` Reads a S57 catalog.
`ilog.views.maps.defense.format.s57.S57Reader.DSIDRecord`	`readFile(URL url)` Decodes a file.
`void`	`restart()` Rewinds the iterator for a new use.
`void`	`setFeatureClassFilter(IlvFeatureClassInformation vfeatureClass)` Sets a filter on the S57 code.
`void`	`setGeometryClassFilter(IlvGeometryClassFilter vgeometryClass)` Sets a filter on the geometry class.
`void`	`setMonitoringData(IlvThreadMonitoringData monitorData)` Sets the thread monitoring information.
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - AGENCY_ATTR
```
public static final String AGENCY_ATTR
```
    Name of the feature attribute that contains agency name.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    Constant Field Values
  - ID_ATTR
```
public static final String ID_ATTR
```
    Name of the feature attribute that contains S57 object id.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    Constant Field Values
  - CODE_ATTR
```
public static final String CODE_ATTR
```
    Name of the feature attribute that contains S57 object code number.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    Constant Field Values
  - GROUP_ATTR
```
public static final String GROUP_ATTR
```
    Name of the feature attribute that contains S57 group number.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    Constant Field Values
  - TYPE_ATTR
```
public static final String TYPE_ATTR
```
    Name of the feature attribute that contains primitive type.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    Constant Field Values
  - CODENAME_ATTR
```
public static final String CODENAME_ATTR
```
    Name of the feature attribute that contains S57 object code name.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    Constant Field Values
  - allFeatures
```
protected ArrayList<ilog.views.maps.defense.format.s57.S57Reader.FRIDRecord> allFeatures
```
    the current list of features
- Constructor Detail
  - IlvS57Reader
```
public IlvS57Reader()
```
    Creates a new IlvS57Reader.
  - IlvS57Reader
```
public IlvS57Reader(String fileName)
             throws IOException
```
    Reads an S57 file (if fileName ends with 000) or a catalog. The resulting features can be retrieved using
    
    Parameters:
    
    fileName - The file name or catalog to read.
    
    Throws:
    
    IOException
  - IlvS57Reader
```
public IlvS57Reader(URL url)
             throws IOException
```
    Reads an S57 file (if fileName ends with 000) or a catalog. The resulting features can be retrieved using
    
    Parameters:
    
    url - URL of the S57 file.
    
    Throws:
    
    IOException - if the url cannot be opened.
  - IlvS57Reader
```
public IlvS57Reader(IlvInputStream stream)
```
    Reconstructs an S57 reader from parameters read from an input stream.
    
    Parameters:
    
    stream - The stream to read from.
- 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.
    
    See Also:
    
    IlvPersistentObject.write(ilog.views.io.IlvOutputStream)
  - getLatLonBounds
```
public Rectangle2D getLatLonBounds()
```
    Computes the bounds for all the features read.
    
    Specified by:
    
    getLatLonBounds in interface IlvMapRegionOfInterestIterator
    
    Returns:
    
    The enclosing lat/lon bounds in degrees.
  - 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.
    
    See Also:
    
    IlvMapRegionOfInterestIterator.setRegionOfInterest(double, double, double, double)
  - restart
```
public void restart()
```
    Rewinds the iterator for a new use.
    
    Specified by:
    
    restart in interface IlvMapReusableFeatureIterator
    
    See Also:
    
    IlvMapReusableFeatureIterator.restart()
  - getMonitoringData
```
public IlvThreadMonitoringData getMonitoringData()
```
    Returns the thread monitoring information.
    
    Returns:
    
    The monitorData.
  - setMonitoringData
```
public void setMonitoringData(IlvThreadMonitoringData monitorData)
```
    Sets the thread monitoring information.
    
    Parameters:
    
    monitorData - The monitorData to set.
  - 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
    
    See Also:
    
    IlvMapFeatureIterator.getNextFeature()
  - 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
    
    See Also:
    
    IlvMapFeatureIterator.isGeoreferenced()
  - 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
    
    Returns:
    
    The coordinate system, or null if the coordinate system is unknown.
    
    See Also:
    
    IlvMapFeatureIterator.getCoordinateSystem()
  - getUpperLeftCorner
```
public IlvCoordinate getUpperLeftCorner()
```
    Returns the upper left corner of the rectangle containing all the map features of the list, or null if the iterator cannot provide this information.
    
    Specified by:
    
    getUpperLeftCorner in interface IlvMapFeatureIterator
    
    See Also:
    
    IlvMapFeatureIterator.getUpperLeftCorner()
  - getLowerRightCorner
```
public IlvCoordinate getLowerRightCorner()
```
    Returns the lower right corner of the rectangle containing all the map feature of the list, or null if the iterator cannot provide this information.
    
    Specified by:
    
    getLowerRightCorner in interface IlvMapFeatureIterator
    
    See Also:
    
    IlvMapFeatureIterator.getLowerRightCorner()
  - getDefaultFeatureRenderer
```
public IlvFeatureRenderer getDefaultFeatureRenderer()
```
    Returns a renderer that can be used to translate the map features returned by this iterator into graphic objects. Feature iterators that store some rendering information in the attributes of the map features, such as color, text font, line thickness and so on, can return a specific renderer which is able to take these attributes into account during the rendering process.
    
    Specified by:
    
    getDefaultFeatureRenderer in interface IlvMapFeatureIterator
    
    See Also:
    
    IlvMapFeatureIterator.getDefaultFeatureRenderer()
  - dispose
```
public void dispose()
```
    Releases the resources allocated by the feature iterator (files, connections, and so on).
    
    Specified by:
    
    dispose in interface IlvMapFeatureIterator
    
    See Also:
    
    IlvMapFeatureIterator.dispose()
  - deriveReader
```
public IlvMapRegionOfInterestIterator deriveReader(IlvFeatureClassInformation vfeatureClass,
                                                   IlvGeometryClassFilter vgeometryClass)
```
    Creates a derived reader that only returns features with the selected feature class and geometry class.
    
    Parameters:
    
    vfeatureClass - The feature class to filter features with.
    
    vgeometryClass - Information about the subclass of IlvMapGeometry to prevent the mixing of different types of feature on the same layer.
    
    Returns:
    
    A new reader, based on the geometries of this reader.
    
    See Also:
    
    setFeatureClassFilter(IlvFeatureClassInformation), setGeometryClassFilter(IlvGeometryClassFilter)
  - setFeatureClassFilter
```
public void setFeatureClassFilter(IlvFeatureClassInformation vfeatureClass)
```
    Sets a filter on the S57 code.
    
    Parameters:
    
    vfeatureClass - Information about the feature to filter.
  - setGeometryClassFilter
```
public void setGeometryClassFilter(IlvGeometryClassFilter vgeometryClass)
```
    Sets a filter on the geometry class.
    
    Parameters:
    
    vgeometryClass - Information about the accepted geometries.
  - findAttributeNameFromLabel
```
public static String findAttributeNameFromLabel(String label)
```
    A utility method to retrieve the S57 attribute identifier from the attribute label.
    
    Parameters:
    
    label - The label to find the identifier for.
    
    Returns:
    
    The identifier. For example, BUSIGL.
    
    Since:
    
    JViews 8.1
  - readFile
```
public ilog.views.maps.defense.format.s57.S57Reader.DSIDRecord readFile(URL url)
                                                                 throws IOException
```
    Decodes a file.
    
    Parameters:
    
    url - url of the S57 file.
    
    Returns:
    
    a record containing global information on the file.
    
    Throws:
    
    IOException
  - getFeatures
```
public ilog.views.maps.defense.format.s57.S57Reader.FRIDRecord[] getFeatures()
```
    Returns:
    
    Returns the list of features.
  - readCatalog
```
public void readCatalog(URL catalogURL,
                        boolean skipNon000Files,
                        IlvThreadMonitoringData data)
                 throws IOException
```
    Reads a S57 catalog.
    
    Parameters:
    
    catalogURL -
    
    skipNon000Files -
    
    data -
    
    Throws:
    
    IOException
  - clearFeatures
```
public void clearFeatures()
```
    Clears all the features read.

Class IlvS57Reader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AGENCY_ATTR

ID_ATTR

CODE_ATTR

GROUP_ATTR

TYPE_ATTR

CODENAME_ATTR

allFeatures

Constructor Detail

IlvS57Reader

IlvS57Reader

IlvS57Reader

IlvS57Reader

Method Detail

write

getLatLonBounds

setRegionOfInterest

restart

getMonitoringData

setMonitoringData

getNextFeature

isGeoreferenced

getCoordinateSystem

getUpperLeftCorner

getLowerRightCorner

getDefaultFeatureRenderer

dispose

deriveReader

setFeatureClassFilter

setGeometryClassFilter

findAttributeNameFromLabel

readFile

getFeatures

readCatalog

clearFeatures