Package org.esa.snap.ui.layer

Class CollectionLayerSource

java.lang.Object
org.esa.snap.ui.layer.CollectionLayerSource
All Implemented Interfaces:
LayerSource
public class CollectionLayerSource extends Object implements LayerSource
This layer source creates a new and empty collection layer.

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$

  • Constructor Details

    • CollectionLayerSource

      public CollectionLayerSource()

  • Method Details

    • isApplicable

      public boolean isApplicable(LayerSourcePageContext pageContext)
      Description copied from interface: LayerSource
      Check if this layer source is applicable to the current context.
      Specified by:
      isApplicable in interface LayerSource
      Parameters:
      pageContext - The current context.
      Returns:
      true, if this layer source is applicable.

    • hasFirstPage

      public boolean hasFirstPage()
      Specified by:
      hasFirstPage in interface LayerSource
      Returns:
      true, if this layer source has assistant pages.

    • getFirstPage

      public AbstractLayerSourceAssistantPage getFirstPage(LayerSourcePageContext pageContext)
      Description copied from interface: LayerSource
      Returns the first page (of possible many) of the assistant that belongs to this layer source. The given context can be interrogated to decide which page to return.
      Specified by:
      getFirstPage in interface LayerSource
      Parameters:
      pageContext - The current context.
      Returns:
      the first assistant page.

    • canFinish

      public boolean canFinish(LayerSourcePageContext pageContext)
      Description copied from interface: LayerSource
      Checks whether this layer source can perform its finishing method without further information.
      Specified by:
      canFinish in interface LayerSource
      Parameters:
      pageContext - The current context.
      Returns:
      true, if finish can be called.

    • performFinish

      public boolean performFinish(LayerSourcePageContext pageContext)
      Description copied from interface: LayerSource
      Adds one or more layers to the given context
      Specified by:
      performFinish in interface LayerSource
      Parameters:
      pageContext - The current context.
      Returns:
      true, if the method completed successfully

    • cancel

      public void cancel(LayerSourcePageContext pageContext)
      Description copied from interface: LayerSource
      Aborts the operation of this layer source. This method is responsible for freeing all resources acquired by the layer source.
      Specified by:
      cancel in interface LayerSource
      Parameters:
      pageContext - The current context.