Package org.esa.snap.core.gpf.descriptor

Class AnnotationSourceProductDescriptor

java.lang.Object

org.esa.snap.core.gpf.descriptor.AnnotationSourceProductDescriptor

All Implemented Interfaces:

DataElementDescriptor, ElementDescriptor, SourceProductDescriptor

public class AnnotationSourceProductDescriptor
extends Object
implements SourceProductDescriptor

A SourceProductDescriptor implementation for the SourceProduct annotation.

Since:

BEAM 5

Constructor Summary

Constructors

Constructor	Description
AnnotationSourceProductDescriptor(String name, SourceProduct annotation)

Method Summary

Modifier and Type	Method	Description
String	getAlias()
SourceProduct	getAnnotation()
String[]	getBands()
Class<? extends Product>	getDataType()
String	getDescription()
String	getLabel()
String	getName()
String	getProductType()
boolean	isOptional()

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationSourceProductDescriptor

public AnnotationSourceProductDescriptor(String name,
                                         SourceProduct annotation)

Method Detail

getName

public String getName()

Specified by:

getName in interface ElementDescriptor

Returns:

The symbolic name used to unambiguously identify this element. E.g. the fully qualified name of a Java class.

getAnnotation

public SourceProduct getAnnotation()

isOptional

public boolean isOptional()

Specified by:

isOptional in interface SourceProductDescriptor

Returns:

true if the source product is optional. Defaults to false.

getProductType

public String getProductType()

Specified by:

getProductType in interface SourceProductDescriptor

Returns:

The product type or a regular expression identifying the allowed product types, or null if not declared.

See Also:

Pattern

getBands

public String[] getBands()

Specified by:

getBands in interface SourceProductDescriptor

Returns:

The names of the bands which need to be present in the source product. Defaults to an empty array (= not set).

getAlias

public String getAlias()

Specified by:

getAlias in interface ElementDescriptor

Returns:

A short form of the symbolic name, or null if not declared.

getDescription

public String getDescription()

Specified by:

getDescription in interface ElementDescriptor

Returns:

A short description, or null if not declared.

getLabel

public String getLabel()

Specified by:

getLabel in interface ElementDescriptor

Returns:

A human-readable version of the symbolic name to be used in user interfaces, or null if not declared.

getDataType

public Class<? extends Product> getDataType()

Specified by:

getDataType in interface DataElementDescriptor

Specified by:

getDataType in interface SourceProductDescriptor

Returns:

The source product type. Defaults to Product.