Package org.apache.uima.impl

Class UimaContext_ImplBase

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      (package private) class  UimaContext_ImplBase.ComponentInfoImpl
      Implementation of the ComponentInfo interface that allows the CAS to access information from this context- currently just the Sofa mappings.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.lang.String LOG_RESOURCE_BUNDLE
      resource bundle for log messages
      protected int loggingThrottleLimit
      A number to throttle logging from Annotators If not the max value, it wraps loggers obtained with getLogger() that are for Annotator classes, with the ThrottlingLogger.
      private boolean mCasPoolCreated
      Keeps track of whether we've created a CAS pool yet, which happens on the first call to getEmptyCas(Class).
      protected int mCasPoolSize
      Size of the CAS pool used to support the getEmptyCas(Class) method.
      private ComponentInfo mComponentInfo
      The ComponentInfoImpl class (an inner non-static class) has no fields and just one method that refers to fields in this (containing, outer) class.
      private static java.util.concurrent.atomic.AtomicInteger MDC_NEXT_ID  
      private java.lang.String mdcUniqueId  
      protected AnalysisEngineManagementImpl mMBean
      Object that implements management interface to the AE.
      protected java.util.Set<CAS> mOutstandingCASes
      CASes that have been requested via getEmptyCas(Class) minus the number calls the framework has made to returnedCAS(AbstractCas) (which indicate that the AnalysisComponent has returned a CAS from its next() method or released the CAS.
      private java.util.Properties mPerformanceTuningSettings
      Performance tuning settings.
      protected java.lang.String mQualifiedContextName
      Fully-qualified name of this context.
      private boolean mSofaAware
      Whether the component that accesses the CAS pool is sofa-aware.
      protected java.util.Map<java.lang.String,​java.lang.String> mSofaMappings
      Mapping between sofa names assigned by an aggregate engine to sofa names assigned by the component engines.
      private java.lang.String uniqueIdentifier  

    • Constructor Summary

      Constructors 
      Constructor Description
      UimaContext_ImplBase()
      Default constructor.
      UimaContext_ImplBase​(java.lang.String contextName, java.util.Map<java.lang.String,​java.lang.String> sofaMappings)
      Constructor for non Root instances

    • Field Detail

      • LOG_RESOURCE_BUNDLE

        private static final java.lang.String LOG_RESOURCE_BUNDLE
        resource bundle for log messages
        See Also:
        Constant Field Values

      • MDC_NEXT_ID

        private static java.util.concurrent.atomic.AtomicInteger MDC_NEXT_ID

      • mComponentInfo

        private final ComponentInfo mComponentInfo
        The ComponentInfoImpl class (an inner non-static class) has no fields and just one method that refers to fields in this (containing, outer) class. So it seems the method could just be used directly, and putting it into an inner class is silly.

      • mQualifiedContextName

        protected final java.lang.String mQualifiedContextName
        Fully-qualified name of this context.

      • mSofaMappings

        protected final java.util.Map<java.lang.String,​java.lang.String> mSofaMappings
        Mapping between sofa names assigned by an aggregate engine to sofa names assigned by the component engines. The key is the component sofa name and the value is the absolute sofa name assigned by a top level aggregate in this process. Multi-threading: This map is constructed at Constructor time, and never updated, only referenced, subsequently.

      • mCasPoolSize

        protected volatile int mCasPoolSize
        Size of the CAS pool used to support the getEmptyCas(Class) method. Note: CASes obtained by a CAS Multiplier, which then leave (exit) the CAS Multiplier, are not counted toward this limit. Rather, this limit limits the number of CASes that can be obtained while inside an annotator. The (maybe unobvious) use-case: Consider an annotator that receives hundreds of CASes, and sorts them into 3 kinds of aggregations, each of which accumulates information in a separate CAS for a while, and then releases these CASes for further processing. The limit would need to be set to 3 for this annotator instance, for this to work. The value of this max is set by calling the annotator's method getCasInstancesRequired method, a user-supplied method that is used to configure this. The default is 1.

      • mPerformanceTuningSettings

        private volatile java.util.Properties mPerformanceTuningSettings
        Performance tuning settings. Needed to specify CAS heap size for getEmptyCas(Class) method. Set during initialize calls for Analysis Engine components. Referenced during later lazy creation of Cas Pool upon first getEmptyCas call. Not expected to be modified after set.

      • mSofaAware

        private volatile boolean mSofaAware
        Whether the component that accesses the CAS pool is sofa-aware. Needed to determine which view is returned by the getEmptyCas(Class) method. Set during initialize calls for Analysis Engine components. Referenced during later lazy creation of Cas Pool upon first getEmptyCas call. Not expected to be modified after set.

      • mCasPoolCreated

        private volatile boolean mCasPoolCreated
        Keeps track of whether we've created a CAS pool yet, which happens on the first call to getEmptyCas(Class). See http://en.wikipedia.org/wiki/Double-checked_locking#Usage_in_Java for why this is volatile Ref'd and set inside getEmptyCas, part of lazy initialization of cas pool

      • mOutstandingCASes

        protected final java.util.Set<CAS> mOutstandingCASes
        CASes that have been requested via getEmptyCas(Class) minus the number calls the framework has made to returnedCAS(AbstractCas) (which indicate that the AnalysisComponent has returned a CAS from its next() method or released the CAS. If this Set size is at the maximum for this annotator, and the Analysis Component requests any additional CASes, then the AnalysisComponent has requested more CASes than it is allowed to and we throw an exception. This was changed from a simple int count to a set, in https://issues.apache.org/jira/browse/UIMA-437 revision 546169 (see history). CAS Multiplier use counts the CAS as returned after it is produced by the next() method when that method returns. Note that the CAS is not at that point "released" back into the CasPool - it is typically following a flow path and will eventually be released at some later point. The reason it is counted as released in this context's count is that this count limit is for limiting the number of CASes that can be requested within one process(), next(), or hasNext() methods, simultaneously, before that CAS is set onwards. Normally this is just 1 (at a time). The set is managed as a ConcurrentMap, to allow "remove" operations to not interlock with add or size operations. The size check followed by an add is in one sync block within getEmptyCas(), locked on the set object itself (not shared with any other locks).

      • uniqueIdentifier

        private final java.lang.String uniqueIdentifier

      • mdcUniqueId

        private final java.lang.String mdcUniqueId

      • loggingThrottleLimit

        protected int loggingThrottleLimit
        A number to throttle logging from Annotators If not the max value, it wraps loggers obtained with getLogger() that are for Annotator classes, with the ThrottlingLogger. This value is set from an Additional Parameters key AnalysisEngine.PARAM_SUPPRESS_EXCESSIVE_ANNOTATOR_LOGGING passed in as part of the additional parameters

    • Constructor Detail

      • UimaContext_ImplBase

        public UimaContext_ImplBase()
        Default constructor. Only Called for creating a "Root" instance.

      • UimaContext_ImplBase

        public UimaContext_ImplBase​(java.lang.String contextName,
                            java.util.Map<java.lang.String,​java.lang.String> sofaMappings)
        Constructor for non Root instances
        Parameters:
        contextName - -
        sofaMappings - -

    • Method Detail

      • constructUniqueName

        private java.lang.String constructUniqueName()

      • getUniqueName

        public java.lang.String getUniqueName()
        Description copied from interface: UimaContextAdmin
        Returns a UUID-like unique name of this component.
        Specified by:
        getUniqueName in interface UimaContextAdmin
        Returns:
        - unique name of this component

      • createChild

        public UimaContextAdmin createChild​(java.lang.String aContextName,
                                    java.util.Map<java.lang.String,​java.lang.String> aSofaMappings)
        Description copied from interface: UimaContextAdmin
        Creates a UimaContext that is a child of this UimaContext.
        Specified by:
        createChild in interface UimaContextAdmin
        Parameters:
        aContextName - a name for the new context, which must be unique with respect to all children of the parent context.
        aSofaMappings - mappings from child's sofa name to parent's sofa name. May be null.
        Returns:
        the Administrative interface to the UIMA Context

      • combineSofaMappings

        public java.util.Map<java.lang.String,​java.lang.String> combineSofaMappings​(java.util.Map<java.lang.String,​java.lang.String> aSofaMappings)
        Create the child sofa map by combining existing mapping from the current context with any mappings specific for this child, passed in as aSofaMappings
        Parameters:
        aSofaMappings - -
        Returns:
        the combined absolute sofamappings

      • getConfigParameterValue

        public java.lang.Object getConfigParameterValue​(java.lang.String aName)
        Description copied from interface: UimaContext
        Retrieves the value for a configuration parameter that is not defined in any group or is defined in the default group.

        This method returns null if the parameter is optional and has not been assigned a value. (For mandatory parameters, an exception is thrown during initialization if no value has been assigned.) This method also returns null if there is no declared configuration parameter with the specified name.

        Specified by:
        getConfigParameterValue in interface UimaContext
        Parameters:
        aName - the name of the parameter to look up
        Returns:
        the value of the parameter with the given name. The caller is expected to know the data type of the parameter. Returns null if the parameter does not exist or has not been assigned a value.
        See Also:
        AnnotatorContext.getConfigParameterValue(java.lang.String)

      • getConfigParameterValue

        public java.lang.Object getConfigParameterValue​(java.lang.String aGroupName,
                                                java.lang.String aParamName)
        Description copied from interface: UimaContext
        Retrieves the value for a configuration parameter in a particular group. If that group contains no value for the specified parameter, the fallback strategy specified by the Analysis Engine's ConfigurationParameterDeclarations.getSearchStrategy() property will be used. The search strategy can be specified in the descriptor.

        This method returns null if the parameter is optional and has not been assigned a value. (For mandatory parameters, an exception is thrown during initialization if no value has been assigned.) This method also returns null if there is no declared configuration parameter with the specified name.

        Specified by:
        getConfigParameterValue in interface UimaContext
        Parameters:
        aGroupName - the name of the group containing the parameter
        aParamName - the name of the parameter to look up
        Returns:
        the value of the parameter with the given name. The caller is expected to know the data type of the parameter. Returns null if the parameter does not exist or has not been assigned a value.
        See Also:
        AnnotatorContext.getConfigParameterValue(java.lang.String, java.lang.String)

      • getSharedSettingValue

        public java.lang.String getSharedSettingValue​(java.lang.String name)
                                       throws ResourceConfigurationException
        Description copied from interface: UimaContext
        Get the value of a shared configuration parameter from the external override settings.
        Specified by:
        getSharedSettingValue in interface UimaContext
        Parameters:
        name - - the name of the parameter
        Returns:
        - the value found in the shared settings file(s), or null if missing.
        Throws:
        ResourceConfigurationException - if the value references an undefined parameter, or the value is an array

      • getSharedSettingArray

        public java.lang.String[] getSharedSettingArray​(java.lang.String name)
                                         throws ResourceConfigurationException
        Description copied from interface: UimaContext
        Get the array of values for a shared configuration parameter from the external override settings.
        Specified by:
        getSharedSettingArray in interface UimaContext
        Parameters:
        name - - the name of the parameter
        Returns:
        - an array of values found in the shared settings file(s), or null if missing.
        Throws:
        ResourceConfigurationException - if the value references an undefined parameter, or the value is not an array

      • getSharedSettingNames

        public java.lang.String[] getSharedSettingNames()
        Description copied from interface: UimaContext
        Get the names of all the external override settings available.
        Specified by:
        getSharedSettingNames in interface UimaContext
        Returns:
        - an array containing the names of all the external override settings.

      • getResourceURL

        public java.net.URL getResourceURL​(java.lang.String aKey)
                            throws ResourceAccessException
        Locates Resource URL's using the ResourceManager.
        Specified by:
        getResourceURL in interface UimaContext
        Parameters:
        aKey - the key by which the resource is identified. This key should be declared in the <externalResourceDependencies> section of the descriptor.
        Returns:
        the URL at which the named resource is located, null if the named resource could not be found.
        Throws:
        ResourceAccessException - if a failure occurs in accessing the resource
        See Also:
        AnnotatorContext.getResourceURL(java.lang.String)

      • getResourceURI

        public java.net.URI getResourceURI​(java.lang.String aKey)
                            throws ResourceAccessException
        Description copied from interface: UimaContext
        Retrieves the URI to the named resource. This can be used, for example, to locate configuration or authority files. The resource should be declared in the <externalResourceDependencies> section of the descriptor.

        This method is safer than UimaContext.getResourceURL(String) in its treatment of file paths containing spaces. This is because the URI.getPath() does perform URL decoding of that path (decoding %20 sequences to spaces) whereas URL.getPath() does not.

        For backwards compatibility, if the key is not declared as a resource dependency, it is looked up directly in the data path and the class path. However, this usage is deprecated and support may be dropped in future versions. ALL external resource dependencies should be declared in the descriptor.

        Specified by:
        getResourceURI in interface UimaContext
        Parameters:
        aKey - the key by which the resource is identified. This key should be declared in the <externalResourceDependencies> section of the descriptor.
        Returns:
        the URI at which the named resource is located, null if the named resource could not be found.
        Throws:
        ResourceAccessException - if a failure occurs in accessing the resource

      • getResourceFilePath

        public java.lang.String getResourceFilePath​(java.lang.String aKey)
                                     throws ResourceAccessException
        Description copied from interface: UimaContext
        Retrieves the absolute file path to the named resource. This can be used, for example, to locate configuration or authority files. The resource should be declared in the <externalResourceDependencies> section of the descriptor.

        This only works if the resource is a local file. If the resource is not a local file (for example, it could be an http URL, then an exception will be thrown.

        URL decoding will be done on the file path, so it is safe to use this method for file paths that contain spaces. For backwards compatibility, if the key is not declared as a resource dependency, it is looked up directly in the data path and the class path. However, this usage is deprecated and support may be dropped in future versions. ALL external resource dependencies should be declared in the descriptor.

        Specified by:
        getResourceFilePath in interface UimaContext
        Parameters:
        aKey - the key by which the resource is identified. This key should be declared in the <externalResourceDependencies> section of the descriptor.
        Returns:
        the absolute file path at which the named resource is located, null if the named resource could not be found.
        Throws:
        ResourceAccessException - if the resource is not a local file, or if a failure occurs in accessing the resource

      • getResourceAsStream

        public java.io.InputStream getResourceAsStream​(java.lang.String aKey)
                                        throws ResourceAccessException
        Acquires Resource InputStreams using the ResourceManager.
        Specified by:
        getResourceAsStream in interface UimaContext
        Parameters:
        aKey - the key by which the resource is identified. This key should be declared in the <externalResourceDependencies> section of the descriptor.
        Returns:
        an InputStream for reading from the named resource, null if the named resource could not be found. It is the caller's responsibility to close this stream once it is no longer needed.
        Throws:
        ResourceAccessException - if a failure occurs in accessing the resource
        See Also:
        AnnotatorContext.getResourceAsStream(java.lang.String)

      • getResourceAsStream

        public java.io.InputStream getResourceAsStream​(java.lang.String aKey,
                                               java.lang.String[] aParams)
                                        throws ResourceAccessException
        Description copied from interface: UimaContext
        Retrieves an InputStream for reading from the named resource. This can be used, for example, to locate configuration or authority files. The resource should be declared in the <externalResourceDependencies> section of the descriptor.

        For backwards compatibility, if the key is not declared as a resource dependency, it is looked up directly in the data path and the class path. However, this usage is deprecated and support may be dropped in future versions. ALL external resource dependencies should be declared in the descriptor.

        This version of this method takes an array of parameters used to further identify the resource. This can be used, for example, with resources that vary depending on the language of the document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in the component descriptor.

        Specified by:
        getResourceAsStream in interface UimaContext
        Parameters:
        aKey - the key by which the resource is identified. This key should bd declared in the <externalResourceDependencies> section of the descriptor.
        aParams - parameters used to further identify the resource. When used to identify the language for a <fileLanguageResourceSpecifier>, this array should contain a single element, the ISO language code for the language of the document (e.g. "en", "de").
        Returns:
        an InputStream for reading from the named resource, null if the named resource could not be found. It is the caller's responsibility to close this stream once it is no longer needed.
        Throws:
        ResourceAccessException - if a failure occurs in accessing the resource
        See Also:
        AnnotatorContext.getResourceAsStream(java.lang.String, java.lang.String[])

      • getResourceObject

        public java.lang.Object getResourceObject​(java.lang.String aKey,
                                          java.lang.String[] aParams)
                                   throws ResourceAccessException
        Description copied from interface: UimaContext
        Retrieves the named resource object. This can be used to acquire references to external resources. The resource should be declared in the <externalResourceDependencies> section of the descriptor.

        This version of this method takes an array of parameters used to further identify the resource. This can be used, for example, with resources that vary depending on the language of the document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in the component descriptor.

        Specified by:
        getResourceObject in interface UimaContext
        Parameters:
        aKey - the key by which the resource is identified. This key should be declared in the <externalResourceDependencies> section of the descriptor.
        aParams - parameters used to further identify the resource. When used to identify the language for a <fileLanguageResourceSpecifier>, this array should contain a single element, the ISO language code for the language of the document (e.g. "en", "de").
        Returns:
        the object bound to aName, null if none.
        Throws:
        ResourceAccessException - if a failure occurs in accessing the resource
        See Also:
        AnnotatorContext.getResourceObject(java.lang.String, java.lang.String[])

      • getResourceURL

        public java.net.URL getResourceURL​(java.lang.String aKey,
                                   java.lang.String[] aParams)
                            throws ResourceAccessException
        Description copied from interface: UimaContext
        Retrieves the URL to the named resource. This can be used, for example, to locate configuration or authority files. The resource should be declared in the <externalResourceDependencies> section of the descriptor.

        Note that if the URL contains spaces they may be encoded as %20. The URL.getPath() method does NOT decode these sequences, therefore it is not safe to call getResourceURL().getPath() and attempt to use the result as a file path. Instead, you may use UimaContext.getResourceURI(String) or UimaContext.getResourceFilePath(String).

        For backwards compatibility, if the key is not declared as a resource dependency, it is looked up directly in the data path and the class path. However, this usage is deprecated and support may be dropped in future versions. ALL external resource dependencies should be declared in the descriptor.

        This version of this method takes an array of parameters used to further identify the resource. This can be used, for example, with resources that vary depending on the language of the document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in the component descriptor.

        Specified by:
        getResourceURL in interface UimaContext
        Parameters:
        aKey - the key by which the resource is identified. This key should be declared in the <externalResourceDependencies> section of the descriptor.
        aParams - parameters used to further identify the resource. When used to identify the language for a <fileLanguageResourceSpecifier>, this array should contain a single element, the ISO language code for the language of the document (e.g. "en", "de").
        Returns:
        the URL at which the named resource is located, null if the named resource could not be found.
        Throws:
        ResourceAccessException - if a failure occurs in accessing the resource
        See Also:
        AnnotatorContext.getResourceURL(java.lang.String, java.lang.String[])

      • getResourceURI

        public java.net.URI getResourceURI​(java.lang.String aKey,
                                   java.lang.String[] aParams)
                            throws ResourceAccessException
        Description copied from interface: UimaContext
        Retrieves the URI to the named resource. This can be used, for example, to locate configuration or authority files. The resource should be declared in the <externalResourceDependencies> section of the descriptor.

        This method is safer than UimaContext.getResourceURL(String) in its treatment of file paths containing spaces. This is because the URI.getPath() does perform URL decoding of that path (decoding %20 sequences to spaces) whereas URL.getPath() does not.

        For backwards compatibility, if the key is not declared as a resource dependency, it is looked up directly in the data path and the class path. However, this usage is deprecated and support may be dropped in future versions. ALL external resource dependencies should be declared in the descriptor.

        This version of this method takes an array of parameters used to further identify the resource. This can be used, for example, with resources that vary depending on the language of the document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in the component descriptor.

        Specified by:
        getResourceURI in interface UimaContext
        Parameters:
        aKey - the key by which the resource is identified. This key should be declared in the <externalResourceDependencies> section of the descriptor.
        aParams - parameters used to further identify the resource. When used to identify the language for a <fileLanguageResourceSpecifier>, this array should contain a single element, the ISO language code for the language of the document (e.g. "en", "de").
        Returns:
        the URI at which the named resource is located, null if the named resource could not be found.
        Throws:
        ResourceAccessException - if a failure occurs in accessing the resource

      • getResourceFilePath

        public java.lang.String getResourceFilePath​(java.lang.String aKey,
                                            java.lang.String[] aParams)
                                     throws ResourceAccessException
        Description copied from interface: UimaContext
        Retrieves the absolute file path to the named resource. This can be used, for example, to locate configuration or authority files. The resource should be declared in the <externalResourceDependencies> section of the descriptor.

        This only works if the resource is a local file. If the resource is not a local file (for example, it could be an http URL, then an exception will be thrown.

        URL decoding will be done on the file path, so it is safe to use this method for file paths that contain spaces.

        For backwards compatibility, if the key is not declared as a resource dependency, it is looked up directly in the data path and the class path. However, this usage is deprecated and support may be dropped in future versions. ALL external resource dependencies should be declared in the descriptor.

        This version of this method takes an array of parameters used to further identify the resource. This can be used, for example, with resources that vary depending on the language of the document being analyzed, such as when the <fileLanguageResourceSpecifier> element is used in the component descriptor.

        Specified by:
        getResourceFilePath in interface UimaContext
        Parameters:
        aKey - the key by which the resource is identified. This key should be declared in the <externalResourceDependencies> section of the descriptor.
        aParams - parameters used to further identify the resource. When used to identify the language for a <fileLanguageResourceSpecifier>, this array should contain a single element, the ISO language code for the language of the document (e.g. "en", "de").
        Returns:
        the absolute file path at which the named resource is located, null if the named resource could not be found.
        Throws:
        ResourceAccessException - if the resource is not a local file, or if a failure occurs in accessing the resource

      • getDataPath

        @Deprecated
public java.lang.String getDataPath()
        Deprecated.
        Description copied from interface: UimaContext
        Gets the data path used to locate resources. This path may contain more than one directory, separated by the System path.separator character (; on windows, : on UNIX).

        This method is intended to be used only for integration of legacy or third-party components that have their own resource management facility. If possible, it is recommended that you use the getResoureXXX methods instead.

        Specified by:
        getDataPath in interface UimaContext
        Returns:
        the data path

      • getDataPathElements

        public java.util.List<java.lang.String> getDataPathElements()
        Description copied from interface: UimaContext
        Gets the data path elements used to resolve relative paths.
        Specified by:
        getDataPathElements in interface UimaContext
        Returns:
        the data path elements

      • makeQualifiedName

        protected java.lang.String makeQualifiedName​(java.lang.String name)

      • getQualifiedContextName

        public java.lang.String getQualifiedContextName()
        Description copied from interface: UimaContextAdmin
        Gets the fully-qualified name of this context. This is a slash-separated name consisting of each containing context name back to the root. It always begins and ends with a slash. For example, the context name for an annotator nested within two AnalysisEngines might look like: /MyTopLevelAnalysisEngine/MyComponentAnalysisEngine/MyAnnotator/.
        Specified by:
        getQualifiedContextName in interface UimaContextAdmin
        Returns:
        the qualified context name

      • getConfigurationGroupNames

        public java.lang.String[] getConfigurationGroupNames()
        Description copied from interface: UimaContext
        Gets the names of all configuration parameter groups.
        Specified by:
        getConfigurationGroupNames in interface UimaContext
        Returns:
        an array containing the names of all configuration groups that exist for this component. Returns an empty array if no groups are declared.

      • getConfigParameterNames

        public java.lang.String[] getConfigParameterNames()
        Description copied from interface: UimaContext
        Gets the names of all configuration parameters that are not declared in a group.
        Specified by:
        getConfigParameterNames in interface UimaContext
        Returns:
        an array containing the names of all configuration parameters not declared in any group. Returns an empty array if there are none.

      • getConfigParameterNames

        public java.lang.String[] getConfigParameterNames​(java.lang.String aGroup)
        Description copied from interface: UimaContext
        Gets the names of all configuration parameters in the specified group.
        Specified by:
        getConfigParameterNames in interface UimaContext
        Parameters:
        aGroup - the group name
        Returns:
        an array containing the names of all configuration parameters declared in aGroup. Note that this does include parameters with null values. Returns an empty array if there are none (including if the group does not exist).

      • getSofaMap

        public java.util.Map<java.lang.String,​java.lang.String> getSofaMap()
        Description copied from interface: UimaContextAdmin
        Gets an unmodifiable Map containing the mapping of component sofa name to absolute sofa ID.
        Specified by:
        getSofaMap in interface UimaContextAdmin
        Returns:
        the Sofa map for this component

      • defineCasPool

        public void defineCasPool​(int aSize,
                          java.util.Properties aPerformanceTuningSettings,
                          boolean aSofaAware)
                   throws ResourceInitializationException
        Description copied from interface: UimaContextAdmin
        Defines the CAS pool that this UimaContext must support. This method must be called before UimaContext.getEmptyCas(Class) may be called.
        Specified by:
        defineCasPool in interface UimaContextAdmin
        Parameters:
        aSize - the minimum CAS pool size required
        aPerformanceTuningSettings - settings, including initial CAS heap size, for the AE
        aSofaAware - whether the component that will receive these CASes is sofa aware. This is needed to determine which view to get. Sofa-aware components get the base view; sofa-unaware components get the default text sofa view (or whatever is mapped to it).
        Throws:
        ResourceInitializationException - if a CAS could not be created.

      • returnedCAS

        public void returnedCAS​(AbstractCas aCAS)
        Description copied from interface: UimaContextAdmin
        Called internally by the framework whenever the AnalysisComponent returns a CAS from its next() method or calls cas.release(). Used to monitor the number of CASes that the AnalysisComponent is using at any one time.
        Specified by:
        returnedCAS in interface UimaContextAdmin
        Parameters:
        aCAS - the CAS that was returned or released
        See Also:
        UimaContextAdmin.returnedCAS(AbstractCas)

      • getEmptyCas

        public <T extends AbstractCas> T getEmptyCas​(java.lang.Class<T> aCasInterface)
        Description copied from interface: UimaContext
        Get an empty CAS. This method can only be called from CAS Multipliers, and typically a CAS Multiplier would call this indirectly through its CasMultiplier_ImplBase.getEmptyCAS() or JCasMultiplier_ImplBase.getEmptyJCas() method.

        This method may maintain a pool of CASes and may block if none are currently available.

        Specified by:
        getEmptyCas in interface UimaContext
        Type Parameters:
        T - the type of the CAS interface (CAS or JCas)
        Parameters:
        aCasInterface - the specific CAS interface that the component wants to use (e.g. CAS or JCas). Must specify a subtype of AbstractCas.
        Returns:
        an empty CAS. This will be an implementation of aCasInterface. The CAS will be unlocked (can be reset) but will have switched Class Loaders if needed.

      • maybeThrottleLogger

        protected Logger maybeThrottleLogger​(Logger logger)

      • setLoggingThrottleLimit

        public void setLoggingThrottleLimit​(java.lang.Integer v)

      • getMdcId

        public java.lang.String getMdcId()