org.esa.beam.framework.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 $
Author:
Marco Peters, Marco Zühlke

Method Summary
 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.
 com.bc.ceres.glayer.LayerType getLayerType()
          The LayerType.
 String getName()
          A human readable name.
 

Method Detail

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 the LayerSource, created by this LayerSourceDescriptor, does.

Returns:
A description.

createLayerSource

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

Returns:
The LayerSource.

getLayerType

com.bc.ceres.glayer.LayerType getLayerType()
The LayerType.

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


Copyright © 2002-2012 Brockmann Consult GmbH. All Rights Reserved.