|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.uima.UIMAFramework
org.apache.uima.impl.UIMAFramework_impl
public class UIMAFramework_impl
This is the main interface point to the UIMA reference implemention. Applications cannot use this
class directly. Use the static methods on UIMAFramework
instead.
This class is a singleton which will be accessed by many threads simulatenously. It must be threadsafe.
Field Summary | |
---|---|
static boolean |
debug
|
Fields inherited from class org.apache.uima.UIMAFramework |
---|
CAS_INITIAL_HEAP_SIZE, JCAS_CACHE_ENABLED, PROCESS_TRACE_ENABLED, SOCKET_KEEPALIVE_ENABLED |
Constructor Summary | |
---|---|
UIMAFramework_impl()
Creates a new UIMAFramework_impl. |
Method Summary | |
---|---|
short |
_getBuildRevision()
To be implemented by subclasses; this should return the build revision number of this implementation. |
protected java.util.Properties |
_getDefaultPerformanceTuningProperties()
To be implemented by subclasses; this should return a Properties object representing the default performance tuning settings for the framework. |
protected Logger |
_getLogger()
To be implemented by subclasses; this should return a reference to the UIMA {@link Logger) used by this implementation. |
protected Logger |
_getLogger(java.lang.Class component)
To be implemented by subclasses; this should return a reference to the UIMA Logger of
the specified source class. |
short |
_getMajorVersion()
To be implemented by subclasses; this should return the major version number of this implementation. |
short |
_getMinorVersion()
To be implemented by subclasses; this should return the minor version number of this implementation. |
protected CompositeResourceFactory |
_getResourceFactory()
Retrieves a reference to the ResourceFactory used by the UIMA reference
implementation. |
protected ResourceSpecifierFactory |
_getResourceSpecifierFactory()
To be implemented by subclasses; this should return a reference to the ResourceSpecifierFactory used by this implementation. |
protected XMLParser |
_getXMLParser()
To be implemented by subclasses; this should return a reference to the UIMA {@link XMLParser) used by this implementation. |
protected void |
_initialize()
To be implemented by subclasses; called from this class's static initializer to complete initialization of the singleton instance. |
protected CollectionProcessingManager |
_newCollectionProcessingManager(ResourceManager aResourceManager)
To be implemented by subclasses; this should create a new instance of a class implementing CollectionProcessingManager . |
protected ConfigurationManager |
_newConfigurationManager()
To be implemented by subclasses; this should return a new instance of the {@link ConfigurationManager) used by this implementation. |
protected ResourceManager |
_newDefaultResourceManager()
To be implemented by subclasses; this should return a new instance of the default {@link ResourceManager) used by this implementation. |
protected ResourceManager |
_newDefaultResourceManagerPearWrapper()
To be implemented by subclasses; this should return a new instance of the default {@link ResourceManager) used by this implementation. |
protected Logger |
_newLogger()
To be implemented by subclasses; this should return a new UIMA Logger instance. |
protected UimaTimer |
_newTimer()
To be implemented by subclasses; this should return a new UIMA UimaTimer instance. |
protected UimaContextAdmin |
_newUimaContext()
To be implemented by subclasses; this should return a new instance of the default UimaContextAdmin used by this implementation. |
protected CollectionProcessingEngine |
_produceCollectionProcessingEngine(CpeDescription aCpeDescription,
java.util.Map<java.lang.String,java.lang.Object> aAdditionalParams)
To be implemented by subclasses; this should produce a CollectionProcessingEngine
instance from a cpeDescription . |
protected void |
parseFactoryConfig()
Parses the factoryConfig.xml file and sets up the ResourceFactory, ResourceSpecifierFactory, and XMLParser. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final boolean debug
Constructor Detail |
---|
public UIMAFramework_impl()
Method Detail |
---|
protected void _initialize() throws java.lang.Exception
UIMAFramework
UIMAFramework.getInstance()
method can be used during initialization.
_initialize
in class UIMAFramework
java.lang.Exception
- if initialization failsUIMAFramework._initialize()
public short _getMajorVersion()
UIMAFramework
_getMajorVersion
in class UIMAFramework
UIMAFramework._getMajorVersion()
public short _getMinorVersion()
UIMAFramework
_getMinorVersion
in class UIMAFramework
UIMAFramework._getMinorVersion()
public short _getBuildRevision()
UIMAFramework
_getBuildRevision
in class UIMAFramework
UIMAFramework._getBuildRevision()
protected CompositeResourceFactory _getResourceFactory()
ResourceFactory
used by the UIMA reference
implementation.
_getResourceFactory
in class UIMAFramework
ResourceFactory
to be used by the applicationprotected ResourceSpecifierFactory _getResourceSpecifierFactory()
ResourceSpecifierFactory
used by this implementation.
_getResourceSpecifierFactory
in class UIMAFramework
ResourceSpecifierFactory
to be used by the application.protected XMLParser _getXMLParser()
_getXMLParser
in class UIMAFramework
XMLParser
to be used by the application.protected CollectionProcessingManager _newCollectionProcessingManager(ResourceManager aResourceManager)
UIMAFramework
CollectionProcessingManager
.
_newCollectionProcessingManager
in class UIMAFramework
aResourceManager
- the ResourceManager to be used by the CPM
CollectionProcessingManager
to be used by the application.org.apache.uima.UIMAFramework#_newCollectionProcessingManager()
protected Logger _getLogger()
_getLogger
in class UIMAFramework
Logger
to be used by the application.protected Logger _getLogger(java.lang.Class component)
Logger
of
the specified source class.
_getLogger
in class UIMAFramework
Logger
of the specified source classprotected Logger _newLogger()
UIMAFramework
Logger
instance.
_newLogger
in class UIMAFramework
Logger
instanceUIMAFramework._newLogger()
protected ResourceManager _newDefaultResourceManager()
_newDefaultResourceManager
in class UIMAFramework
ResourceManager
to be used by the application.protected ResourceManager _newDefaultResourceManagerPearWrapper()
_newDefaultResourceManagerPearWrapper
in class UIMAFramework
ResourceManager
to be used by the application.protected ConfigurationManager _newConfigurationManager()
_newConfigurationManager
in class UIMAFramework
ConfigurationManager
to be used by the application.protected UimaContextAdmin _newUimaContext()
UIMAFramework
UimaContextAdmin
used by this implementation.
_newUimaContext
in class UIMAFramework
UimaContextAdmin
to be used by the application.UIMAFramework._newUimaContext()
protected UimaTimer _newTimer()
UIMAFramework
UimaTimer
instance.
_newTimer
in class UIMAFramework
Timer
instanceUIMAFramework._newTimer()
protected CollectionProcessingEngine _produceCollectionProcessingEngine(CpeDescription aCpeDescription, java.util.Map<java.lang.String,java.lang.Object> aAdditionalParams) throws ResourceInitializationException
UIMAFramework
CollectionProcessingEngine
instance from a cpeDescription
.
_produceCollectionProcessingEngine
in class UIMAFramework
aCpeDescription
- an object that specifies how to create an instance of a
CollectionProcessingEngine
.aAdditionalParams
- a Map containing additional parameters to pass to the
CollectionProcessingEngine.initialize(CpeDescription,Map)
method. May be
null
if there are no parameters. For example this can be used to set
performance-tuning settings as described in
UIMAFramework.getDefaultPerformanceTuningProperties()
.
CollectionProcessingEngine
instance.
ResourceInitializationException
- if a failure occurred during production of the CPE.protected java.util.Properties _getDefaultPerformanceTuningProperties()
UIMAFramework
_getDefaultPerformanceTuningProperties
in class UIMAFramework
protected void parseFactoryConfig() throws javax.xml.parsers.ParserConfigurationException, org.xml.sax.SAXException, java.io.IOException, java.lang.ClassNotFoundException, java.lang.InstantiationException, java.lang.IllegalAccessException
javax.xml.parsers.ParserConfigurationException
- if the XML parser could not be configured
org.xml.sax.SAXException
- if factoryConfig.xml could not be parsed
java.io.IOException
java.lang.ClassNotFoundException
java.lang.InstantiationException
java.lang.IllegalAccessException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |