Package org.geotools.process.factory

Annotation Interface DescribeResult

@Retention(RUNTIME) @Target(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
    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 Details

    • name

      String name
      The name of the result, defaults to "result"
      Default:
      "result"

    • type

      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
      Default:
      java.lang.Object.class

    • description

      String description
      The result description
      Default:
      "[undescribed]"

    • primary

      boolean primary
      If true, this is the primary result of the process
      Default:
      false

    • meta

      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:
      {}