Package org.esa.snap.core.gpf.descriptor
Class DefaultSourceProductsDescriptor
- java.lang.Object
-
- org.esa.snap.core.gpf.descriptor.DefaultSourceProductsDescriptor
-
- All Implemented Interfaces:
DataElementDescriptor
,ElementDescriptor
,SourceProductsDescriptor
public class DefaultSourceProductsDescriptor extends Object implements SourceProductsDescriptor
Default implementation of theSourceProductsDescriptor
interface.- Since:
- BEAM 5
-
-
Constructor Summary
Constructors Constructor Description DefaultSourceProductsDescriptor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getAlias()
String[]
getBands()
int
getCount()
Class<? extends Product[]>
getDataType()
String
getDescription()
String
getLabel()
String
getName()
String
getProductType()
-
-
-
Method Detail
-
getName
public String getName()
- Specified by:
getName
in interfaceElementDescriptor
- Returns:
- The symbolic name used to unambiguously identify this element. E.g. the fully qualified name of a Java class.
-
getCount
public int getCount()
- Specified by:
getCount
in interfaceSourceProductsDescriptor
- Returns:
- the number of source products expected.
The value
-1
means any number but at least one source product. Defaults to0
(= not set).
-
getAlias
public String getAlias()
- Specified by:
getAlias
in interfaceElementDescriptor
- Returns:
- A short form of the symbolic name, or
null
if not declared.
-
getLabel
public String getLabel()
- Specified by:
getLabel
in interfaceElementDescriptor
- 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 interfaceElementDescriptor
- Returns:
- A short description, or
null
if not declared.
-
getProductType
public String getProductType()
- Specified by:
getProductType
in interfaceSourceProductsDescriptor
- 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 interfaceSourceProductsDescriptor
- Returns:
- The names of the bands which need to be present in the source product. Defaults to an empty array (= not set).
-
getDataType
public Class<? extends Product[]> getDataType()
- Specified by:
getDataType
in interfaceDataElementDescriptor
- Specified by:
getDataType
in interfaceSourceProductsDescriptor
- Returns:
- The source product type.
Defaults to
Product
[].
-
-