Description of a collection of CAS feature structure indexes. This implements
MetaDataObject
, which implements {@link org.apache.uima.util.XMLizable}, so it can be serialized to and deserialized from an XML element.
FS Index Collections can declare that they {@link #getImports() import} other FS IndexCollections. At runtime, these imports will be resolved to create a single logical FS Index Collection.
Note that imports are not automatically resolved when an FsIndexCollection is deserialized from XML. To resolve the imports, call the {@link #resolveImports()} method. Import resolution is doneautomatically when a CAS is created using a FsIndexCollection.
FS Index Collections can optionally be assigned a {@link #getName() name}, {@link #getDescription() description}, {@link #getVendor() vendor}, and {@link #getVersion() version}. It is recommended that these properties be set on any FS Index Collection that is meant to be shared by (imported by) multiple components.