Added: uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ExternalResourceFactory.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ExternalResourceFactory.html?rev=1877018&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ExternalResourceFactory.html (added) +++ uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ExternalResourceFactory.html Sun Apr 26 12:12:18 2020 @@ -0,0 +1,1433 @@ +<!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>ExternalResourceFactory (Apache uimaFIT 2.5.0 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="ExternalResourceFactory (Apache uimaFIT 2.5.0 User-Level API Documentation)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9,"i21":9,"i22":9,"i23":9,"i24":9,"i25":9,"i26":9,"i27":9,"i28":9,"i29":9,"i30":9,"i31":9,"i32":9,"i33":9,"i34":9,"i35":9,"i36":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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/ExternalResourceFactory.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/fit/factory/ConfigurationParameterFactory.ConfigurationData.html" title="class in org.apache.uima.fit.factory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/uima/fit/factory/FlowControllerFactory.html" title="class in org.apache.uima.fit.factory"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/uima/fit/factory/ExternalResourceFactory.html" target="_top">Frames</a></li> +<li><a href="ExternalResourceFactory.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All 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: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </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.fit.factory</div> +<h2 title="Class ExternalResourceFactory" class="title">Class ExternalResourceFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.uima.fit.factory.ExternalResourceFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">ExternalResourceFactory</span> +extends <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></pre> +<div class="block">Helper methods for external resources.</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"> </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/fit/factory/ExternalResourceFactory.html#PARAM_RESOURCE_NAME">PARAM_RESOURCE_NAME</a></span></code> </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/fit/factory/ExternalResourceFactory.html#PREFIX_SEPARATOR">PREFIX_SEPARATOR</a></span></code> +<div class="block">Used to separate resource name from key for nested resource.</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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindExternalResource-org.apache.uima.resource.ExternalResourceDescription-java.lang.String-org.apache.uima.resource.ExternalResourceDescription-">bindExternalResource</a></span>(org.apache.uima.resource.ExternalResourceDescription aRes, + <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> aBindTo, + org.apache.uima.resource.ExternalResourceDescription aNestedRes)</code> +<div class="block">Create a new external resource binding.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindExternalResource-org.apache.uima.resource.ResourceCreationSpecifier-java.lang.String-org.apache.uima.resource.ExternalResourceDescription-">bindExternalResource</a></span>(org.apache.uima.resource.ResourceCreationSpecifier aDesc, + <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> aBindTo, + org.apache.uima.resource.ExternalResourceDescription aRes)</code> +<div class="block">Create a new external resource binding.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindExternalResource-org.apache.uima.resource.ResourceCreationSpecifier-java.lang.String-java.lang.String-">bindExternalResource</a></span>(org.apache.uima.resource.ResourceCreationSpecifier aDesc, + <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> aBindTo, + <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> aRes)</code> +<div class="block">Create a new external resource binding.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindExternalResource-org.apache.uima.resource.metadata.ResourceManagerConfiguration-java.lang.String-org.apache.uima.resource.ExternalResourceDescription-">bindExternalResource</a></span>(org.apache.uima.resource.metadata.ResourceManagerConfiguration aResMgrCfg, + <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> aBindTo, + org.apache.uima.resource.ExternalResourceDescription aRes)</code> +<div class="block">Create a new external resource binding.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindExternalResource-org.apache.uima.resource.metadata.ResourceManagerConfiguration-java.lang.String-java.lang.String-">bindExternalResource</a></span>(org.apache.uima.resource.metadata.ResourceManagerConfiguration aResMgrCfg, + <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> aBindTo, + <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> aRes)</code> +<div class="block">Create a new external resource binding.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.Class-java.lang.Class-java.lang.String...-">bindResource</a></span>(org.apache.uima.resource.ResourceSpecifier aDesc, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> aApi, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.Resource> aRes, + <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>... aParams)</code> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + with a compatible type is found, the resource will be bound.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.Class-java.lang.Class-java.lang.String-java.lang.Object...-">bindResource</a></span>(org.apache.uima.resource.ResourceSpecifier aDesc, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> aApi, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.SharedResourceObject> aRes, + <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> aUrl, + <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>... aParams)</code> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + is encountered that has a key equal to the API class name, the resource will be bound.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.Class-java.lang.String...-">bindResource</a></span>(org.apache.uima.resource.ResourceSpecifier aDesc, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.Resource> aRes, + <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>... aParams)</code> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + with a compatible type is found, the resource will be bound.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.Class-java.lang.String-java.lang.Object...-">bindResource</a></span>(org.apache.uima.resource.ResourceSpecifier aDesc, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.SharedResourceObject> aRes, + <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> aUrl, + <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>... aParams)</code> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + with a compatible type is found, the resource will be bound.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindResource-org.apache.uima.resource.ResourceSpecifier-org.apache.uima.resource.ExternalResourceDescription-">bindResource</a></span>(org.apache.uima.resource.ResourceSpecifier aDesc, + org.apache.uima.resource.ExternalResourceDescription aResDesc)</code> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + with a compatible type is found, the given resource is bound to it.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.String-java.lang.Class-java.lang.String...-">bindResource</a></span>(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.Resource> aRes, + <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>... aParams)</code> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + with the given key is encountered, the given resource is bound to it.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.String-java.lang.Class-java.lang.String-java.lang.Object...-">bindResource</a></span>(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.SharedResourceObject> aRes, + <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> aUrl, + <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>... aParams)</code> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + with the given key is encountered the resource will be bound.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.String-org.apache.uima.resource.ExternalResourceDescription-">bindResource</a></span>(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + org.apache.uima.resource.ExternalResourceDescription aResDesc)</code> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + with the given key is encountered, the given resource is bound to it.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.String-java.io.File-">bindResource</a></span>(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> aFile)</code> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + is encounter that has the specified key, the resource will be bound.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.String-java.lang.String-">bindResource</a></span>(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + <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> aUrl)</code> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + is encounter that has the specified key, the resource will be bound.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.String-java.net.URL-">bindResource</a></span>(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a> aUrl)</code> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + is encounter that has the specified key, the resource will be bound.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createDependency-org.apache.uima.resource.ResourceSpecifier-java.lang.String-java.lang.Class-">createDependency</a></span>(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> aApi)</code> +<div class="block">Create a new dependency for the specified resource and bind it.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createDependencyAndBind-org.apache.uima.analysis_engine.AnalysisEngineDescription-java.lang.String-java.lang.Class-java.lang.String-java.lang.Object...-">createDependencyAndBind</a></span>(org.apache.uima.analysis_engine.AnalysisEngineDescription aDesc, + <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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.SharedResourceObject> aImpl, + <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> aUrl, + <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>... aParams)</code> +<div class="block">Create a new dependency for the specified resource and bind it.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createDependencyAndBind-org.apache.uima.resource.ResourceSpecifier-java.lang.String-java.lang.Class-java.lang.Class-java.lang.String...-">createDependencyAndBind</a></span>(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.Resource> aImpl, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> aApi, + <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>... aParams)</code> +<div class="block">Create a new dependency for the specified resource and bind it.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createDependencyAndBind-org.apache.uima.resource.ResourceSpecifier-java.lang.String-java.lang.Class-java.lang.String...-">createDependencyAndBind</a></span>(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.Resource> aImpl, + <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>... aParams)</code> +<div class="block">Create a new dependency for the specified resource and bind it.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.resource.metadata.ExternalResourceBinding</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createExternalResourceBinding-java.lang.String-org.apache.uima.resource.ExternalResourceDescription-">createExternalResourceBinding</a></span>(<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> aKey, + org.apache.uima.resource.ExternalResourceDescription aResource)</code> +<div class="block">Create an external resource binding.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.resource.metadata.ExternalResourceBinding</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createExternalResourceBinding-java.lang.String-java.lang.String-">createExternalResourceBinding</a></span>(<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> aKey, + <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> aResourceKey)</code> +<div class="block">Create an external resource binding.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.resource.ExternalResourceDependency[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createExternalResourceDependencies-java.lang.Class-">createExternalResourceDependencies</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> cls)</code> </td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.resource.ExternalResourceDependency</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createExternalResourceDependency-java.lang.reflect.Field-">createExternalResourceDependency</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> field)</code> +<div class="block">Creates an ExternalResourceDependency for a field annotated with + <a href="../../../../../org/apache/uima/fit/descriptor/ExternalResource.html" title="annotation in org.apache.uima.fit.descriptor"><code>ExternalResource</code></a>.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.resource.ExternalResourceDependency</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createExternalResourceDependency-java.lang.String-java.lang.Class-boolean-java.lang.String-">createExternalResourceDependency</a></span>(<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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> aInterface, + boolean aOptional, + <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> aDescription)</code> +<div class="block">Creates an ExternalResourceDependency for a given key and interface</div> +</td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.resource.ExternalResourceDescription</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createExternalResourceDescription-java.lang.Class-java.lang.Object...-">createExternalResourceDescription</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.Resource> aInterface, + <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>... aParams)</code> +<div class="block">Create an external resource description for a custom resource.</div> +</td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.resource.ExternalResourceDescription</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createExternalResourceDescription-java.lang.Class-java.io.File-java.lang.Object...-">createExternalResourceDescription</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.SharedResourceObject> aInterface, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> aFile, + <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>... aParams)</code> +<div class="block">Create an external resource description for a <code>SharedResourceObject</code>.</div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.resource.ExternalResourceDescription</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createExternalResourceDescription-java.lang.Class-java.lang.String-java.lang.Object...-">createExternalResourceDescription</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.SharedResourceObject> aInterface, + <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> aUrl, + <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>... aParams)</code> +<div class="block">Create an external resource description for a <code>SharedResourceObject</code>.</div> +</td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.resource.ExternalResourceDescription</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createExternalResourceDescription-java.lang.Class-java.net.URL-java.lang.Object...-">createExternalResourceDescription</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.SharedResourceObject> aInterface, + <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a> aUrl, + <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>... aParams)</code> +<div class="block">Create an external resource description for a <code>SharedResourceObject</code>.</div> +</td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.resource.ExternalResourceDescription</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createExternalResourceDescription-java.lang.String-java.lang.Class-java.lang.Object...-">createExternalResourceDescription</a></span>(<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> aName, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.Resource> aInterface, + <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>... aParams)</code> +<div class="block">Create an external resource description for a custom resource.</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.resource.ExternalResourceDescription</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createExternalResourceDescription-java.lang.String-java.lang.Class-java.lang.String-java.lang.Object...-">createExternalResourceDescription</a></span>(<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> aName, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.SharedResourceObject> aInterface, + <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> aUrl, + <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>... aParams)</code> +<div class="block">Create an external resource description for a <code>SharedResourceObject</code>.</div> +</td> +</tr> +<tr id="i31" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.resource.ExternalResourceDescription</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createExternalResourceDescription-java.lang.String-java.lang.String-">createExternalResourceDescription</a></span>(<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> aName, + <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> aUrl)</code> +<div class="block">Create an external resource description for a file addressable via an URL.</div> +</td> +</tr> +<tr id="i32" class="altColor"> +<td class="colFirst"><code>static <R extends org.apache.uima.resource.Resource><br>R</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createResource-java.lang.Class-java.lang.Object...-">createResource</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><R> resourceClass, + <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>... params)</code> +<div class="block">Create an instance of a UIMA shared/external resource class.</div> +</td> +</tr> +<tr id="i33" class="rowColor"> +<td class="colFirst"><code>static <R extends org.apache.uima.resource.Resource><br>R</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#createResource-java.lang.Class-org.apache.uima.resource.ResourceManager-java.lang.Object...-">createResource</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><R> resourceClass, + org.apache.uima.resource.ResourceManager resMgr, + <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>... params)</code> +<div class="block">Create an instance of a UIMA shared/external resource class.</div> +</td> +</tr> +<tr id="i34" class="altColor"> +<td class="colFirst"><code>protected static <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><<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>,org.apache.uima.resource.ExternalResourceDescription></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#extractExternalResourceParameters-java.lang.Object:A-">extractExternalResourceParameters</a></span>(<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>[] configurationData)</code> +<div class="block">Extracts the external resource from the configuration parameters and nulls out these + parameters.</div> +</td> +</tr> +<tr id="i35" class="rowColor"> +<td class="colFirst"><code>protected 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/fit/factory/ExternalResourceFactory.html#getImplementationName-org.apache.uima.resource.ExternalResourceDescription-">getImplementationName</a></span>(org.apache.uima.resource.ExternalResourceDescription aDesc)</code> +<div class="block">Find the name of the class implementing this resource.</div> +</td> +</tr> +<tr id="i36" class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ExternalResourceFactory.html#isExternalResourceField-java.lang.reflect.Field-">isExternalResourceField</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> field)</code> +<div class="block">This method determines if the field is annotated with + <a href="../../../../../org/apache/uima/fit/descriptor/ExternalResource.html" title="annotation in org.apache.uima.fit.descriptor"><code>ExternalResource</code></a>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<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></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</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_RESOURCE_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PARAM_RESOURCE_NAME</h4> +<pre>public static final <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_NAME</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.uima.fit.factory.ExternalResourceFactory.PARAM_RESOURCE_NAME">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="PREFIX_SEPARATOR"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PREFIX_SEPARATOR</h4> +<pre>public static final <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> PREFIX_SEPARATOR</pre> +<div class="block">Used to separate resource name from key for nested resource.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.uima.fit.factory.ExternalResourceFactory.PREFIX_SEPARATOR">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="isExternalResourceField-java.lang.reflect.Field-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isExternalResourceField</h4> +<pre>public static boolean isExternalResourceField(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> field)</pre> +<div class="block">This method determines if the field is annotated with + <a href="../../../../../org/apache/uima/fit/descriptor/ExternalResource.html" title="annotation in org.apache.uima.fit.descriptor"><code>ExternalResource</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>field</code> - the field to analyze</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether the field is marked as an external resource</dd> +</dl> +</li> +</ul> +<a name="createExternalResourceDescription-java.lang.Class-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createExternalResourceDescription</h4> +<pre>public static org.apache.uima.resource.ExternalResourceDescription createExternalResourceDescription(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.Resource> aInterface, + <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>... aParams)</pre> +<div class="block">Create an external resource description for a custom resource.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aInterface</code> - the interface the resource should implement.</dd> +<dd><code>aParams</code> - parameters passed to the resource when it is created.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the description.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>CustomResourceSpecifier</code></dd> +</dl> +</li> +</ul> +<a name="createExternalResourceDescription-java.lang.String-java.lang.Class-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createExternalResourceDescription</h4> +<pre>public static org.apache.uima.resource.ExternalResourceDescription createExternalResourceDescription(<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> aName, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.Resource> aInterface, + <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>... aParams)</pre> +<div class="block">Create an external resource description for a custom resource.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aName</code> - the name of the resource (the key).</dd> +<dd><code>aInterface</code> - the interface the resource should implement.</dd> +<dd><code>aParams</code> - parameters passed to the resource when it is created.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the description.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>CustomResourceSpecifier</code></dd> +</dl> +</li> +</ul> +<a name="createExternalResourceDescription-java.lang.Class-java.lang.String-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createExternalResourceDescription</h4> +<pre>public static org.apache.uima.resource.ExternalResourceDescription createExternalResourceDescription(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.SharedResourceObject> aInterface, + <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> aUrl, + <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>... aParams)</pre> +<div class="block">Create an external resource description for a <code>SharedResourceObject</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aInterface</code> - the interface the resource should implement.</dd> +<dd><code>aUrl</code> - the URL from which the resource is initialized.</dd> +<dd><code>aParams</code> - parameters passed to the resource when it is created.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the description.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>ConfigurableDataResourceSpecifier</code>, +<code>SharedResourceObject</code></dd> +</dl> +</li> +</ul> +<a name="createExternalResourceDescription-java.lang.Class-java.net.URL-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createExternalResourceDescription</h4> +<pre>public static org.apache.uima.resource.ExternalResourceDescription createExternalResourceDescription(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.SharedResourceObject> aInterface, + <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a> aUrl, + <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>... aParams)</pre> +<div class="block">Create an external resource description for a <code>SharedResourceObject</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aInterface</code> - the interface the resource should implement.</dd> +<dd><code>aUrl</code> - the URL from which the resource is initialized.</dd> +<dd><code>aParams</code> - parameters passed to the resource when it is created.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the description.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>ConfigurableDataResourceSpecifier</code>, +<code>SharedResourceObject</code></dd> +</dl> +</li> +</ul> +<a name="createExternalResourceDescription-java.lang.Class-java.io.File-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createExternalResourceDescription</h4> +<pre>public static org.apache.uima.resource.ExternalResourceDescription createExternalResourceDescription(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.SharedResourceObject> aInterface, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> aFile, + <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>... aParams)</pre> +<div class="block">Create an external resource description for a <code>SharedResourceObject</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aInterface</code> - the interface the resource should implement.</dd> +<dd><code>aFile</code> - the file from which the resource is initialized.</dd> +<dd><code>aParams</code> - parameters passed to the resource when it is created.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the description.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>ConfigurableDataResourceSpecifier</code>, +<code>SharedResourceObject</code></dd> +</dl> +</li> +</ul> +<a name="createExternalResourceDescription-java.lang.String-java.lang.Class-java.lang.String-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createExternalResourceDescription</h4> +<pre>public static org.apache.uima.resource.ExternalResourceDescription createExternalResourceDescription(<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> aName, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.SharedResourceObject> aInterface, + <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> aUrl, + <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>... aParams)</pre> +<div class="block">Create an external resource description for a <code>SharedResourceObject</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aName</code> - the name of the resource (the key).</dd> +<dd><code>aInterface</code> - the interface the resource should implement.</dd> +<dd><code>aUrl</code> - the URL from which the resource is initialized.</dd> +<dd><code>aParams</code> - parameters passed to the resource when it is created.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the description.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>ConfigurableDataResourceSpecifier</code>, +<code>SharedResourceObject</code></dd> +</dl> +</li> +</ul> +<a name="createExternalResourceDescription-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createExternalResourceDescription</h4> +<pre>public static org.apache.uima.resource.ExternalResourceDescription createExternalResourceDescription(<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> aName, + <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> aUrl)</pre> +<div class="block">Create an external resource description for a file addressable via an URL.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aName</code> - the name of the resource (the key).</dd> +<dd><code>aUrl</code> - a URL.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the description.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FileResourceSpecifier</code></dd> +</dl> +</li> +</ul> +<a name="createExternalResourceBinding-java.lang.String-org.apache.uima.resource.ExternalResourceDescription-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createExternalResourceBinding</h4> +<pre>public static org.apache.uima.resource.metadata.ExternalResourceBinding createExternalResourceBinding(<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> aKey, + org.apache.uima.resource.ExternalResourceDescription aResource)</pre> +<div class="block">Create an external resource binding.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aKey</code> - the key to bind to.</dd> +<dd><code>aResource</code> - the resource to bind.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the description.</dd> +</dl> +</li> +</ul> +<a name="createExternalResourceBinding-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createExternalResourceBinding</h4> +<pre>public static org.apache.uima.resource.metadata.ExternalResourceBinding createExternalResourceBinding(<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> aKey, + <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> aResourceKey)</pre> +<div class="block">Create an external resource binding.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aKey</code> - the key to bind to.</dd> +<dd><code>aResourceKey</code> - the resource key to bind.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the description.</dd> +</dl> +</li> +</ul> +<a name="createExternalResourceDependency-java.lang.reflect.Field-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createExternalResourceDependency</h4> +<pre>public static org.apache.uima.resource.ExternalResourceDependency createExternalResourceDependency(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> field)</pre> +<div class="block">Creates an ExternalResourceDependency for a field annotated with + <a href="../../../../../org/apache/uima/fit/descriptor/ExternalResource.html" title="annotation in org.apache.uima.fit.descriptor"><code>ExternalResource</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>field</code> - the field to analyze</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a external resource dependency</dd> +</dl> +</li> +</ul> +<a name="createExternalResourceDependency-java.lang.String-java.lang.Class-boolean-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createExternalResourceDependency</h4> +<pre>public static org.apache.uima.resource.ExternalResourceDependency createExternalResourceDependency(<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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> aInterface, + boolean aOptional, + <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> aDescription)</pre> +<div class="block">Creates an ExternalResourceDependency for a given key and interface</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aKey</code> - the resource key</dd> +<dd><code>aInterface</code> - the resource interface</dd> +<dd><code>aOptional</code> - determines whether the dependency is optional</dd> +<dd><code>aDescription</code> - a description of the resource</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the external resource dependency</dd> +</dl> +</li> +</ul> +<a name="createExternalResourceDependencies-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createExternalResourceDependencies</h4> +<pre>public static org.apache.uima.resource.ExternalResourceDependency[] createExternalResourceDependencies(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> cls) + throws org.apache.uima.resource.ResourceInitializationException</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cls</code> - the class to analyze</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the external resource dependencies</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.resource.ResourceInitializationException</code> - if the external resource dependencies could not be created</dd> +</dl> +</li> +</ul> +<a name="bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.String-java.net.URL-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bindResource</h4> +<pre>public static void bindResource(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a> aUrl) + throws org.apache.uima.util.InvalidXMLException</pre> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + is encounter that has the specified key, the resource will be bound. + <p> + <b>Caveat</b>: If you use this method, you may expect that <code>DataResource.getUrl()</code> or + <code>DataResource.getUri()</code> will return the same URL that you have specified here. This may + <b>NOT</b> be the case. UIMA will internally try to resolve the URL via a + <code>ResourceManager</code>. If it cannot resolve a remove URL, this mechanism will think it may be + a local file and will return some local path - or it may redirect it to some location as though + fit by the <code>ResourceManager</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aDesc</code> - a description.</dd> +<dd><code>aKey</code> - the key to bind to.</dd> +<dd><code>aUrl</code> - a URL.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.util.InvalidXMLException</code> - if import resolution failed</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FileResourceSpecifier</code></dd> +</dl> +</li> +</ul> +<a name="bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.String-java.io.File-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bindResource</h4> +<pre>public static void bindResource(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> aFile) + throws org.apache.uima.util.InvalidXMLException</pre> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + is encounter that has the specified key, the resource will be bound. + <p> + <b>Caveat</b>: If you use this method, you may expect that <code>DataResource.getUrl()</code> or + <code>DataResource.getUri()</code> will return the URL of the file that you have specified here. + This may <b>NOT</b> be the case. UIMA will internally try to resolve the URL via a + <code>ResourceManager</code>. If it cannot resolve a remove URL, this mechanism will think it may be + a local file and will return some local path - or it may redirect it to some location as though + fit by the <code>ResourceManager</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aDesc</code> - a description.</dd> +<dd><code>aKey</code> - the key to bind to.</dd> +<dd><code>aFile</code> - a file.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.util.InvalidXMLException</code> - if import resolution failed</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FileResourceSpecifier</code></dd> +</dl> +</li> +</ul> +<a name="bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bindResource</h4> +<pre>public static void bindResource(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + <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> aUrl) + throws org.apache.uima.util.InvalidXMLException</pre> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + is encounter that has the specified key, the resource will be bound. + <p> + <b>Caveat</b>: If you use this method, you may expect that <code>DataResource.getUrl()</code> or + <code>DataResource.getUri()</code> will return the same URL that you have specified here. This is + may <b>NOT</b> be the case. UIMA will internally try to resolve the URL via a + <code>ResourceManager</code>. If it cannot resolve a remove URL, this mechanism will think it may be + a local file and will return some local path - or it may redirect it to some location as though + fit by the <code>ResourceManager</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aDesc</code> - a description.</dd> +<dd><code>aKey</code> - the key to bind to.</dd> +<dd><code>aUrl</code> - a URL.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.util.InvalidXMLException</code> - if import resolution failed</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FileResourceSpecifier</code></dd> +</dl> +</li> +</ul> +<a name="bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.Class-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bindResource</h4> +<pre>public static void bindResource(org.apache.uima.resource.ResourceSpecifier aDesc, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.Resource> aRes, + <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>... aParams) + throws org.apache.uima.util.InvalidXMLException, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassNotFoundException.html?is-external=true"; title="class or interface in java.lang">ClassNotFoundException</a></pre> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + with a compatible type is found, the resource will be bound.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aDesc</code> - a description.</dd> +<dd><code>aRes</code> - the resource to bind.</dd> +<dd><code>aParams</code> - parameters passed to the resource when it is created.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.util.InvalidXMLException</code> - if import resolution failed</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassNotFoundException.html?is-external=true"; title="class or interface in java.lang">ClassNotFoundException</a></code> - if the resource implementation class or interface class could not be accessed</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>CustomResourceSpecifier</code></dd> +</dl> +</li> +</ul> +<a name="bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.Class-java.lang.Class-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bindResource</h4> +<pre>public static void bindResource(org.apache.uima.resource.ResourceSpecifier aDesc, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> aApi, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.Resource> aRes, + <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>... aParams) + throws org.apache.uima.util.InvalidXMLException, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassNotFoundException.html?is-external=true"; title="class or interface in java.lang">ClassNotFoundException</a></pre> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + with a compatible type is found, the resource will be bound.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aDesc</code> - a description.</dd> +<dd><code>aApi</code> - the resource interface.</dd> +<dd><code>aRes</code> - the resource to bind.</dd> +<dd><code>aParams</code> - parameters passed to the resource when it is created.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.util.InvalidXMLException</code> - if import resolution failed</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassNotFoundException.html?is-external=true"; title="class or interface in java.lang">ClassNotFoundException</a></code> - if the resource implementation class or interface class could not be accessed</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>CustomResourceSpecifier</code></dd> +</dl> +</li> +</ul> +<a name="bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.Class-java.lang.String-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bindResource</h4> +<pre>public static void bindResource(org.apache.uima.resource.ResourceSpecifier aDesc, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.SharedResourceObject> aRes, + <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> aUrl, + <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>... aParams) + throws org.apache.uima.util.InvalidXMLException, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassNotFoundException.html?is-external=true"; title="class or interface in java.lang">ClassNotFoundException</a></pre> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + with a compatible type is found, the resource will be bound.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aDesc</code> - a description.</dd> +<dd><code>aRes</code> - the resource to bind.</dd> +<dd><code>aUrl</code> - the URL from which the resource is initialized.</dd> +<dd><code>aParams</code> - parameters passed to the resource when it is created.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.util.InvalidXMLException</code> - if import resolution failed</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassNotFoundException.html?is-external=true"; title="class or interface in java.lang">ClassNotFoundException</a></code> - if the resource implementation class or interface class could not be accessed</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>SharedResourceObject</code></dd> +</dl> +</li> +</ul> +<a name="bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.Class-java.lang.Class-java.lang.String-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bindResource</h4> +<pre>public static void bindResource(org.apache.uima.resource.ResourceSpecifier aDesc, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> aApi, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.SharedResourceObject> aRes, + <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> aUrl, + <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>... aParams) + throws org.apache.uima.util.InvalidXMLException</pre> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + is encountered that has a key equal to the API class name, the resource will be bound.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aDesc</code> - a description.</dd> +<dd><code>aApi</code> - the resource interface.</dd> +<dd><code>aRes</code> - the resource to bind.</dd> +<dd><code>aUrl</code> - the URL from which the resource is initialized.</dd> +<dd><code>aParams</code> - parameters passed to the resource when it is created.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.util.InvalidXMLException</code> - if import resolution failed</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>SharedResourceObject</code></dd> +</dl> +</li> +</ul> +<a name="bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.String-java.lang.Class-java.lang.String-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bindResource</h4> +<pre>public static void bindResource(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.SharedResourceObject> aRes, + <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> aUrl, + <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>... aParams) + throws org.apache.uima.util.InvalidXMLException</pre> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + with the given key is encountered the resource will be bound.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aDesc</code> - a description.</dd> +<dd><code>aKey</code> - the key to bind to.</dd> +<dd><code>aRes</code> - the resource to bind.</dd> +<dd><code>aUrl</code> - the URL from which the resource is initialized.</dd> +<dd><code>aParams</code> - parameters passed to the resource when it is created.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.util.InvalidXMLException</code> - if import resolution failed</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>SharedResourceObject</code></dd> +</dl> +</li> +</ul> +<a name="bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.String-java.lang.Class-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bindResource</h4> +<pre>public static void bindResource(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.Resource> aRes, + <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>... aParams) + throws org.apache.uima.util.InvalidXMLException</pre> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + with the given key is encountered, the given resource is bound to it.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aDesc</code> - a description.</dd> +<dd><code>aKey</code> - the key to bind to.</dd> +<dd><code>aRes</code> - the resource to bind.</dd> +<dd><code>aParams</code> - parameters passed to the resource when it is created.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.util.InvalidXMLException</code> - if import resolution failed</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>CustomResourceSpecifier</code></dd> +</dl> +</li> +</ul> +<a name="bindResource-org.apache.uima.resource.ResourceSpecifier-org.apache.uima.resource.ExternalResourceDescription-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bindResource</h4> +<pre>public static void bindResource(org.apache.uima.resource.ResourceSpecifier aDesc, + org.apache.uima.resource.ExternalResourceDescription aResDesc) + throws org.apache.uima.util.InvalidXMLException, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassNotFoundException.html?is-external=true"; title="class or interface in java.lang">ClassNotFoundException</a></pre> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + with a compatible type is found, the given resource is bound to it.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aDesc</code> - a description.</dd> +<dd><code>aResDesc</code> - the resource description.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.util.InvalidXMLException</code> - if import resolution failed</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassNotFoundException.html?is-external=true"; title="class or interface in java.lang">ClassNotFoundException</a></code> - if the resource implementation class or interface class could not be accessed</dd> +</dl> +</li> +</ul> +<a name="bindResource-org.apache.uima.resource.ResourceSpecifier-java.lang.String-org.apache.uima.resource.ExternalResourceDescription-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bindResource</h4> +<pre>public static void bindResource(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + org.apache.uima.resource.ExternalResourceDescription aResDesc) + throws org.apache.uima.util.InvalidXMLException</pre> +<div class="block">Scan the given resource specifier for external resource dependencies and whenever a dependency + with the given key is encountered, the given resource is bound to it.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aDesc</code> - a description.</dd> +<dd><code>aKey</code> - the key to bind to.</dd> +<dd><code>aResDesc</code> - the resource description.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.util.InvalidXMLException</code> - if import resolution failed</dd> +</dl> +</li> +</ul> +<a name="createDependencyAndBind-org.apache.uima.resource.ResourceSpecifier-java.lang.String-java.lang.Class-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createDependencyAndBind</h4> +<pre>public static void createDependencyAndBind(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.Resource> aImpl, + <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>... aParams) + throws org.apache.uima.util.InvalidXMLException</pre> +<div class="block">Create a new dependency for the specified resource and bind it. This method is helpful for UIMA + components that do not use the uimaFIT <a href="../../../../../org/apache/uima/fit/descriptor/ExternalResource.html" title="annotation in org.apache.uima.fit.descriptor"><code>ExternalResource</code></a> annotation, because no external + resource dependencies can be automatically generated by uimaFIT for such components.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aDesc</code> - a description.</dd> +<dd><code>aKey</code> - the key to bind to.</dd> +<dd><code>aImpl</code> - the resource implementation.</dd> +<dd><code>aParams</code> - additional parameters supported by the resource.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.util.InvalidXMLException</code> - if import resolution failed</dd> +</dl> +</li> +</ul> +<a name="createDependencyAndBind-org.apache.uima.resource.ResourceSpecifier-java.lang.String-java.lang.Class-java.lang.Class-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createDependencyAndBind</h4> +<pre>public static void createDependencyAndBind(org.apache.uima.resource.ResourceSpecifier aDesc, + <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> aKey, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.resource.Resource> aImpl, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> aApi, + <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>... aParams) + throws org.apache.uima.util.InvalidXMLException</pre>
[... 310 lines stripped ...]
