Package org.esa.snap.ui.layer
Interface LayerSourceDescriptor
- All Known Implementing Classes:
DefaultLayerSourceDescriptor
public interface LayerSourceDescriptor
The
LayerSourceDescriptor
provides metadata and
a factory method for a LayerSource
.
Note: This API is not public yet and may significantly change in the future. Use it at your own risk.
- Since:
- BEAM 4.6
- Version:
- $ Revision $ $ Date $
-
Method Summary
Modifier and TypeMethodDescriptionCreates theLayerSource
which is used in the graphical user interface to addLayer
to a view.A text describing what theLayerSource
, created by thisLayerSourceDescriptor
, does.getId()
A unique ID.TheLayerType
.getName()
A human readable name.
-
Method Details
-
getId
String getId()A unique ID.- Returns:
- The unique ID.
-
getName
String getName()A human readable name.- Returns:
- The name.
-
getDescription
String getDescription()A text describing what theLayerSource
, created by thisLayerSourceDescriptor
, does.- Returns:
- A description.
-
createLayerSource
LayerSource createLayerSource()Creates theLayerSource
which is used in the graphical user interface to addLayer
to a view.- Returns:
- The
LayerSource
.
-
getLayerType
LayerType getLayerType()TheLayerType
.- Returns:
- the type of the layer which is added to a view, or
null
if multiple layers are added.
-