docs/d/uimaj-current/apidocs/org/apache/uima/resource/Resource.html - uima-site - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>Resource (Apache UIMA Java SDK 3.1.1 User-Level API Documentation)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="Resource (Apache UIMA Java SDK 3.1.1 User-Level API Documentation)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/Resource.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../org/apache/uima/resource/RelativePathResolver.html" title="interface in org.apache.uima.resource"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/apache/uima/resource/Resource_ImplBase.html" title="class in org.apache.uima.resource"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/apache/uima/resource/Resource.html" target="_top">Frames</a></li>
 <li><a href="Resource.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle">org.apache.uima.resource</div>
 <h2 title="Interface Resource" class="title">Interface Resource</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Known Subinterfaces:</dt>
 <dd><a href="../../../../org/apache/uima/analysis_engine/AnalysisEngine.html" title="interface in org.apache.uima.analysis_engine">AnalysisEngine</a>, <a href="../../../../org/apache/uima/analysis_engine/asb/ASB.html" title="interface in org.apache.uima.analysis_engine.asb">ASB</a>, <a href="../../../../org/apache/uima/collection/base_cpm/BaseCollectionReader.html" title="interface in org.apache.uima.collection.base_cpm">BaseCollectionReader</a>, <a href="../../../../org/apache/uima/collection/CasConsumer.html" title="interface in org.apache.uima.collection">CasConsumer</a>, <a href="../../../../org/apache/uima/collection/base_cpm/CasDataCollectionReader.html" title="interface in org.apache.uima.collection.base_cpm">CasDataCollectionReader</a>, <a href="../../../../org/apache/uima/collection/base_cpm/CasDataConsumer.html" title="interface in org.apache.uima.collection.base_cpm">CasDataConsumer</a>, <a href="../../../../org/apache/uima/collection/base_cpm/CasDataInitializer.html" title="interface in org.apache.uima.collection.base_cpm">CasDataInitializer</a>, <a href="../../../../org/apache/uima/collection/CasInitializer.html" title="interface in org.apache.uima.collection">CasInitializer</a>, <a href="../../../../org/apache/uima/collection/CollectionReader.html" title="interface in org.apache.uima.collection">CollectionReader</a>, <a href="../../../../org/apache/uima/resource/ConfigurableResource.html" title="interface in org.apache.uima.resource">ConfigurableResource</a>, <a href="../../../../org/apache/uima/resource/DataResource.html" title="interface in org.apache.uima.resource">DataResource</a>, <a href="../../../../org/apache/uima/resource/ParameterizedDataResource.html" title="interface in org.apache.uima.resource">ParameterizedDataResource</a>, <a href="../../../../org/apache/uima/analysis_engine/TextAnalysisEngine.html" title="interface in org.apache.uima.analysis_engine">TextAnalysisEngine</a></dd>
 </dl>
 <dl>
 <dt>All Known Implementing Classes:</dt>
 <dd><a href="../../../../org/apache/uima/collection/CasConsumer_ImplBase.html" title="class in org.apache.uima.collection">CasConsumer_ImplBase</a>, <a href="../../../../org/apache/uima/collection/base_cpm/CasDataCollectionReader_ImplBase.html" title="class in org.apache.uima.collection.base_cpm">CasDataCollectionReader_ImplBase</a>, <a href="../../../../org/apache/uima/collection/base_cpm/CasDataConsumer_ImplBase.html" title="class in org.apache.uima.collection.base_cpm">CasDataConsumer_ImplBase</a>, <a href="../../../../org/apache/uima/collection/base_cpm/CasDataInitializer_ImplBase.html" title="class in org.apache.uima.collection.base_cpm">CasDataInitializer_ImplBase</a>, <a href="../../../../org/apache/uima/collection/CasInitializer_ImplBase.html" title="class in org.apache.uima.collection">CasInitializer_ImplBase</a>, <a href="../../../../org/apache/uima/collection/CollectionReader_ImplBase.html" title="class in org.apache.uima.collection">CollectionReader_ImplBase</a>, <a href="../../../../org/apache/uima/resource/ConfigurableResource_ImplBase.html" title="class in org.apache.uima.resource">ConfigurableResource_ImplBase</a>, <a href="../../../../org/apache/uima/resource/Resource_ImplBase.html" title="class in org.apache.uima.resource">Resource_ImplBase</a></dd>
 </dl>
 <hr>
 <br>
 <pre>public interface <span class="typeNameLabel">Resource</span></pre>
 <div class="block"><code>Resource</code> is the general term for all UIMA components that can be acquired and used
  by an application (or by other resources).
  <p>
  <code>Resource</code>s may be co-located with their client or distributed as services. This is
  made transparent to the client.
  <p>
  A <a href="../../../../org/apache/uima/resource/ResourceSpecifier.html" title="interface in org.apache.uima.resource"><code>ResourceSpecifier</code></a> contains information that can be used acquire a reference to a
  <code>Resource</code>, whether that is done by instantiating the resource locally or locating
  an existing resource available as a service.
  <p>
  The <a href="../../../../org/apache/uima/ResourceFactory.html" title="interface in org.apache.uima"><code>ResourceFactory</code></a> takes a <code>ResourceSpecifier</code> and returns
  an instance of the specified <code>Resource</code>. Again, this can be done by creating the
  instance or by locating an existing instance.
  <p>
  Most applications will not need to deal with this abstract <code>Resource</code> interface.
  UIMA Developers who need to introduce new types of Resources, however, will need to implement
  this interface.</div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- =========== FIELD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="field.summary">
 <!--   -->
 </a>
 <h3>Field Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Field and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/Resource.html#PARAM_AGGREGATE_SOFA_MAPPINGS">PARAM_AGGREGATE_SOFA_MAPPINGS</a></span></code>
 <div class="block">Used to pass the sofa mappings to the ASB</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/Resource.html#PARAM_CONFIG_MANAGER">PARAM_CONFIG_MANAGER</a></span></code>
 <div class="block">Key to specify a pre-existing
  <a href="../../../../org/apache/uima/resource/ConfigurationManager.html" title="interface in org.apache.uima.resource"><code>ConfigurationManager</code></a> object.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/Resource.html#PARAM_CONFIG_PARAM_SETTINGS">PARAM_CONFIG_PARAM_SETTINGS</a></span></code>
 <div class="block">Key for the initialization parameter whose value is a
  <a href="../../../../org/apache/uima/resource/metadata/ConfigurationParameterSettings.html" title="interface in org.apache.uima.resource.metadata"><code>ConfigurationParameterSettings</code></a> object that holds
  configuration settings that will be used to configure this Resource, overriding any
  conflicting settings specified in this Resource's Descriptor.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/Resource.html#PARAM_EXTERNAL_OVERRIDE_SETTINGS">PARAM_EXTERNAL_OVERRIDE_SETTINGS</a></span></code>
 <div class="block">Key for the initialization parameter whose value is a <a href="../../../../org/apache/uima/util/Settings.html" title="interface in org.apache.uima.util"><code>Settings</code></a>
  object that holds the external override settings.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/Resource.html#PARAM_PERFORMANCE_TUNING_SETTINGS">PARAM_PERFORMANCE_TUNING_SETTINGS</a></span></code>
 <div class="block">Key for the initialization parameter whose value is a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> object that
  holds settings that tune the performance of the framework.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/Resource.html#PARAM_RESOURCE_MANAGER">PARAM_RESOURCE_MANAGER</a></span></code>
 <div class="block">Key for the initialization parameter whose value is a reference to the <a href="../../../../org/apache/uima/resource/ResourceManager.html" title="interface in org.apache.uima.resource"><code>ResourceManager</code></a>
  that this Resource should use to locate and access other Resources.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/Resource.html#PARAM_UIMA_CONTEXT">PARAM_UIMA_CONTEXT</a></span></code>
 <div class="block">Key for the initialization parameter whose value is a reference to the <a href="../../../../org/apache/uima/UimaContext.html" title="interface in org.apache.uima"><code>UimaContext</code></a> that
  is to be used by this Resource to access its external resource and configuration parameters.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- ========== METHOD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/Resource.html#destroy--">destroy</a></span>()</code>
 <div class="block">Releases all resources held by this <code>Resource</code>.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/apache/uima/util/Logger.html" title="interface in org.apache.uima.util">Logger</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/Resource.html#getLogger--">getLogger</a></span>()</code>
 <div class="block">Gets the Logger that this Resource is currently using.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code><a href="../../../../org/apache/uima/resource/metadata/ResourceMetaData.html" title="interface in org.apache.uima.resource.metadata">ResourceMetaData</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/Resource.html#getMetaData--">getMetaData</a></span>()</code>
 <div class="block">Gets the metadata that describes this <code>Resource</code>.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/apache/uima/resource/ResourceManager.html" title="interface in org.apache.uima.resource">ResourceManager</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/Resource.html#getResourceManager--">getResourceManager</a></span>()</code>
 <div class="block">Gets the <a href="../../../../org/apache/uima/resource/ResourceManager.html" title="interface in org.apache.uima.resource"><code>ResourceManager</code></a> that this Resource uses to locate other Resources.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code><a href="../../../../org/apache/uima/UimaContext.html" title="interface in org.apache.uima">UimaContext</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/Resource.html#getUimaContext--">getUimaContext</a></span>()</code>
 <div class="block">Gets the UIMA Context for this Resource.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/apache/uima/UimaContextAdmin.html" title="interface in org.apache.uima">UimaContextAdmin</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/Resource.html#getUimaContextAdmin--">getUimaContextAdmin</a></span>()</code>
 <div class="block">Gets the Administrative interface to the UIMA Context.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/Resource.html#initialize-org.apache.uima.resource.ResourceSpecifier-java.util.Map-">initialize</a></span>(<a href="../../../../org/apache/uima/resource/ResourceSpecifier.html" title="interface in org.apache.uima.resource">ResourceSpecifier</a>&nbsp;aSpecifier,
           <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;aAdditionalParams)</code>
 <div class="block">Initializes this <code>Resource</code> from a <code>ResourceSpecifier</code>.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/Resource.html#setLogger-org.apache.uima.util.Logger-">setLogger</a></span>(<a href="../../../../org/apache/uima/util/Logger.html" title="interface in org.apache.uima.util">Logger</a>&nbsp;aLogger)</code>
 <div class="block">Sets the Logger that this Resource will use.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ FIELD DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="field.detail">
 <!--   -->
 </a>
 <h3>Field Detail</h3>
 <a name="PARAM_UIMA_CONTEXT">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>PARAM_UIMA_CONTEXT</h4>
 <pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PARAM_UIMA_CONTEXT</pre>
 <div class="block">Key for the initialization parameter whose value is a reference to the <a href="../../../../org/apache/uima/UimaContext.html" title="interface in org.apache.uima"><code>UimaContext</code></a> that
  is to be used by this Resource to access its external resource and configuration parameters.
  This value is used as a key in the <code>aAdditionalParams</code> Map that is passed to the
  <a href="../../../../org/apache/uima/resource/Resource.html#initialize-org.apache.uima.resource.ResourceSpecifier-java.util.Map-"><code>initialize(ResourceSpecifier,Map)</code></a> method.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.uima.resource.Resource.PARAM_UIMA_CONTEXT">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="PARAM_RESOURCE_MANAGER">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>PARAM_RESOURCE_MANAGER</h4>
 <pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PARAM_RESOURCE_MANAGER</pre>
 <div class="block">Key for the initialization parameter whose value is a reference to the <a href="../../../../org/apache/uima/resource/ResourceManager.html" title="interface in org.apache.uima.resource"><code>ResourceManager</code></a>
  that this Resource should use to locate and access other Resources. This value is used as a key
  in the <code>aAdditionalParams</code> Map that is passed to the
  <a href="../../../../org/apache/uima/resource/Resource.html#initialize-org.apache.uima.resource.ResourceSpecifier-java.util.Map-"><code>initialize(ResourceSpecifier,Map)</code></a> method.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.uima.resource.Resource.PARAM_RESOURCE_MANAGER">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="PARAM_CONFIG_PARAM_SETTINGS">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>PARAM_CONFIG_PARAM_SETTINGS</h4>
 <pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PARAM_CONFIG_PARAM_SETTINGS</pre>
 <div class="block">Key for the initialization parameter whose value is a
  <a href="../../../../org/apache/uima/resource/metadata/ConfigurationParameterSettings.html" title="interface in org.apache.uima.resource.metadata"><code>ConfigurationParameterSettings</code></a> object that holds
  configuration settings that will be used to configure this Resource, overriding any
  conflicting settings specified in this Resource's Descriptor. This value is used as a key in
  the <code>aAdditionalParams</code> Map that is passed to the
  <a href="../../../../org/apache/uima/resource/Resource.html#initialize-org.apache.uima.resource.ResourceSpecifier-java.util.Map-"><code>initialize(ResourceSpecifier,Map)</code></a> method.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.uima.resource.Resource.PARAM_CONFIG_PARAM_SETTINGS">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="PARAM_EXTERNAL_OVERRIDE_SETTINGS">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>PARAM_EXTERNAL_OVERRIDE_SETTINGS</h4>
 <pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PARAM_EXTERNAL_OVERRIDE_SETTINGS</pre>
 <div class="block">Key for the initialization parameter whose value is a <a href="../../../../org/apache/uima/util/Settings.html" title="interface in org.apache.uima.util"><code>Settings</code></a>
  object that holds the external override settings.  This will replace any prior settings.
  If omitted the value in the parent UIMA Context is inherited.  If there is no parent (i.e. at
  the root or top-level context) then the files in the system property UimaExternalOverrides are used.
  This value is used as a key in the <code>aAdditionalParams</code> Map that is passed to the
  <a href="../../../../org/apache/uima/resource/Resource.html#initialize-org.apache.uima.resource.ResourceSpecifier-java.util.Map-"><code>initialize(ResourceSpecifier,Map)</code></a> method.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.uima.resource.Resource.PARAM_EXTERNAL_OVERRIDE_SETTINGS">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="PARAM_PERFORMANCE_TUNING_SETTINGS">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>PARAM_PERFORMANCE_TUNING_SETTINGS</h4>
 <pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PARAM_PERFORMANCE_TUNING_SETTINGS</pre>
 <div class="block">Key for the initialization parameter whose value is a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> object that
  holds settings that tune the performance of the framework. This value is used as a key in the
  <code>aAdditionalParams</code> Map that is passed to the
  <a href="../../../../org/apache/uima/resource/Resource.html#initialize-org.apache.uima.resource.ResourceSpecifier-java.util.Map-"><code>initialize(ResourceSpecifier,Map)</code></a> method.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../org/apache/uima/UIMAFramework.html#getDefaultPerformanceTuningProperties--"><code>UIMAFramework.getDefaultPerformanceTuningProperties()</code></a>,
 <a href="../../../../constant-values.html#org.apache.uima.resource.Resource.PARAM_PERFORMANCE_TUNING_SETTINGS">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="PARAM_AGGREGATE_SOFA_MAPPINGS">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>PARAM_AGGREGATE_SOFA_MAPPINGS</h4>
 <pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PARAM_AGGREGATE_SOFA_MAPPINGS</pre>
 <div class="block">Used to pass the sofa mappings to the ASB</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.uima.resource.Resource.PARAM_AGGREGATE_SOFA_MAPPINGS">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="PARAM_CONFIG_MANAGER">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>PARAM_CONFIG_MANAGER</h4>
 <pre>static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PARAM_CONFIG_MANAGER</pre>
 <div class="block">Key to specify a pre-existing
  <a href="../../../../org/apache/uima/resource/ConfigurationManager.html" title="interface in org.apache.uima.resource"><code>ConfigurationManager</code></a> object.
  If specified, this object is used when initializing the UimaContext
  associated with this Resource, instead
  of creating a new instance.
  This value is used as a key in
  the <code>aAdditionalParams</code> Map that is passed to the
  <a href="../../../../org/apache/uima/resource/Resource.html#initialize-org.apache.uima.resource.ResourceSpecifier-java.util.Map-"><code>initialize(ResourceSpecifier,Map)</code></a> method.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../constant-values.html#org.apache.uima.resource.Resource.PARAM_CONFIG_MANAGER">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="initialize-org.apache.uima.resource.ResourceSpecifier-java.util.Map-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>initialize</h4>
 <pre>boolean&nbsp;initialize(<a href="../../../../org/apache/uima/resource/ResourceSpecifier.html" title="interface in org.apache.uima.resource">ResourceSpecifier</a>&nbsp;aSpecifier,
                    <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;aAdditionalParams)
             throws <a href="../../../../org/apache/uima/resource/ResourceInitializationException.html" title="class in org.apache.uima.resource">ResourceInitializationException</a></pre>
 <div class="block">Initializes this <code>Resource</code> from a <code>ResourceSpecifier</code>. Applications
  do not need to call this method. It is called automatically by the <code>ResourceFactory</code>
  and cannot be called a second time.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>aSpecifier</code> - specifies how to create a resource or locate an existing resource service.</dd>
 <dd><code>aAdditionalParams</code> - a Map containing additional parameters. May be <code>null</code> if there are no
           parameters. Each class that implements this interface can decide what additional
           parameters it supports.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if and only if initialization completed successfully. Returns false if the given
          <code>ResourceSpecifier</code> is not of an appropriate type for this Resource. If
          the <code>ResourceSpecifier</code> is of an appropriate type but is invalid or if
          some other failure occurs, an exception should be thrown.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="../../../../org/apache/uima/resource/ResourceInitializationException.html" title="class in org.apache.uima.resource">ResourceInitializationException</a></code> - if a failure occurs during initialization.</dd>
 <dd><code><a href="../../../../org/apache/uima/UIMA_IllegalStateException.html" title="class in org.apache.uima">UIMA_IllegalStateException</a></code> - if this method is called more than once on a single Resource instance.</dd>
 </dl>
 </li>
 </ul>
 <a name="getMetaData--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getMetaData</h4>
 <pre><a href="../../../../org/apache/uima/resource/metadata/ResourceMetaData.html" title="interface in org.apache.uima.resource.metadata">ResourceMetaData</a>&nbsp;getMetaData()</pre>
 <div class="block">Gets the metadata that describes this <code>Resource</code>.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>an object containing all metadata for this resource.</dd>
 </dl>
 </li>
 </ul>
 <a name="getResourceManager--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getResourceManager</h4>
 <pre><a href="../../../../org/apache/uima/resource/ResourceManager.html" title="interface in org.apache.uima.resource">ResourceManager</a>&nbsp;getResourceManager()</pre>
 <div class="block">Gets the <a href="../../../../org/apache/uima/resource/ResourceManager.html" title="interface in org.apache.uima.resource"><code>ResourceManager</code></a> that this Resource uses to locate other Resources.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the ResourceManager</dd>
 </dl>
 </li>
 </ul>
 <a name="getLogger--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getLogger</h4>
 <pre><a href="../../../../org/apache/uima/util/Logger.html" title="interface in org.apache.uima.util">Logger</a>&nbsp;getLogger()</pre>
 <div class="block">Gets the Logger that this Resource is currently using.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>this Resource's logger</dd>
 </dl>
 </li>
 </ul>
 <a name="setLogger-org.apache.uima.util.Logger-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setLogger</h4>
 <pre>void&nbsp;setLogger(<a href="../../../../org/apache/uima/util/Logger.html" title="interface in org.apache.uima.util">Logger</a>&nbsp;aLogger)</pre>
 <div class="block">Sets the Logger that this Resource will use. If this method is not called, the default logger (<a href="../../../../org/apache/uima/UIMAFramework.html#getLogger--"><code>UIMAFramework.getLogger()</code></a>)
  will be used.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>aLogger</code> - the logger for this Resource to use</dd>
 </dl>
 </li>
 </ul>
 <a name="destroy--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>destroy</h4>
 <pre>void&nbsp;destroy()</pre>
 <div class="block">Releases all resources held by this <code>Resource</code>.</div>
 </li>
 </ul>
 <a name="getUimaContext--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getUimaContext</h4>
 <pre><a href="../../../../org/apache/uima/UimaContext.html" title="interface in org.apache.uima">UimaContext</a>&nbsp;getUimaContext()</pre>
 <div class="block">Gets the UIMA Context for this Resource. This can be used to access external resources or
  facilities such as the Logger.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the UimaContext for use by this Resource</dd>
 </dl>
 </li>
 </ul>
 <a name="getUimaContextAdmin--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>getUimaContextAdmin</h4>
 <pre><a href="../../../../org/apache/uima/UimaContextAdmin.html" title="interface in org.apache.uima">UimaContextAdmin</a>&nbsp;getUimaContextAdmin()</pre>
 <div class="block">Gets the Administrative interface to the UIMA Context. This can be used by deployment wrappers
  to modify the UimaContext (for example, by setting the Session object).</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the administrative interface to this Resource's UimaContext</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 </div>
 <!-- ========= END OF CLASS DATA ========= -->
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/Resource.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../org/apache/uima/resource/RelativePathResolver.html" title="interface in org.apache.uima.resource"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/apache/uima/resource/Resource_ImplBase.html" title="class in org.apache.uima.resource"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/apache/uima/resource/Resource.html" target="_top">Frames</a></li>
 <li><a href="Resource.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 <p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </body>
 </html>