org.esa.beam.framework.gpf.annotations
Annotation Type SourceProduct

@Documented
@Inherited
@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface SourceProduct

Marks a source product field of an Operator. The field must be of type Product.

Optional Element Summary

String	alias
String[]	bands
String	description
String	label
boolean	optional
String	type

optional

public abstract boolean optional

Returns:

true if the source product is optional. In this case the field value thus may be null. Defaults to false.

Default:

false

type

public abstract String type

Returns:

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

See Also:

Pattern

Default:

""

bands

public abstract String[] bands

Returns:

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

Default:

{}

alias

public abstract String alias

Returns:

The alias identifier. Defaults to the empty string (= not set).

Default:

""

description

public abstract String description

Returns:

A brief description of the source product. Defaults to the empty string (= not set).

Default:

""

label

public abstract String label

Default:

""