Package org.esa.snap.core.layer

Class MaskLayerType

java.lang.Object

com.bc.ceres.core.ExtensibleObject

com.bc.ceres.glayer.LayerType

com.bc.ceres.glayer.support.ImageLayer.Type

org.esa.snap.core.layer.MaskLayerType

All Implemented Interfaces:

Extensible

@LayerTypeMetadata(name="MaskLayerType",
                   aliasNames="org.esa.snap.core.layer.MaskLayerType")
public class MaskLayerType
extends ImageLayer.Type

A layer used to display Masks.

Since:

BEAM 4.7

Version:

$ Revision: $ Date: $

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROPERTY_NAME_MASK

Constructor Summary

Constructors

Constructor	Description
MaskLayerType()

Method Summary

Modifier and Type	Method	Description
Layer	createLayer(LayerContext ctx, PropertySet configuration)	Creates a layer instance for the given application provided context and the given layer configuration.
static Layer	createLayer(RasterDataNode raster, Mask mask)
PropertySet	createLayerConfig(LayerContext ctx)	Creates a default configuration instance for the type of layers this type can create.
static MultiLevelSource	createMultiLevelSource(PropertySet configuration)
static MultiLevelSource	createMultiLevelSource(Mask mask)

Methods inherited from class com.bc.ceres.glayer.support.ImageLayer.Type

isValidFor

Methods inherited from class com.bc.ceres.glayer.LayerType

createWithSceneView, getAliases, getName

Methods inherited from class com.bc.ceres.core.ExtensibleObject

getExtension

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_NAME_MASK

public static final String PROPERTY_NAME_MASK

See Also:

Constant Field Values

Constructor Detail

MaskLayerType

public MaskLayerType()

Method Detail

createLayer

public static Layer createLayer(RasterDataNode raster,
                                Mask mask)

createLayer

public Layer createLayer(LayerContext ctx,
                         PropertySet configuration)

Description copied from class: LayerType

Creates a layer instance for the given application provided context and the given layer configuration. The configuration may contain both, inmutable construction parameters passed to specific layer constructor as well as mutable layer properties.

Overrides:

createLayer in class ImageLayer.Type

Parameters:

ctx - An application provided context, may be null. The parameter may be ignored by many layer types.

configuration - The layer configuration.

Returns:

A new layer instance.

createMultiLevelSource

public static MultiLevelSource createMultiLevelSource(PropertySet configuration)

createMultiLevelSource

public static MultiLevelSource createMultiLevelSource(Mask mask)

createLayerConfig

public PropertySet createLayerConfig(LayerContext ctx)

Description copied from class: LayerType

Creates a default configuration instance for the type of layers this type can create. After a default configuration has been created it is usually modified to specify a layer's construction parameters, e.g. for an image layer this could be the file path to the image file. Then, an application will pass the configuration to the LayerType.createLayer(com.bc.ceres.glayer.LayerContext, com.bc.ceres.binding.PropertySet) method in order to create a new layer instance.

Overrides:

createLayerConfig in class ImageLayer.Type

Parameters:

ctx - An application provided context, may be null. The parameter may be ignored by many layer types.

Returns:

A new layer (default) configuration.