ilog.views.maps.defense.format.s57

Class IlvS57DataSource

java.lang.Object

ilog.views.maps.datasource.IlvMapDataSource

ilog.views.maps.datasource.IlvHierarchicalDataSource

ilog.views.maps.format.IlvDefaultTilableDataSource

ilog.views.maps.defense.format.s57.IlvS57DataSource

All Implemented Interfaces:

IlvPersistentObject

public class IlvS57DataSource
extends IlvDefaultTilableDataSource

IlvS57DataSource represents a data source to read S57 files.

Simplified rendering can be activated or deactivated by calling setSimplifiedRendering(boolean ).

Rendering Type	Description
Activated	Whatever the object attributes are, S52 symbols are rendered using a predefined icon for each object type. Polygon and polyline colors are likewise predefined.
Deactivated	Rogue Wave JViews Maps for Defense uses the IHO ECDIS Presentation library (Edition 3.3, March 2004) definitions to create S52 symbols according to attribute content.

The following limitations apply to the use of the ECDIS Presentation library:

• Conditional procedures defined in the document are not implemented. Exceptions to this are the partial implementation of DEPARE02 DEPCNT03 LIGHTS05 and QUAPOS01.
• Complex line sets are not used.
• S52 symbols are displayed based on the SIMPLIFIED look up table.
• The styling of polygons and areas is limited to the polygon style supported. It is built based on the PLAIN_BOUNDARIES, LINES_SET or SIMPLIFIED look up tables.
• S52 symbols for lights are not rotated.

Since:

JViews 8.0

Nested Class Summary

Nested classes/interfaces inherited from class ilog.views.maps.datasource.IlvHierarchicalDataSource

IlvHierarchicalDataSource.CriterionFilter, IlvHierarchicalDataSource.SingleAttributeFilter

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	S52COLORSETS The list of the available S52 color sets.

Fields inherited from class ilog.views.maps.format.IlvDefaultTilableDataSource

GeometryClassInformation

Fields inherited from class ilog.views.maps.datasource.IlvHierarchicalDataSource

featureIterator, filename, nameMap, styleMap

Fields inherited from class ilog.views.maps.datasource.IlvMapDataSource

renderer, usingGeodeticComputation

Constructor Summary

Constructors

Constructor and Description
IlvS57DataSource(IlvInputStream stream) Creates a new IlvS57DataSource instance.
IlvS57DataSource(String filename) Constructs an IlvS57DataSource from a file.
IlvS57DataSource(URL url) Constructs an IlvS57DataSource from the specified URL.

Method Summary

Modifier and Type	Method and Description
protected void	addLayer(IlvMapLayer parent, IlvMapLayer layer) Adds a specified IlvMapLayer in the specified parent layer.
protected IlvDefaultFeatureFilter	createDefaultFilter() Creates, at construction time, the filter that will be used to separate features into layers.
protected IlvMapReusableFeatureIterator	createFeatureIterator(String fileName) Method used in IlvDefaultTilableDataSource.IlvDefaultTilableDataSource(String) constructor to build the data source reader.
protected IlvMapReusableFeatureIterator	createFeatureIterator(URL url) Method used in the IlvDefaultTilableDataSource.IlvDefaultTilableDataSource(URL) constructor to build the data source reader.
protected IlvFeatureRenderer	createFeatureRenderer() This method has been overridden to render points using an IlvS52PointRenderer.
protected IlvMapRegionOfInterestIterator	createTiledIterator(IlvFeatureClassInformation featureValue, IlvGeometryClassFilter geometryClass) Creates an iterator to iterates through the map features searching for a specific area of interest.
String	getColorSet() Returns the S52 color set to use.
double	getDeepContour() Returns the deep contour depth in meters.
double	getSafetyContour() Returns the safety contour depth in meters.
double	getShallowContour() Returns the shallow contour depth in meters.
protected IlvMapStyle	getStyle(IlvMapFeature feature) Returns a map style for the specified feature.
protected void	initFeatureList() Specific initialization done when data source is created.
boolean	isFullLengthSectorLines() Indicates if full length sector lines should be displayed.
boolean	isShallowPattern() Indicates whether shallow pattern rendering is used.
boolean	isShowS52Text() Indicates whether S52 rendering will create text.
boolean	isSimplifiedRendering() Indicates whether simplified rendering is activated.
boolean	isTwoShades() Indicates if the two shades option is activated.
String	makeLayerName(String name, IlvGeometryClassFilter d) Creates a layer name from a feature name and a geometry class.
void	setColorSet(String colorSet) Sets the color set to use when rendering S52.
void	setDeepContour(double deepContour) Sets the deep contour depth.
void	setFullLengthSectorLines(boolean fullLengthSectorLines) Sets the full length sector lines.
void	setSafetyContour(double safetyContour) Sets the safety contour depth.
void	setShallowContour(double shallowContour) Sets the shallow contour depth.
void	setShallowPattern(boolean shallowPattern) Enables the shallow pattern option.
void	setShowS52Text(boolean showS52Text) Sets to true for S52 rendering to display text.
void	setSimplifiedRendering(boolean simplifiedRendering) Indicates whether simplified rendering is activated.
void	setTilingParameters(boolean useTiling, int rows, int columns) Sets tiling parameters for this data source.
void	setTwoShades(boolean twoShades) Sets the two shades option.
void	start() Starts this data source.

Methods inherited from class ilog.views.maps.format.IlvDefaultTilableDataSource

acceptsCode, createGenericTiles, createTiledLayers, getColumnCount, getFeatureFilterPropertyName, getFeatureIterator, getFeatureName, getGeometryClassFilters, getGeometryClassInformation, getLatMax, getLatMin, getLayerOrder, getLonMax, getLonMin, getMonitoringData, getRowCount, getURL, isMultiThreaded, isSourceDataAvailable, isUsingTiling, readInfo, reset, setAcceptedCodeList, setAreaOfinterest, setLayerOrder, setMonitoringData, setMultiThreaded, setupLayer, setupTiledLoaders, setURL, write

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

addCriterionFilter, createInsertionLayer, createStyle, getCriterionFilters, getFeatureRenderer, getFeatureRenderer, getKey, getMapLayer, isAcceptNullValues, removeAllCriterionFilters, removeCriterionFilter, setAcceptNullValues

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

addDataSourceListener, callListeners, getBackupDataSources, getCoordinateSystem, getDescription, getInsertionLayer, getManager, getName, getNode, getValidExtentions, hasInsertionLayer, initBackupDataSource, initInsertionLayer, isAttachingAttributes, isGrapherMode, isSaveBackupDataSources, isUsingBackupDataSource, isUsingGeodeticComputation, mapIntersects, removeDataSourceListener, setAttachingAttributes, setCoordinateSystem, setDescription, setFeatureRenderer, setForceUsingBackupDataSource, setGrapherMode, setInsertionLayer, setManager, setName, setSaveBackupDataSources, setValidExtentions, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

S52COLORSETS

public static final String[] S52COLORSETS

The list of the available S52 color sets.

Since:

JViews 8.1

Constructor Detail

IlvS57DataSource

public IlvS57DataSource(IlvInputStream stream)
                 throws IlvReadFileException

Creates a new IlvS57DataSource instance.

Parameters:

stream - The stream to be created.

Throws:

IlvReadFileException - if there is a problem reading from stream.

IlvS57DataSource

public IlvS57DataSource(String filename)
                 throws MalformedURLException

Constructs an IlvS57DataSource from a file.

Parameters:

filename - The name of the S57 file to read.

Throws:

MalformedURLException - if filename cannot be parsed as a URL

IlvS57DataSource

public IlvS57DataSource(URL url)
                 throws IOException

Constructs an IlvS57DataSource from the specified URL.

Parameters:

url - The name of the S57 file to read.

Throws:

IOException - if there is a problem reading from url.

Method Detail

getColorSet

public String getColorSet()

Returns the S52 color set to use.

Returns:

The S52 color set to use.

Since:

JViews 8.1

getDeepContour

public double getDeepContour()

Returns the deep contour depth in meters.

Returns:

The deep contour depth in meters.

Since:

JViews 8.1

getSafetyContour

public double getSafetyContour()

Returns the safety contour depth in meters.

Returns:

The safety contour depth in meters.

Since:

JViews 8.1

getShallowContour

public double getShallowContour()

Returns the shallow contour depth in meters.

Returns:

The shallow contour depth in meters.

Since:

JViews 8.1

isFullLengthSectorLines

public boolean isFullLengthSectorLines()

Indicates if full length sector lines should be displayed. Full length sector lines are 25mm long.

Returns:

If full length sector lines are activated, true is returned.

Since:

JViews 8.1

isShallowPattern

public boolean isShallowPattern()

Indicates whether shallow pattern rendering is used.

Returns:

If shallow pattern rendering is activated, true is returned.

Since:

JViews 8.1

isShowS52Text

public boolean isShowS52Text()

Indicates whether S52 rendering will create text. Examples of text used in the S52 specification are light information, and sea bed area names.

Returns:

If the S52 symbols rendered should include text, true is returned.

Since:

JViews 8.1

isSimplifiedRendering

public boolean isSimplifiedRendering()

Indicates whether simplified rendering is activated. Simplified rendering is the rendering used before Rogue Wave JViews Maps version 8.1.

Returns:

If simplified rendering is activated, true is returned.

Since:

JViews 8.1

isTwoShades

public boolean isTwoShades()

Indicates if the two shades option is activated.

Returns:

If the two shades option is activated, true is returned.

Since:

JViews 8.1

setColorSet

public void setColorSet(String colorSet)

Sets the color set to use when rendering S52. The color sets available in the current digital presentation library are as follows:

• "DAY"
• "NIGHT"
• "DUSK"

S52COLORSETS defines the list of available color sets.

Parameters:

colorSet - The color set to use.

Throws:

IllegalArgumentException - if colorSet is not in the S52COLORSETS list.

Since:

JViews 8.1

setDeepContour

public void setDeepContour(double deepContour)

Sets the deep contour depth. The default value is 30m.

Parameters:

deepContour - The new depth.

Since:

JViews 8.1

setFullLengthSectorLines

public void setFullLengthSectorLines(boolean fullLengthSectorLines)

Sets the full length sector lines. The default value is false.

Parameters:

fullLengthSectorLines - Set to true to enable full length sector lines.

Since:

JViews 8.1

setSafetyContour

public void setSafetyContour(double safetyContour)

Sets the safety contour depth. The default value is 30 m.

Parameters:

safetyContour - The new safety contour depth.

Since:

JViews 8.1

setShallowContour

public void setShallowContour(double shallowContour)

Sets the shallow contour depth. The default value is 2 m.

Parameters:

shallowContour - The new shallow contour depth.

Since:

JViews 8.1

setShallowPattern

public void setShallowPattern(boolean shallowPattern)

Enables the shallow pattern option. The default value is false.

Parameters:

shallowPattern - Set to true to enable the shallow pattern.

Since:

JViews 8.1

setShowS52Text

public void setShowS52Text(boolean showS52Text)

Sets to true for S52 rendering to display text. Examples of text used in the S52 specification are light information, and sea bed area names.

Parameters:

showS52Text - Set to true so rendering will create S52 symbols with text. The default value is false.

Since:

JViews 8.1

setSimplifiedRendering

public void setSimplifiedRendering(boolean simplifiedRendering)

Indicates whether simplified rendering is activated. Note that, if you use tiling, the rendering will always be simplified, so this setting is only useful in non tiled mode. Before JViews 8.1, simplified rendering was activated by default. Since JViews 8.1, simplified is now set to false by default. S52 is now rendered by decoding the digital presentation library. The following methods indicate how rendering will be performed by this instance of IlvS57DataSource:

• setShowS52Text(boolean)
• setDeepContour(double)
• setFullLengthSectorLines(boolean)
• setShallowContour(double)
• setShallowPattern(boolean)
• setSafetyContour(double)
• setColorSet(String)

For more information, see the IHO S57 documentation at http://www.iho.shom.fr.

Parameters:

simplifiedRendering - Set to true to use the simplified rendering.

Since:

JViews 8.1

setTwoShades

public void setTwoShades(boolean twoShades)

Sets the two shades option. The default value is true.

Parameters:

twoShades - Set to false to disable the two shades option.

Since:

JViews 8.1

start

public void start()
           throws Exception

Starts this data source. The rendering process is initiated. The map features are read from the reader, graphic objects are rendered and inserted into the manager.

Overrides:

start in class IlvDefaultTilableDataSource

Throws:

Exception

See Also:

IlvDefaultTilableDataSource.start()

addLayer

protected void addLayer(IlvMapLayer parent,
                        IlvMapLayer layer)

Adds a specified IlvMapLayer in the specified parent layer.

Overrides:

addLayer in class IlvDefaultTilableDataSource

Parameters:

parent - The parent layer.

layer - The IlvMapLayer to add.

See Also:

IlvDefaultTilableDataSource.addLayer(ilog.views.maps.beans.IlvMapLayer, ilog.views.maps.beans.IlvMapLayer)

createDefaultFilter

protected IlvDefaultFeatureFilter createDefaultFilter()

Creates, at construction time, the filter that will be used to separate features into layers. For example, this method can create an IlvDefaultFeatureFilter instance and pass the property used to split features.

Overrides:

createDefaultFilter in class IlvDefaultTilableDataSource

Returns:

The default feature filter that will be used to separate layers for this data source.

See Also:

IlvDefaultTilableDataSource.createDefaultFilter()

createFeatureIterator

protected IlvMapReusableFeatureIterator createFeatureIterator(String fileName)
                                                       throws IOException

Method used in IlvDefaultTilableDataSource.IlvDefaultTilableDataSource(String) constructor to build the data source reader. For example:

  protected void createFeatureIterator(String fileName)
  {
    return new IlvS57Reader(fileName);
  }
   

Specified by:

createFeatureIterator in class IlvDefaultTilableDataSource

Parameters:

fileName - The file parameter.

Returns:

The data source reader.

Throws:

IOException

See Also:

IlvDefaultTilableDataSource.createFeatureIterator(java.lang.String)

createFeatureIterator

protected IlvMapReusableFeatureIterator createFeatureIterator(URL url)
                                                       throws IOException

Method used in the IlvDefaultTilableDataSource.IlvDefaultTilableDataSource(URL) constructor to build the data source reader. For example:

  protected void createFeatureIterator(URL urlName)
  {
    return new IlvS57Reader(urlName);
  }
   

Specified by:

createFeatureIterator in class IlvDefaultTilableDataSource

Parameters:

url - The file parameter.

Returns:

The data source reader.

Throws:

IOException

See Also:

IlvDefaultTilableDataSource.createFeatureIterator(java.net.URL)

createFeatureRenderer

protected IlvFeatureRenderer createFeatureRenderer()
                                            throws Exception

This method has been overridden to render points using an IlvS52PointRenderer.

Overrides:

createFeatureRenderer in class IlvHierarchicalDataSource

Returns:

A renderer created for this datasource.

Throws:

Exception

Since:

JViews 8.1

See Also:

IlvHierarchicalDataSource.createFeatureRenderer()

createTiledIterator

protected IlvMapRegionOfInterestIterator createTiledIterator(IlvFeatureClassInformation featureValue,
                                                             IlvGeometryClassFilter geometryClass)

Creates an iterator to iterates through the map features searching for a specific area of interest.

Specified by:

createTiledIterator in class IlvDefaultTilableDataSource

Parameters:

featureValue - The value to filter features with.

geometryClass - A subclass of IlvMapGeometry used to prevent confusing different types of feature on the same layer.

Returns:

The feature iterator.

getStyle

protected IlvMapStyle getStyle(IlvMapFeature feature)
                        throws Exception

Returns a map style for the specified feature. If necessary, a new style is created through IlvHierarchicalDataSource.createStyle(Class, Object)

Overrides:

getStyle in class IlvHierarchicalDataSource

Parameters:

feature - The IlvMapFeature.

Returns:

An IlvMapStyle for the feature

Throws:

Exception - if an appropriate style could not be found for the specified feature.

See Also:

IlvHierarchicalDataSource.getStyle(ilog.views.maps.IlvMapFeature)

initFeatureList

protected void initFeatureList()

Specific initialization done when data source is created. It should be used to retrieve the possible feature codes that the data source can manage.

Specified by:

initFeatureList in class IlvDefaultTilableDataSource

See Also:

IlvDefaultTilableDataSource.initFeatureList()

setTilingParameters

public void setTilingParameters(boolean useTiling,
                                int rows,
                                int columns)

Sets tiling parameters for this data source. Note that, if you use tiling, the rendering will always be simplified, so this setting is only useful in non tiled mode.

Overrides:

setTilingParameters in class IlvDefaultTilableDataSource

Parameters:

useTiling - If true, this data source will use the load-on-demand mechanism for loading data. If false, all the data will be loaded when the start method is called.

rows - The number of rows of tiles (only when useTiling is true);

columns - The number of columns of tiles (only when useTiling is true);

Since:

JViews 8.7

See Also:

setSimplifiedRendering(boolean)

makeLayerName

public String makeLayerName(String name,
                            IlvGeometryClassFilter d)

Creates a layer name from a feature name and a geometry class.

Overrides:

makeLayerName in class IlvDefaultTilableDataSource

Parameters:

name - The feature name.

d - The geometry class.

Returns:

A string to use as a layer name.

See Also:

IlvDefaultTilableDataSource.makeLayerName(java.lang.String, ilog.views.maps.format.IlvGeometryClassFilter)