public interface ResourceManagerConfiguration extends MetaDataObject
ExternalResourceDependencies.
 
 Resource Manager Configurations can declare that they import other Resource
 Manager Configurations. At runtime, these imports will be resolved to create a single logical
 Resource Manager Configuration..
 
 Note that type system imports are not automatically resolved when a ResourceMangerConfiguration
 is deserialized from XML. To resolve the imports, call the resolveImports() method.
 Import resolution is done automatically when the ResourceManager
 is initialized (e.g. during AnalysisEngine initialization).
 
 Resource Manager Configurations can optionally be assigned a name,
 description, vendor, and
 version. It is recommended that these properties be set on any Resource
 Manager Configuration that is meant to be shared by (imported by) multiple components.
| Modifier and Type | Method and Description | 
|---|---|
| void | addExternalResource(ExternalResourceDescription aExternalResourceDescription)Adds a External Resource to this configuration | 
| void | addExternalResourceBinding(ExternalResourceBinding aExternalResourceBinding)Adds a External ResourceBinding to this configuration | 
| String | getDescription()Gets the description of this Resource Manager Configuration. | 
| ExternalResourceBinding[] | getExternalResourceBindings()Gets the bindings between an Analysis Engine's
  ExternalResourceDependenciesand
 theExternalResourceDescriptionobjects defined in this
 configuration. | 
| ExternalResourceDescription[] | getExternalResources()Gets the descriptions of the external resources to be instantiated and managed by the resource
 manager. | 
| Import | getImport()Deprecated. 
 Use  getImports()instead. There may be many imports; this method only
             returns the first. | 
| Import[] | getImports()Gets the imports declared by this Resource Manager Configuration. | 
| String | getName()Gets the name of this Resource Manager Configuration. | 
| String | getVendor()Gets the vendor of this Resource Manager Configuration. | 
| String | getVersion()Gets the version number of this Resource Manager Configuration. | 
| void | removeExternalResource(ExternalResourceDescription aExternalResourceDescription)Removes an ExternalResource from this configuration. | 
| void | removeExternalResourceBinding(ExternalResourceBinding aExternalResourceBinding)Removes an ExternalResourceBinding from this configuration. | 
| void | resolveImports()Resolves any import declarations in this resource manager configuration, adding the imported
 external resources and external resource bindings directly onto this
 ResourceManagerConfiguration's  externalResourcesandexternalResourceBindingslists. | 
| void | resolveImports(Collection<String> aAlreadyImportedURLs,
              ResourceManager aResourceManager)Resolves any import declarations in this resource manager configuration, adding the imported
 external resources and external resource bindings directly onto this
 ResourceManagerConfiguration's  externalResourcesandexternalResourceBindingslists. | 
| void | resolveImports(ResourceManager aResourceManager)Resolves any import declarations in this resource manager configuration, adding the imported
 external resources and external resource bindings directly onto this
 ResourceManagerConfiguration's  externalResourcesandexternalResourceBindingslists. | 
| void | setDescription(String aDescription)Sets the description of this Resource Manager Configuration. | 
| void | setExternalResourceBindings(ExternalResourceBinding[] aBindings)Sets the bindings between an Analysis Engine's
  ExternalResourceDependenciesand
 theExternalResourceDescriptionobjects defined in this
 configuration. | 
| void | setExternalResources(ExternalResourceDescription[] aDescriptions)Sets the descriptions of the external resources to be instantiated and managed by the resource
 manager. | 
| void | setImport(Import aImport)Deprecated. 
 Use  setImports(Import[])instead. | 
| void | setImports(Import[] aImports)Sets the imports declared by this Resource Manager Configuration. | 
| void | setName(String aName)Sets the name of this Resource Manager Configuration. | 
| void | setVendor(String aVendor)Sets the vendor of this Resource Manager Configuration. | 
| void | setVersion(String aVersion)Sets the version number of this Resource Manager Configuration. | 
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlbuildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXMLString getName()
void setName(String aName)
aName - the name of this Resource Manager ConfigurationUIMA_UnsupportedOperationException - if this object is not modifiableString getVersion()
void setVersion(String aVersion)
aVersion - the version number of this Resource Manager Configuration, as a StringUIMA_UnsupportedOperationException - if this object is not modifiableString getDescription()
void setDescription(String aDescription)
aDescription - the description of this Resource Manager ConfigurationUIMA_UnsupportedOperationException - if this object is not modifiableString getVendor()
void setVendor(String aVendor)
aVendor - the vendor of this Resource Manager Configuration, as a String, null if none has been
          specified.UIMA_UnsupportedOperationException - if this object is not modifiableImport[] getImports()
void setImports(Import[] aImports)
aImports - an array of imports declared by this Resource Manager Configuration.@Deprecated Import getImport()
getImports() instead. There may be many imports; this method only
             returns the first.@Deprecated void setImport(Import aImport)
setImports(Import[]) instead.aImport - an object that defines how to locate an external XML file defining the resource
          manager configuration. Null indicates that there is no import.ExternalResourceDescription[] getExternalResources()
ExternalResourceDescription objects that
         describe the external resources.void setExternalResources(ExternalResourceDescription[] aDescriptions)
aDescriptions - an array of ExternalResourceDescription objects that
          describe the external resources.void addExternalResource(ExternalResourceDescription aExternalResourceDescription)
aExternalResourceDescription - the ExternalResourceDescription to addUIMA_UnsupportedOperationException - if this object is not modifiablevoid removeExternalResource(ExternalResourceDescription aExternalResourceDescription)
aExternalResourceDescription - the ExternalResourceDescription to remove (must be == with an
          ExternalResourceDescription in this collection, or this method will do nothing).UIMA_UnsupportedOperationException - if this object is not modifiableExternalResourceBinding[] getExternalResourceBindings()
ExternalResourceDependencies and
 the ExternalResourceDescription objects defined in this
 configuration.ExternalResourceBinding objects
         that bind dependencies to resources.void setExternalResourceBindings(ExternalResourceBinding[] aBindings)
ExternalResourceDependencies and
 the ExternalResourceDescription objects defined in this
 configuration.aBindings - an array of ExternalResourceBinding objects
          that bind dependencies to resources.void addExternalResourceBinding(ExternalResourceBinding aExternalResourceBinding)
aExternalResourceBinding - the ExternalResourceBinding to addUIMA_UnsupportedOperationException - if this object is not modifiablevoid removeExternalResourceBinding(ExternalResourceBinding aExternalResourceBinding)
aExternalResourceBinding - the ExternalResourceBinding to remove (must be == with an ExternalResourceBinding in
          this collection, or this method will do nothing).UIMA_UnsupportedOperationException - if this object is not modifiablevoid resolveImports()
             throws InvalidXMLException
externalResources and
 externalResourceBindings lists.InvalidXMLException - if either the import target does not exist or is invalidvoid resolveImports(ResourceManager aResourceManager) throws InvalidXMLException
externalResources and
 externalResourceBindings lists.aResourceManager - the Resource Manager used to locate the XML file imported by name. For example, the
          path in which to locate the imported files can be set via the
          ResourceManager.setDataPath(String) method.InvalidXMLException - if either the import target does not exist or is invalidvoid resolveImports(Collection<String> aAlreadyImportedURLs, ResourceManager aResourceManager) throws InvalidXMLException
externalResources and
 externalResourceBindings lists.
 This version is used internally to resolve nested imports.
aResourceManager - the Resource Manager used to locate the XML file imported by name. For example, the
          path in which to locate the imported files can be set via the
          ResourceManager.setDataPath(String) method.aAlreadyImportedURLs - names of already imported URLs, so we don't import them again.InvalidXMLException - if either the import target does not exist or is invalidCopyright © 2006–2017 The Apache Software Foundation. All rights reserved.