org.esa.snap.core.gpf.descriptor

Interface OperatorDescriptor

All Superinterfaces:

ElementDescriptor

All Known Implementing Classes:

AnnotationOperatorDescriptor, DefaultOperatorDescriptor, ToolAdapterOperatorDescriptor

public interface OperatorDescriptor
extends ElementDescriptor

Operator metadata.

Since:

BEAM 5

Method Summary

Modifier and Type	Method and Description
String	getAuthors()
String	getCopyright()
Class<? extends Operator>	getOperatorClass()
ParameterDescriptor[]	getParameterDescriptors()
SourceProductDescriptor[]	getSourceProductDescriptors()
SourceProductsDescriptor	getSourceProductsDescriptor()
TargetProductDescriptor	getTargetProductDescriptor()
TargetPropertyDescriptor[]	getTargetPropertyDescriptors()
String	getVersion()
boolean	isAutoWriteDisabled() 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.
boolean	isInternal()

Methods inherited from interface org.esa.snap.core.gpf.descriptor.ElementDescriptor

getAlias, getDescription, getLabel, getName

Method Detail

getVersion

String getVersion()

Returns:

The version of the operator, or null if not declared.

getAuthors

String getAuthors()

Returns:

The author(s) of the operator, or null if not declared.

getCopyright

String getCopyright()

Returns:

The copyright notice for the operator code, or null if not declared.

isInternal

boolean isInternal()

Returns:

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

isAutoWriteDisabled

boolean isAutoWriteDisabled()

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

getOperatorClass

Class<? extends Operator> getOperatorClass()

Returns:

The operator implementation class.

getSourceProductDescriptors

SourceProductDescriptor[] getSourceProductDescriptors()

Returns:

The source product descriptors. The array will be empty if the operator does not have any source products.

getSourceProductsDescriptor

SourceProductsDescriptor getSourceProductsDescriptor()

Returns:

The source products descriptor, or null if none is declared.

getParameterDescriptors

ParameterDescriptor[] getParameterDescriptors()

Returns:

The parameter descriptors. The array will be empty if the operator does not have any parameters.

getTargetProductDescriptor

TargetProductDescriptor getTargetProductDescriptor()

Returns:

The target product descriptor, or null if none is declared.

getTargetPropertyDescriptors

TargetPropertyDescriptor[] getTargetPropertyDescriptors()

Returns:

The target property descriptors. The array will be empty if the operator does not produce any target properties.