Package com.luciad.format.s101.view.lightspeed

Class TLspS101LayerBuilder

java.lang.Object

com.luciad.view.lightspeed.layer.ALspLayerBuilder

com.luciad.format.s101.view.lightspeed.TLspS101LayerBuilder

public final class TLspS101LayerBuilder
extends ALspLayerBuilder

Layer builder for S-101 data.

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

Example:

   String source = ...;
   ILcdModelDecoder decoder = new TLcdS101ModelDecoder();
   ILcdModel s101Model = decoder.decode( source );
   ILspLayer layer = TLspS101LayerBuilder.newBuilder().model(s101Model).build();
 

Since:

2026.0

See Also:

• TLcdS101GXYLayer to create layers in GXY view.

Method Summary

Modifier and Type	Method	Description
ILspLayer	build()	Creates a new layer instance.
TLspS101LayerBuilder	displaySettings(TLcdS101DisplaySettings aDisplaySettings)	Specify the S-101 display settings to use in this layer.
TLspS101LayerBuilder	icon(ILcdIcon aIcon)	Sets the icon of the layer.
TLspS101LayerBuilder	label(String aLabel)	Sets the label of the layer.
TLspS101LayerBuilder	layerStyle(TLspLayerStyle aLayerStyle)	Set a layer style to be used during the rendering of the layer.
TLspS101LayerBuilder	model(ILcdModel aModel)	Sets the model for the layer.
static TLspS101LayerBuilder	newBuilder()	Creates a new builder with default settings.

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

getIcon, getLabel, getLayerStyle, getLayerType, getModel, layerType

Methods inherited from class java.lang.Object

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

Method Details

newBuilder

public static TLspS101LayerBuilder newBuilder()

Creates a new builder with default settings.

Returns:

A new builder with default settings.

model

public TLspS101LayerBuilder model(ILcdModel aModel)

Sets the model for the layer.

Setting a model is mandatory.

The model must be an S-101 model: it must originate from the TLcdS101ModelDecoder.

Overrides:

model in class ALspLayerBuilder

Parameters:

aModel - a model, not null

Returns:

this

See Also:

• ILcdLayer.getModel()

label

public TLspS101LayerBuilder 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 TLspS101LayerBuilder 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()

layerStyle

public TLspS101LayerBuilder 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)

displaySettings

public TLspS101LayerBuilder displaySettings(TLcdS101DisplaySettings aDisplaySettings)

Specify the S-101 display settings to use in this layer.

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

Parameters:

aDisplaySettings - S-101 display settings to use.

Returns:

this

build

public ILspLayer build()

Creates a new layer instance.

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