com.luciad.format.s52.lightspeed

Maritime StandardsClass TLspS52LayerBuilder

java.lang.Object

com.luciad.view.lightspeed.layer.ALspLayerBuilder

com.luciad.format.s52.lightspeed.TLspS52LayerBuilder

public class TLspS52LayerBuilder
extends ALspLayerBuilder

Layer builder for S57 data with S52 visualization.

Supports models for an individual cell, or for whole catalogues.

Example:

   String source = ...;
   ILcdModelDecoder decoder = new TLcdS57UnifiedModelDecoder();
   ILcdModel s57Model = decoder.decode( source );
   ILspLayer layer = TLspS52LayerBuilder.newBuilder().model(s57Model).build();
 

Note: it is not allowed to wrap the output of the S57 model decoder in an ordered model.

Since:

2013.1

See Also:

TLcdS52GXYLayerFactory to create layers in GXY view.

Method Summary

Modifier and Type	Method and Description
ILspInteractivePaintableLayer	build() Creates the layer.
TLspS52LayerBuilder	filter(ILcdDynamicFilter aFilter) Specify a filter on the objects on this layer.
TLspS52LayerBuilder	icon(ILcdIcon aIcon) Sets the icon of the layer.
TLspS52LayerBuilder	label(String aLabel) Sets the label of the layer.
TLspS52LayerBuilder	layerStyle(TLspLayerStyle aLayerStyle) Set a layer style to be used during the rendering of the layer.
TLspS52LayerBuilder	layerType(ILspLayer.LayerType aLayerType) Sets the layer type of the layer.
TLspS52LayerBuilder	model(ILcdModel aModel) Sets the model the layer should be created for.
static TLspS52LayerBuilder	newBuilder() Creates a new builder with default settings.
TLspS52LayerBuilder	opacity(float aOpacity) Sets the overall transparency of the layer with a TLspLayerStyle.
TLspS52LayerBuilder	s52DisplaySettings(TLcdS52DisplaySettings aDisplaySettings) Specify the S52 display settings to use in this layer.
TLspS52LayerBuilder	s52ProductConfiguration(TLcdS52ProductConfiguration aProductConfiguration) Specify the S52 product configuration to use in this layer.
TLspS52LayerBuilder	s52Symbology(ILcdS52Symbology aSymbology) Specify the S52 symbology to use in this layer.
TLspS52LayerBuilder	s57ProductConfiguration(TLcdS57ProductConfiguration aProductConfiguration) Specify the S57 product configuration to use in this layer.
TLspS52LayerBuilder	selectable(boolean aSelectable) Sets whether the elements in the layer should be selectable.

Methods inherited from class com.luciad.view.lightspeed.layer.ALspLayerBuilder

getIcon, getLabel, getLayerStyle, getLayerType, getModel

Methods inherited from class java.lang.Object

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

Method Detail

build

public ILspInteractivePaintableLayer build()

Creates the layer.

Before building the layer, you must have set a model.

Specified by:

build in class ALspLayerBuilder

Returns:

the new layer instance

Throws:

IllegalStateException - if no model has been specified

model

public TLspS52LayerBuilder model(ILcdModel aModel)

Sets the model the layer should be created for.

Setting a model is mandatory.

The model must be an S57 model: it must have a TLcdS57CatalogueModelDescriptor or TLcdS57ModelDescriptor and contain S57 objects.

Note: it is not allowed to wrap the output of the S57 model decoder in an ordered model.

Overrides:

model in class ALspLayerBuilder

Parameters:

aModel - a model, not null

Returns:

this

Throws:

IllegalArgumentException - if the model is not a proper S57 model or when the model is an ordered model.

See Also:

ILcdLayer.getModel()

label

public TLspS52LayerBuilder label(String aLabel)

Description copied from class: ALspLayerBuilder

Sets the label of the layer. This is a short textual representation for it, often used to represent the layer to end-users.

The default value is null.

Overrides:

label in class ALspLayerBuilder

Parameters:

aLabel - the label

Returns:

this builder

See Also:

ILcdLayer.getLabel()

icon

public TLspS52LayerBuilder icon(ILcdIcon aIcon)

Description copied from class: ALspLayerBuilder

Sets the icon of the layer.

The default value is null.

Overrides:

icon in class ALspLayerBuilder

Parameters:

aIcon - the icon

Returns:

this builder

See Also:

ILcdLayer.getIcon()

s52DisplaySettings

public TLspS52LayerBuilder s52DisplaySettings(TLcdS52DisplaySettings aDisplaySettings)

Specify the S52 display settings to use in this layer.

This call is optional. If not specified, the default TLcdS52DisplaySettings will be used.

Parameters:

aDisplaySettings - S52 display settings to use.

Returns:

this

s57ProductConfiguration

public TLspS52LayerBuilder s57ProductConfiguration(TLcdS57ProductConfiguration aProductConfiguration)

Specify the S57 product configuration to use in this layer.

This call is optional. It is only necessary when you have customized S-57 attributes. If not specified, the default will be used.

This product configuration should preferable be the one used when decoding the S-57 model.

Parameters:

aProductConfiguration - S57 product configuration to use.

Returns:

this

s52ProductConfiguration

public TLspS52LayerBuilder s52ProductConfiguration(TLcdS52ProductConfiguration aProductConfiguration)

Specify the S52 product configuration to use in this layer.

This call is optional. If not specified, the default will be used.

The S52 product configuration is only used to create the ILcdS52Symbology, but you can also call s52Symbology(com.luciad.format.s52.ILcdS52Symbology) to specify a custom ILcdS52Symbology directly.

Parameters:

aProductConfiguration - S52 product configuration to use.

Returns:

this

s52Symbology

public TLspS52LayerBuilder s52Symbology(ILcdS52Symbology aSymbology)

Specify the S52 symbology to use in this layer.

This call is optional. If not specified, the default symbology from the S-52 product configuration will be used, based on the display settings.

Parameters:

aSymbology - S52 symbology to use.

Returns:

this

filter

public TLspS52LayerBuilder filter(ILcdDynamicFilter aFilter)

Specify a filter on the objects on this layer.

Operations on this layer will only be applied to objects of the model that pass the filter. This includes painting, labeling, selection, editing, ...

This call is optional. If not specified, no filter is applied.

See ALcdDynamicFilter for a convenience class that handles change listeners and events.

Parameters:

aFilter - The filter to set

Returns:

this

selectable

public TLspS52LayerBuilder selectable(boolean aSelectable)

Sets whether the elements in the layer should be selectable.

By default, this is on (true).

Parameters:

aSelectable - whether the layer should be selectable

Returns:

this

layerType

public TLspS52LayerBuilder layerType(ILspLayer.LayerType aLayerType)

Description copied from class: ALspLayerBuilder

Sets the layer type of the layer.

The default value is ILspLayer.LayerType.EDITABLE.

Overrides:

layerType in class ALspLayerBuilder

Parameters:

aLayerType - the layer type

Returns:

this builder

See Also:

ILspLayer.getLayerType()

opacity

public TLspS52LayerBuilder opacity(float aOpacity)

Sets the overall transparency of the layer with a TLspLayerStyle.

By default, this is 1 (fully opaque).

Parameters:

aOpacity - Transparency of the new layer, between 0 (fully transparent) and 1 (fully opaque).

layerStyle

public TLspS52LayerBuilder layerStyle(TLspLayerStyle aLayerStyle)

Description copied from class: ALspLayerBuilder

Set a layer style to be used during the rendering of the layer. TLspLayerStyle is used to style the layer as a whole. Layer style can for example modify the transparency of a layer. Also, layer style can be modified after building the layer by calling ILspLayer.setLayerStyle(TLspLayerStyle).

Overrides:

layerStyle in class ALspLayerBuilder

Parameters:

aLayerStyle - the layer style. Must not be null. If you want to set the default layer style, set TLspLayerStyle.newBuilder().build()

Returns:

this

See Also:

ILspLayer.getLayerStyle(), ILspLayer.setLayerStyle(TLspLayerStyle)

newBuilder

public static TLspS52LayerBuilder newBuilder()

Creates a new builder with default settings.

Before using build() to create the layer, you must specify a model.

Returns:

A new builder with default settings.