Constructor Detail

• Resource_ImplBase

  public Resource_ImplBase()

Method Detail

• initialize

  public boolean initialize(ResourceSpecifier aSpecifier,
                   Map<String,Object> aAdditionalParams)
                     throws ResourceInitializationException

  Description copied from interface: Resource
  Initializes this Resource from a ResourceSpecifier. Applications do not need to call this method. It is called automatically by the ResourceFactory and cannot be called a second time.

  Specified by:

  initialize in interface Resource

  Parameters:

  aSpecifier - specifies how to create a resource or locate an existing resource service.

  aAdditionalParams - a Map containing additional parameters. May be null if there are no parameters. Each class that implements this interface can decide what additional parameters it supports.

  Returns:

  true if and only if initialization completed successfully. Reutrns false if the given ResourceSpecifier is not of an appropriate type for this Resource. If the ResourceSpecifier is of an appropriate type but is invalid or if some other failure occurs, an exception should be thrown.

  Throws:

  ResourceInitializationException - if a failure occurs during initialization.

  See Also:

  multi-thread safe, given that each instance of this class is only called on one thread, once. The critical parts that update shared information (in shared uima context) are inside a synchronize block

• destroy

  public void destroy()

  Description copied from interface: Resource
  Releases all resources held by this Resource.

  Specified by:

  destroy in interface Resource

  See Also:

  Resource.destroy()

• getMetaData

  public ResourceMetaData getMetaData()

  Description copied from interface: Resource
  Gets the metadata that describes this Resource.

  Specified by:

  getMetaData in interface Resource

  Returns:

  an object containing all metadata for this resource.

  See Also:

  Resource.getMetaData()

• setMetaData

  protected void setMetaData(ResourceMetaData aMetaData)

  Sets the ResourceMetaData object associated with this Resource. Any previously existing metadata will be replaced.

  Resource subclasses should call this method during initialization in order to set the metadata before any calls to getMetaData() are made.

  Parameters:

  aMetaData - metadata to assign to this Resource

• getLogger

  public Logger getLogger()

  Get the logger for this UIMA framework class. Note that this is NOT the user's logger in the UimaContext

  Specified by:

  getLogger in interface Resource

  Returns:

  this Resource's logger

• setLogger

  public void setLogger(Logger aLogger)

  Set the logger in the current UimaContext for use by user annotators.

  Specified by:

  setLogger in interface Resource

  Parameters:

  aLogger - the logger for this Resource to use

• getResourceManager

  public ResourceManager getResourceManager()

  Description copied from interface: Resource
  Gets the ResourceManager that this Resource uses to locate other Resources.

  Specified by:

  getResourceManager in interface Resource

  Returns:

  the ResourceManager

  See Also:

  Resource.getResourceManager()

• getUimaContext

  public UimaContext getUimaContext()

  Description copied from interface: Resource
  Gets the UIMA Context for this Resource. This can be used to access external resources or facilities such as the Logger.

  Specified by:

  getUimaContext in interface Resource

  Returns:

  the UimaContext for use by this Resource

• getUimaContextAdmin

  public UimaContextAdmin getUimaContextAdmin()

  Gets the Admin interface to this Resource's UimaContext.

  Specified by:

  getUimaContextAdmin in interface Resource

  Returns:

  the administrative interface to this Resource's UimaContext

• getCasManager

  public CasManager getCasManager()

  Get the CasManager for this Resource. The CasManager manages the creation and pooling of CASes.

  Returns:

  the CasManager