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

Class AnnotationSourceProductsDescriptor

java.lang.Object

org.esa.snap.core.gpf.descriptor.AnnotationSourceProductsDescriptor

All Implemented Interfaces:

DataElementDescriptor, ElementDescriptor, SourceProductsDescriptor

public class AnnotationSourceProductsDescriptor
extends Object
implements SourceProductsDescriptor

A SourceProductsDescriptor implementation for the SourceProducts annotation.

Since:

BEAM 5

Constructor Summary

Constructors

Constructor	Description
AnnotationSourceProductsDescriptor(String name, SourceProducts annotation)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationSourceProductsDescriptor

public AnnotationSourceProductsDescriptor(String name,
                                          SourceProducts 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 SourceProducts getAnnotation()

getCount

public int getCount()

Specified by:

getCount in interface SourceProductsDescriptor

Returns:

the number of source products expected. The value -1 means any number but at least one source product. Defaults to 0 (= not set).

getProductType

public String getProductType()

Specified by:

getProductType in interface SourceProductsDescriptor

Returns:

The product type or a regular expression identifying the allowed product types. Defaults to the empty string (= not set).

See Also:

Pattern

getBands

public String[] getBands()

Specified by:

getBands in interface SourceProductsDescriptor

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 SourceProductsDescriptor

Returns:

The source product type. Defaults to Product[].