public class CasManager_impl extends Object implements CasManager
Constructor and Description |
---|
CasManager_impl(ResourceManager aResourceManager) |
Modifier and Type | Method and Description |
---|---|
void |
addMetaData(ProcessingResourceMetaData aMetaData)
Called by components when they initialize.
|
CAS |
createNewCas(Properties aPerformanceTuningSettings)
Create a new CAS using the CasDefinition stored in this CAS Manager.
|
void |
defineCasPool(String aRequestorContextName,
int aMinimumSize,
Properties aPerformanceTuningSettings)
Defines a CAS pool within this CAS Manager.
|
void |
defineCasPool(UimaContextAdmin aRequestorContext,
int aMinimumSize,
Properties aPerformanceTuningSettings)
Defines the CAS pool required by a particular AnalysisEngine.
|
protected void |
finalize() |
CAS |
getCas(String aRequestorContextName)
Gets an empty CAS.
|
CasDefinition |
getCasDefinition()
Gets the CasDefinition, as defined by merging all of the metadata supplied by calls
CasManager.addMetaData(ProcessingResourceMetaData) . |
AbstractCas |
getCasInterface(CAS cas,
Class<? extends AbstractCas> requiredInterface)
Gets a specified interface to a CAS.
|
static <T extends AbstractCas> |
getCasInterfaceStatic(CAS cas,
Class<T> requiredInterface)
Gets a specified interface to a CAS.
|
protected int |
getCasPoolSize(String aRequestorContextName,
int aMinimumSize)
Determines the size to use for a particular CAS Pool.
|
protected Map<CAS,CasPool> |
getCasToCasPoolMap() |
protected void |
populateCasToCasPoolAndUimaContextMaps(CasPool aCasPool,
UimaContext aUimaContext) |
protected void |
populateCasToCasPoolMap(CasPool aCasPool) |
protected void |
registerCasPoolMBean(String aRequestorContextName,
CasPool pool)
Registers an MBean for the given CasPool.
|
void |
releaseCas(AbstractCas aCAS)
Releases a CAS back to its owner.
|
void |
setJmxInfo(Object aMBeanServer,
String aRootMBeanName)
Configures this CAS Manager so it can register an MBean for each of its CAS pools.
|
public CasManager_impl(ResourceManager aResourceManager)
public void addMetaData(ProcessingResourceMetaData aMetaData)
CasManager
addMetaData
in interface CasManager
aMetaData
- an object containing metadata for the component, including Type System, Type
Priorities, and Index Definitions needed to create the CAS.public CasDefinition getCasDefinition() throws ResourceInitializationException
CasManager
CasManager.addMetaData(ProcessingResourceMetaData)
.getCasDefinition
in interface CasManager
ResourceInitializationException
- if metadata could not be mergedpublic CAS getCas(String aRequestorContextName)
CasManager
CasManager.defineCasPool(String, int, Properties)
and established a CAS Pool of size > 0. The
CAS Manager maintains a separate pool for each AnalysisEngine. This method may block if the CAS
pool does not contain any free instances.getCas
in interface CasManager
aRequestorContextName
- the context name of the AE requesting the CAS
(AnalysisEngine.getUimaContextAdmin().getQualifiedContextName()).public void releaseCas(AbstractCas aCAS)
CasOwner
aCAS
.releaseCas
in interface CasOwner
aCAS
- the CAS to releasepublic void defineCasPool(String aRequestorContextName, int aMinimumSize, Properties aPerformanceTuningSettings) throws ResourceInitializationException
CasManager
CasManager.defineCasPool(UimaContextAdmin, int, Properties)
should be used
instead.defineCasPool
in interface CasManager
aRequestorContextName
- name to give to the pool. Must be unique among all pool names in this CAS manager, and
care should be taken to assure that this does not match the qualified name of UIMA
Contexts passed to CasManager.defineCasPool(UimaContextAdmin, int, Properties)
. This
name is later passed to the CasManager.getCas(String)
method, to check out CASes from
the pool.aMinimumSize
- the minimum CAS pool size requiredaPerformanceTuningSettings
- settings, including initial CAS heap size, for the AEResourceInitializationException
- if a CAS could not be created.public void defineCasPool(UimaContextAdmin aRequestorContext, int aMinimumSize, Properties aPerformanceTuningSettings) throws ResourceInitializationException
CasManager
defineCasPool
in interface CasManager
aRequestorContext
- the UimaContext of the AE that will request the CASes
(AnalysisEngine.getUimaContextAdmin()).aMinimumSize
- the minimum CAS pool size requiredaPerformanceTuningSettings
- settings, including initial CAS heap size, for the AEResourceInitializationException
- if a CAS could not be created.public CAS createNewCas(Properties aPerformanceTuningSettings) throws ResourceInitializationException
CasManager
createNewCas
in interface CasManager
aPerformanceTuningSettings
- settings, including initial CAS heap size, for the AEResourceInitializationException
- if the CAS could not be createdpublic AbstractCas getCasInterface(CAS cas, Class<? extends AbstractCas> requiredInterface)
getCasInterface
in interface CasManager
cas
- The CASrequiredInterface
- interface to get. Currently must be one of CAS or JCas.public static <T extends AbstractCas> T getCasInterfaceStatic(CAS cas, Class<T> requiredInterface)
T
- the particular interfacecas
- The CASrequiredInterface
- interface to get. Currently must be one of CAS or JCas.public void setJmxInfo(Object aMBeanServer, String aRootMBeanName)
CasManager
setJmxInfo
in interface CasManager
aMBeanServer
- the JMX MBean Server to register MBeans with. If null, the platform MBeanServer (Java
1.5+ only) will be used.aRootMBeanName
- unique MBean name for the root component that owns this CAS Manager. The names of the
CAS Pool MBeans will be formed by appending
,casPoolContextName=[contextName]
to the root component name, where
[contextName] is the requestorContextName for the CasPool.protected void populateCasToCasPoolMap(CasPool aCasPool)
protected void populateCasToCasPoolAndUimaContextMaps(CasPool aCasPool, UimaContext aUimaContext)
protected void registerCasPoolMBean(String aRequestorContextName, CasPool pool)
aRequestorContextName
- context name that identifies this CasPoolpool
- the CasPoolprotected int getCasPoolSize(String aRequestorContextName, int aMinimumSize)
aRequestorContextName
- the context name of the AE that will request the CASes
(AnalysisEngine.getUimaContextAdmin().getQualifiedContextName()).aMinimumSize
- the minimum CAS pool size requiredCopyright © 2006–2022 The Apache Software Foundation. All rights reserved.