org.geotools.process.factory

Annotation Type DescribeResult

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface DescribeResult

DescribeProcess information for publication by DEMProcessFactory.

Annotation is used to mark a method for publication via DEMProcessFactory

Author:

Jody

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description The result description
String[]	meta Extra metadata values for this parameter which will be added into the Parameter metadata map.
String	name The name of the result, defaults to "result"
boolean	primary If true, this is the primary result of the process
Class<?>	type The type of the result, needed only when there are multiple ones (since it cannot be desumed from the process Map return type

Element Detail

name

public abstract String name

The name of the result, defaults to "result"

Returns:

Default:

"result"

type

public abstract Class<?> type

The type of the result, needed only when there are multiple ones (since it cannot be desumed from the process Map return type

Returns:

Default:

java.lang.Object.class

description

public abstract String description

The result description

Returns:

Default:

"[undescribed]"

primary

public abstract boolean primary

If true, this is the primary result of the process

Returns:

Default:

false

meta

public abstract String[] meta

Extra metadata values for this parameter which will be added into the Parameter metadata map. Each string should be in the key=value form, if not, the string will be taken as the key and the value will be null.

Default:

{}