org.esa.snap.ui.layer

Interface LayerSource

All Known Implementing Classes:

CollectionLayerSource, ImageFileLayerSource, ProductLayerSource, ShapefileLayerSource, SimpleLayerSource, WindFieldLayerSource, WmsLayerSource

public interface LayerSource

A layer source can add one or more layers to an already existing root 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: $

Method Summary

Modifier and Type	Method and Description
void	cancel(LayerSourcePageContext pageContext) Aborts the operation of this layer source.
boolean	canFinish(LayerSourcePageContext pageContext) Checks whether this layer source can perform its finishing method without further information.
AbstractLayerSourceAssistantPage	getFirstPage(LayerSourcePageContext pageContext) Returns the first page (of possible many) of the assistant that belongs to this layer source.
boolean	hasFirstPage()
boolean	isApplicable(LayerSourcePageContext pageContext) Check if this layer source is applicable to the current context.
boolean	performFinish(LayerSourcePageContext pageContext) Adds one or more layers to the given context

Method Detail

isApplicable

boolean isApplicable(LayerSourcePageContext pageContext)

Check if this layer source is applicable to the current context.

Parameters:

pageContext - The current context.

Returns:

true, if this layer source is applicable.

hasFirstPage

boolean hasFirstPage()

Returns:

true, if this layer source has assistant pages.

getFirstPage

AbstractLayerSourceAssistantPage getFirstPage(LayerSourcePageContext pageContext)

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.

Parameters:

pageContext - The current context.

Returns:

the first assistant page.

canFinish

boolean canFinish(LayerSourcePageContext pageContext)

Checks whether this layer source can perform its finishing method without further information.

Parameters:

pageContext - The current context.

Returns:

true, if finish can be called.

performFinish

boolean performFinish(LayerSourcePageContext pageContext)

Adds one or more layers to the given context

Parameters:

pageContext - The current context.

Returns:

true, if the method completed successfully

cancel

void cancel(LayerSourcePageContext pageContext)

Aborts the operation of this layer source. This method is responsible for freeing all resources acquired by the layer source.

Parameters:

pageContext - The current context.