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

Class AnnotationTargetProductDescriptor

java.lang.Object

org.esa.snap.core.gpf.descriptor.AnnotationTargetProductDescriptor

All Implemented Interfaces:

DataElementDescriptor, ElementDescriptor, TargetProductDescriptor

public class AnnotationTargetProductDescriptor
extends Object
implements TargetProductDescriptor

A TargetProductDescriptor implementation for the TargetProduct annotation.

Since:

BEAM 5

Constructor Summary

Constructors

Constructor	Description
AnnotationTargetProductDescriptor(String name, TargetProduct annotation)

Method Summary

Modifier and Type	Method	Description
String	getAlias()
TargetProduct	getAnnotation()
Class<? extends Product>	getDataType()
String	getDescription()
String	getLabel()
String	getName()

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationTargetProductDescriptor

public AnnotationTargetProductDescriptor(String name,
                                         TargetProduct 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 TargetProduct getAnnotation()

getAlias

public String getAlias()

Specified by:

getAlias in interface ElementDescriptor

Returns:

A short form of the symbolic name, 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.

getDescription

public String getDescription()

Specified by:

getDescription in interface ElementDescriptor

Returns:

A short description, or null if not declared.

getDataType

public Class<? extends Product> getDataType()

Specified by:

getDataType in interface DataElementDescriptor

Specified by:

getDataType in interface TargetProductDescriptor

Returns:

The target product type. Defaults to Product.