Package org.apache.uima.fit.descriptor

Annotation Interface ExternalResource

@Retention(RUNTIME) @Target(FIELD) public @interface ExternalResource
Mark a field as external resource.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<? extends Resource>
    api
    The interface that external resources need to implement.
    String
    description
    A description for the external resource.
    String
    key
    The key to which external resources bind to.
    boolean
    mandatory
    Determines if this external resource is mandatory.

  • Element Details

    • key

      String key
      The key to which external resources bind to. If no key is set, the name of the annotated field will be used.
      Returns:
      the key;
      Default:
      ""

    • api

      Class<? extends Resource> api
      The interface that external resources need to implement. Normally this has to be the type of the field, but if ExternalResourceLocators are used, this should be set to ExternalResourceLocator or to a derived interface.
      Returns:
      the required interface.
      Default:
      org.apache.uima.resource.Resource.class

    • description

      String description
      A description for the external resource.
      Returns:
      the description.
      Default:
      ""

    • mandatory

      boolean mandatory
      Determines if this external resource is mandatory.
      Returns:
      if this external resource is mandatory.
      Default:
      true