| <!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>ExternalResourceDependency (Apache UIMA Java SDK 3.1.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="ExternalResourceDependency (Apache UIMA Java SDK 3.1.0 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/ExternalResourceDependency.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/DataResource.html" title="interface in org.apache.uima.resource"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../org/apache/uima/resource/ExternalResourceDescription.html" title="interface in org.apache.uima.resource"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../index.html?org/apache/uima/resource/ExternalResourceDependency.html" target="_top">Frames</a></li> | |
| <li><a href="ExternalResourceDependency.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>Field | </li> | |
| <li>Constr | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li>Field | </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.resource</div> | |
| <h2 title="Interface ExternalResourceDependency" class="title">Interface ExternalResourceDependency</h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <dl> | |
| <dt>All Superinterfaces:</dt> | |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../org/apache/uima/resource/metadata/MetaDataObject.html" title="interface in org.apache.uima.resource.metadata">MetaDataObject</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../org/apache/uima/util/XMLizable.html" title="interface in org.apache.uima.util">XMLizable</a></dd> | |
| </dl> | |
| <hr> | |
| <br> | |
| <pre>public interface <span class="typeNameLabel">ExternalResourceDependency</span> | |
| extends <a href="../../../../org/apache/uima/resource/metadata/MetaDataObject.html" title="interface in org.apache.uima.resource.metadata">MetaDataObject</a></pre> | |
| <div class="block">An <code>ExternalResourceDependency</code> object describes an resources's requirements on an | |
| external resource. This object has four properties: | |
| <ul> | |
| <li>A key, by which the annotator will identify the resource.</li> | |
| <li>A textual description of the resource dependency.</li> | |
| <li>The name of a Java interface through which the data will be accessed. This is optional; if | |
| not specified, the default <a href="../../../../org/apache/uima/resource/DataResource.html" title="interface in org.apache.uima.resource"><code>DataResource</code></a> interface will be used.</li> | |
| <li>Whether the resource is required or optional.</li> | |
| </ul></div> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="summary"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ========== 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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><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/ExternalResourceDependency.html#getDescription--">getDescription</a></span>()</code> | |
| <div class="block">Retrieves the textual description of the resource.</div> | |
| </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code><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/ExternalResourceDependency.html#getInterfaceName--">getInterfaceName</a></span>()</code> | |
| <div class="block">Retrieves the name of the Java interface through which this resource will be accessed.</div> | |
| </td> | |
| </tr> | |
| <tr id="i2" class="altColor"> | |
| <td class="colFirst"><code><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/ExternalResourceDependency.html#getKey--">getKey</a></span>()</code> | |
| <div class="block">Retrieves the key by which the resource is identified.</div> | |
| </td> | |
| </tr> | |
| <tr id="i3" class="rowColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/ExternalResourceDependency.html#isOptional--">isOptional</a></span>()</code> | |
| <div class="block">Gets whether this resource dependency is optional.</div> | |
| </td> | |
| </tr> | |
| <tr id="i4" class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/ExternalResourceDependency.html#setDescription-java.lang.String-">setDescription</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> aDescription)</code> | |
| <div class="block">Retrieves the textual description of the resource.</div> | |
| </td> | |
| </tr> | |
| <tr id="i5" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/ExternalResourceDependency.html#setInterfaceName-java.lang.String-">setInterfaceName</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)</code> | |
| <div class="block">Sets the name of the Java interface through which this resource will be accessed.</div> | |
| </td> | |
| </tr> | |
| <tr id="i6" class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/resource/ExternalResourceDependency.html#setKey-java.lang.String-">setKey</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)</code> | |
| <div class="block">Sets the key by which the resource is identified.</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/ExternalResourceDependency.html#setOptional-boolean-">setOptional</a></span>(boolean aOptional)</code> | |
| <div class="block">Sets whether this resource dependency is optional.</div> | |
| </td> | |
| </tr> | |
| </table> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.uima.resource.metadata.MetaDataObject"> | |
| <!-- --> | |
| </a> | |
| <h3>Methods inherited from interface org.apache.uima.resource.metadata.<a href="../../../../org/apache/uima/resource/metadata/MetaDataObject.html" title="interface in org.apache.uima.resource.metadata">MetaDataObject</a></h3> | |
| <code><a href="../../../../org/apache/uima/resource/metadata/MetaDataObject.html#clone--">clone</a>, <a href="../../../../org/apache/uima/resource/metadata/MetaDataObject.html#equals-java.lang.Object-">equals</a>, <a href="../../../../org/apache/uima/resource/metadata/MetaDataObject.html#getAttributeValue-java.lang.String-">getAttributeValue</a>, <a href="../../../../org/apache/uima/resource/metadata/MetaDataObject.html#getSourceUrl--">getSourceUrl</a>, <a href="../../../../org/apache/uima/resource/metadata/MetaDataObject.html#getSourceUrlString--">getSourceUrlString</a>, <a href="../../../../org/apache/uima/resource/metadata/MetaDataObject.html#isModifiable--">isModifiable</a>, <a href="../../../../org/apache/uima/resource/metadata/MetaDataObject.html#listAttributes--">listAttributes</a>, <a href="../../../../org/apache/uima/resource/metadata/MetaDataObject.html#setAttributeValue-java.lang.String-java.lang.Object-">setAttributeValue</a>, <a href="../../../../org/apache/uima/resource/metadata/MetaDataObject.html#setSourceUrl-java.net.URL-">setSourceUrl</a></code></li> | |
| </ul> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.uima.util.XMLizable"> | |
| <!-- --> | |
| </a> | |
| <h3>Methods inherited from interface org.apache.uima.util.<a href="../../../../org/apache/uima/util/XMLizable.html" title="interface in org.apache.uima.util">XMLizable</a></h3> | |
| <code><a href="../../../../org/apache/uima/util/XMLizable.html#buildFromXMLElement-org.w3c.dom.Element-org.apache.uima.util.XMLParser-">buildFromXMLElement</a>, <a href="../../../../org/apache/uima/util/XMLizable.html#buildFromXMLElement-org.w3c.dom.Element-org.apache.uima.util.XMLParser-org.apache.uima.util.XMLParser.ParsingOptions-">buildFromXMLElement</a>, <a href="../../../../org/apache/uima/util/XMLizable.html#toXML-org.xml.sax.ContentHandler-">toXML</a>, <a href="../../../../org/apache/uima/util/XMLizable.html#toXML-org.xml.sax.ContentHandler-boolean-">toXML</a>, <a href="../../../../org/apache/uima/util/XMLizable.html#toXML-java.io.OutputStream-">toXML</a>, <a href="../../../../org/apache/uima/util/XMLizable.html#toXML-java.io.Writer-">toXML</a></code></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="details"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="method.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Detail</h3> | |
| <a name="getKey--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getKey</h4> | |
| <pre><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> getKey()</pre> | |
| <div class="block">Retrieves the key by which the resource is identified.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the key for this resource.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="setKey-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>setKey</h4> | |
| <pre>void setKey(<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)</pre> | |
| <div class="block">Sets the key by which the resource is identified.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>aKey</code> - the key for this resource.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getDescription--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getDescription</h4> | |
| <pre><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> getDescription()</pre> | |
| <div class="block">Retrieves the textual description of the resource.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the textual description of the resource.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="setDescription-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>setDescription</h4> | |
| <pre>void setDescription(<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">Retrieves the textual description of the resource.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>aDescription</code> - the textual description of the resource.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getInterfaceName--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getInterfaceName</h4> | |
| <pre><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> getInterfaceName()</pre> | |
| <div class="block">Retrieves the name of the Java interface through which this resource will be accessed.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the name of the Java interface for this external resource, <code>null</code> if none.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="setInterfaceName-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>setInterfaceName</h4> | |
| <pre>void setInterfaceName(<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)</pre> | |
| <div class="block">Sets the name of the Java interface through which this resource will be accessed.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>aName</code> - the name of the Java interface for this external resource, <code>null</code> if | |
| none.</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="../../../../org/apache/uima/UIMA_UnsupportedOperationException.html" title="class in org.apache.uima">UIMA_UnsupportedOperationException</a></code> - if this object is not modifiable</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="isOptional--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>isOptional</h4> | |
| <pre>boolean isOptional()</pre> | |
| <div class="block">Gets whether this resource dependency is optional. Dependencies that are not optional must be | |
| linked to resource definitions prior to instantiating the Analysis Engine, or an exception will | |
| be thrown.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>true if this resource dependency is optional, false if not</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="setOptional-boolean-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>setOptional</h4> | |
| <pre>void setOptional(boolean aOptional)</pre> | |
| <div class="block">Sets whether this resource dependency is optional. Dependencies that are not optional must be | |
| linked to resource definitions prior to instantiating the Analysis Engine, or an exception will | |
| be thrown.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>aOptional</code> - true if this resource dependency is optional, false if not</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/ExternalResourceDependency.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/DataResource.html" title="interface in org.apache.uima.resource"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../org/apache/uima/resource/ExternalResourceDescription.html" title="interface in org.apache.uima.resource"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../index.html?org/apache/uima/resource/ExternalResourceDependency.html" target="_top">Frames</a></li> | |
| <li><a href="ExternalResourceDependency.html" target="_top">No Frames</a></li> | |
| </ul> | |
| <ul class="navList" id="allclasses_navbar_bottom"> | |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> | |
| <li>Nested | </li> | |
| <li>Field | </li> | |
| <li>Constr | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li>Field | </li> | |
| <li>Constr | </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 © 2006–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> | |
| </body> | |
| </html> |