The details of all the public APIs for UIMA are contained in the API Javadocs.These are located in the docs/api directory; the top level to open in your browser is called api/
To attach Javadocs to your own Eclipse project, use the following instructions.
As an alternative, you can add the UIMA source to the UIMA binary distribution; if you do this you not only will have the Javadocs automatically available (you can skip the following setup), you will have the ability to step through the UIMA framework code while debugging.
The ASF licenses this documentation to you under the Apache License, Version 2.0 (the "License"); you may not use this documentation except in compliance with the License.
You may obtain a copy of the License at Unless required by applicable law or agreed to in writing, this documentation and its contents are distributed under the License on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
You use the "Add Jars" button and multi-select all the Jars in the lib directory of the UIMA binary distribution. The path to use is file:/ -- insert the path to your install of UIMA -- /docs/api.
After you do this for the first Jar, you can copy this string to the clipboard and paste it into the rest of the Jars.
As in Java, the dots in the name will be converted to file path separators.
So an import specifying the example name in this paragraph will result in a search for in the classpath or datapath.
in the code) is an XML file that either (a) completely describes a component, including all information needed to construct the component and interact with it, or (b) specifies how to connect to and interact with an existing component that has been published as a remote service.
, CAS Consumers, and Collection Processing Engines.
Section 2.2, “Imports” describes the UIMA SDK's syntax, used to allow XML descriptors to import information from other XML files, to allow sharing of information between several XML descriptors.