Package org.esa.snap.core.gpf.annotations

Annotation Type OperatorMetadata

@Documented
@Inherited
@Retention(RUNTIME)
@Target(TYPE)
public @interface OperatorMetadata

Provides metadata for an operator. This annotation is valid for extensions of the Operator class.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	alias

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	authors
boolean	autoWriteDisabled	The GPF framework usually writes the target product of either single operators or processing graphs to the file system when executed from the GPT command-line interface or the operator GUI.
String	category
String	copyright
String	description
boolean	internal
String	label
String	version

Element Detail

alias

String alias

Returns:

An alias name for the operator.

label

String label

Returns:

A human-readable version of the name to be used in user interfaces. Defaults to the empty string (= not set).

Default:

""

version

String version

Returns:

The version of the operator. Defaults to the empty string (= not set).

Default:

""

authors

String authors

Returns:

The author(s) of the operator. Defaults to the empty string (= not set).

Default:

""

copyright

String copyright

Returns:

The copyright notice for the operator code. Defaults to the empty string (= not set).

Default:

""

description

String description

Returns:

A brief description of the operator's purpose. Defaults to the empty string (= not set).

Default:

""

category

String category

Returns:

The category/context where the operator is used. Defaults to the empty string (= not set).

Default:

""

autoWriteDisabled

boolean autoWriteDisabled

The GPF framework usually writes the target product of either single operators or processing graphs to the file system when executed from the GPT command-line interface or the operator GUI.

If the autoWriteDisabled property is set, this default behaviour is switched off and hence, the operator or graph is responsible for outputting any computed results.

Setting this property on an operator will only be useful, if it either does not generate a new target Product and/or if it does its own outputting of non-Product targets to external files.

Returns:

If true, the framework will prevent automatic writing of the target product to the file system.

Since:

BEAM 5.0

Default:

false

internal

boolean internal

Returns:

If true, this operator is considered for internal use only and thus may not be exposed in user interfaces.

Default:

false