org.apache.uima.aae.controller

Interface AnalysisEngineInstancePool

All Known Implementing Classes:

AnalysisEngineInstancePoolWithThreadAffinity

public interface AnalysisEngineInstancePool

Method Summary

Methods

Modifier and Type	Method and Description
void	checkin(org.apache.uima.analysis_engine.AnalysisEngine anAnalysisEngine) Adds an instance of AnalysisEngine to the pool
org.apache.uima.analysis_engine.AnalysisEngine	checkout() Borrows an instance of AnalysisEngine from the pool
void	destroy() Destroys Analysis Engine instance pool.
boolean	exists() Checks if the current Thread is assigned to an AE instance
void	intialize(java.util.List anAnalysisEngineInstanceList) Creates and initializes the AE Pool with intances of AEs provided in the anAnalysisEngineInstanceList
int	size()

Method Detail

intialize

void intialize(java.util.List anAnalysisEngineInstanceList)
               throws java.lang.Exception

Creates and initializes the AE Pool with intances of AEs provided in the anAnalysisEngineInstanceList

Parameters:

anAnalysisEngineInstanceList - - list of AnalysisEngine instances

Throws:

java.lang.Exception

checkin

void checkin(org.apache.uima.analysis_engine.AnalysisEngine anAnalysisEngine)
             throws java.lang.Exception

Adds an instance of AnalysisEngine to the pool

Parameters:

anAnalysisEngine - - AnalysisEngine instance to be added to the pool

Throws:

java.lang.Exception

checkout

org.apache.uima.analysis_engine.AnalysisEngine checkout()
                                                        throws java.lang.Exception

Borrows an instance of AnalysisEngine from the pool

Returns:

AnalysisEngine instance

Throws:

java.lang.Exception

destroy

void destroy()
             throws java.lang.Exception

Destroys Analysis Engine instance pool.

Throws:

java.lang.Exception

exists

boolean exists()

Checks if the current Thread is assigned to an AE instance

Returns:

size

int size()