Package org.apache.uima.fit.descriptor
Annotation Interface ExternalResource
Mark a field as external resource.
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionClass<? extends org.apache.uima.resource.Resource>
The interface that external resources need to implement.A description for the external resource.The key to which external resources bind to.boolean
Determines if this external resource is mandatory.
-
Element Details
-
key
String keyThe 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 org.apache.uima.resource.Resource> apiThe interface that external resources need to implement. Normally this has to be the type of the field, but ifExternalResourceLocator
s are used, this should be set toExternalResourceLocator
or to a derived interface.- Returns:
- the required interface.
- Default:
- org.apache.uima.resource.Resource.class
-
description
String descriptionA description for the external resource.- Returns:
- the description.
- Default:
- ""
-
mandatory
boolean mandatoryDetermines if this external resource is mandatory.- Returns:
- if this external resource is mandatory.
- Default:
- true
-