org.esa.snap.ui.layer

Class DefaultLayerSourceDescriptor

java.lang.Object

org.esa.snap.ui.layer.DefaultLayerSourceDescriptor

All Implemented Interfaces:

LayerSourceDescriptor

public class DefaultLayerSourceDescriptor
extends Object
implements LayerSourceDescriptor

The DefaultLayerSourceDescriptor provides metadata and a factory method for a LayerSource.

Instances of this class are created by reading the extension configuration of the extension point "layerSources" in the module.xml.

Example 1:

    <extension point="beam-visat-rcp:layerSources">
      <layerSource>
          <id>shapefile-layer-source</id>
          <name>ESRI Shapefile</name>
          <description>Displays shapes from an ESRI Shapefile</description>
          <class>org.esa.snap.visat.toolviews.layermanager.layersrc.shapefile.ShapefileLayerSource</class>
      </layerSource>
    </extension>
 

Example 2:

    <extension point="beam-visat-rcp:layerSources">
      <layerSource>
          <id>bluemarble-layer-source</id>
          <name>NASA Blue Marble;/name>
          <description>Adds NASA Blue Marble image layer to the background.</description>
          <layerType>org.esa.snap.worldmap.BlueMarbleLayerType</class>
      </layerSource>
    </extension>
 

Note: This API is not public yet and may significantly change in the future. Use it at your own risk.

Constructor Summary

Constructors

Constructor and Description
DefaultLayerSourceDescriptor(String id, String name, String description, Class<? extends LayerSource> layerSourceClass)
DefaultLayerSourceDescriptor(String id, String name, String description, String layerTypeClassName)

Method Summary

Modifier and Type	Method and Description
LayerSource	createLayerSource() Creates the LayerSource which is used in the graphical user interface to add Layer to a view.
String	getDescription() A text describing what the LayerSource, created by this LayerSourceDescriptor, does.
String	getId() A unique ID.
LayerType	getLayerType() The LayerType.
String	getName() A human readable name.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultLayerSourceDescriptor

public DefaultLayerSourceDescriptor(String id,
                                    String name,
                                    String description,
                                    Class<? extends LayerSource> layerSourceClass)

DefaultLayerSourceDescriptor

public DefaultLayerSourceDescriptor(String id,
                                    String name,
                                    String description,
                                    String layerTypeClassName)

Method Detail

getId

public String getId()

Description copied from interface: LayerSourceDescriptor

A unique ID.

Specified by:

getId in interface LayerSourceDescriptor

Returns:

The unique ID.

getName

public String getName()

Description copied from interface: LayerSourceDescriptor

A human readable name.

Specified by:

getName in interface LayerSourceDescriptor

Returns:

The name.

getDescription

public String getDescription()

Description copied from interface: LayerSourceDescriptor

A text describing what the LayerSource, created by this LayerSourceDescriptor, does.

Specified by:

getDescription in interface LayerSourceDescriptor

Returns:

A description.

toString

public String toString()

Overrides:

toString in class Object

createLayerSource

public LayerSource createLayerSource()

Description copied from interface: LayerSourceDescriptor

Creates the LayerSource which is used in the graphical user interface to add Layer to a view.

Specified by:

createLayerSource in interface LayerSourceDescriptor

Returns:

The LayerSource.

getLayerType

public LayerType getLayerType()

Description copied from interface: LayerSourceDescriptor

The LayerType.

Specified by:

getLayerType in interface LayerSourceDescriptor

Returns:

the type of the layer which is added to a view, or null if multiple layers are added.