Added: uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/JCasFactory.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/JCasFactory.html?rev=1877018&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/JCasFactory.html (added) +++ uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/JCasFactory.html Sun Apr 26 12:12:18 2020 @@ -0,0 +1,420 @@ +<!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>JCasFactory (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="JCasFactory (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}; +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/JCasFactory.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/JCasBuilder.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/ResourceCreationSpecifierFactory.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/JCasFactory.html" target="_top">Frames</a></li> +<li><a href="JCasFactory.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.fit.factory</div> +<h2 title="Class JCasFactory" class="title">Class JCasFactory</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.JCasFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">JCasFactory</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">Convenience methods to create <code>JCas</code> objects.</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="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 org.apache.uima.jcas.JCas</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/JCasFactory.html#createJCas--">createJCas</a></span>()</code> +<div class="block">Creates a new <code>JCas</code>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.jcas.JCas</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/JCasFactory.html#createJCas-java.lang.String...-">createJCas</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>... typeSystemDescriptorNames)</code> +<div class="block">Creates a new JCas from type system descriptor files found by name.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.jcas.JCas</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/JCasFactory.html#createJCas-java.lang.String-org.apache.uima.resource.metadata.TypeSystemDescription-">createJCas</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> fileName, + org.apache.uima.resource.metadata.TypeSystemDescription typeSystemDescription)</code> +<div class="block">This method creates a new JCas and loads the contents of an XMI or XCAS file into it.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.jcas.JCas</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/JCasFactory.html#createJCas-org.apache.uima.resource.metadata.TypeSystemDescription-">createJCas</a></span>(org.apache.uima.resource.metadata.TypeSystemDescription typeSystemDescription)</code> +<div class="block">Create a new JCas for the given type system description.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.jcas.JCas</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/JCasFactory.html#createJCasFromPath-java.lang.String...-">createJCasFromPath</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>... typeSystemDescriptorPaths)</code> +<div class="block">Creates a new JCas from type system descriptor files.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.jcas.JCas</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/JCasFactory.html#createText-java.lang.String-">createText</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> aText)</code> +<div class="block">Creates a new JCas with the given text.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.jcas.JCas</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/JCasFactory.html#createText-java.lang.String-java.lang.String-">createText</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> aText, + <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> aLanguage)</code> +<div class="block">Creates a new JCas with the given text and language.</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createText-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createText</h4> +<pre>public static org.apache.uima.jcas.JCas createText(<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> aText) + throws org.apache.uima.UIMAException</pre> +<div class="block">Creates a new JCas with the given text. The type system is detected automatically using + <a href="../../../../../org/apache/uima/fit/factory/TypeSystemDescriptionFactory.html#createTypeSystemDescription--"><code>TypeSystemDescriptionFactory.createTypeSystemDescription()</code></a>. Type priorities are + detected automatically using <a href="../../../../../org/apache/uima/fit/factory/TypePrioritiesFactory.html#createTypePriorities--"><code>TypePrioritiesFactory.createTypePriorities()</code></a>. Indexes are + detected automatically using <a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#createFsIndexCollection--"><code>FsIndexFactory.createFsIndexCollection()</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aText</code> - the document text to be set in the new JCas.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new JCas</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.UIMAException</code> - if the JCas could not be initialized</dd> +</dl> +</li> +</ul> +<a name="createText-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createText</h4> +<pre>public static org.apache.uima.jcas.JCas createText(<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> aText, + <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> aLanguage) + throws org.apache.uima.UIMAException</pre> +<div class="block">Creates a new JCas with the given text and language. The type system is detected automatically + using <a href="../../../../../org/apache/uima/fit/factory/TypeSystemDescriptionFactory.html#createTypeSystemDescription--"><code>TypeSystemDescriptionFactory.createTypeSystemDescription()</code></a>. Type priorities are + detected automatically using <a href="../../../../../org/apache/uima/fit/factory/TypePrioritiesFactory.html#createTypePriorities--"><code>TypePrioritiesFactory.createTypePriorities()</code></a>. Indexes are + detected automatically using <a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#createFsIndexCollection--"><code>FsIndexFactory.createFsIndexCollection()</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aText</code> - the document text to be set in the new JCas.</dd> +<dd><code>aLanguage</code> - the document language to be set in the new JCas.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new JCas</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.UIMAException</code> - if the JCas could not be initialized</dd> +</dl> +</li> +</ul> +<a name="createJCas--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createJCas</h4> +<pre>public static org.apache.uima.jcas.JCas createJCas() + throws org.apache.uima.UIMAException</pre> +<div class="block">Creates a new <code>JCas</code>. The type system is detected automatically using + <a href="../../../../../org/apache/uima/fit/factory/TypeSystemDescriptionFactory.html#createTypeSystemDescription--"><code>TypeSystemDescriptionFactory.createTypeSystemDescription()</code></a>. Type priorities are + detected automatically using <a href="../../../../../org/apache/uima/fit/factory/TypePrioritiesFactory.html#createTypePriorities--"><code>TypePrioritiesFactory.createTypePriorities()</code></a>. Indexes are + detected automatically using <a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#createFsIndexCollection--"><code>FsIndexFactory.createFsIndexCollection()</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new JCas</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.UIMAException</code> - if the JCas could not be initialized</dd> +</dl> +</li> +</ul> +<a name="createJCas-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createJCas</h4> +<pre>public static org.apache.uima.jcas.JCas createJCas(<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>... typeSystemDescriptorNames) + throws org.apache.uima.UIMAException</pre> +<div class="block">Creates a new JCas from type system descriptor files found by name. No auto-detection for type + priorities, or indexes is performed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>typeSystemDescriptorNames</code> - names of the type system descriptors on the classpath used to initialize the JCas (in + Java notation, e.g. "my.package.TypeSystem" without the ".xml" extension)</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new JCas</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.UIMAException</code> - if the JCas could not be initialized</dd> +</dl> +</li> +</ul> +<a name="createJCasFromPath-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createJCasFromPath</h4> +<pre>public static org.apache.uima.jcas.JCas createJCasFromPath(<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>... typeSystemDescriptorPaths) + throws org.apache.uima.UIMAException</pre> +<div class="block">Creates a new JCas from type system descriptor files. No auto-detection for type priorities, or + indexes is performed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>typeSystemDescriptorPaths</code> - paths to type system descriptor files</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new JCas</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.UIMAException</code> - if the JCas could not be initialized</dd> +</dl> +</li> +</ul> +<a name="createJCas-org.apache.uima.resource.metadata.TypeSystemDescription-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createJCas</h4> +<pre>public static org.apache.uima.jcas.JCas createJCas(org.apache.uima.resource.metadata.TypeSystemDescription typeSystemDescription) + throws org.apache.uima.UIMAException</pre> +<div class="block">Create a new JCas for the given type system description. No auto-detection type priorities, or + indexes is performed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>typeSystemDescription</code> - a type system description to initialize the JCas</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new JCas</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.UIMAException</code> - if the JCas could not be initialized</dd> +</dl> +</li> +</ul> +<a name="createJCas-java.lang.String-org.apache.uima.resource.metadata.TypeSystemDescription-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createJCas</h4> +<pre>public static org.apache.uima.jcas.JCas createJCas(<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> fileName, + org.apache.uima.resource.metadata.TypeSystemDescription typeSystemDescription) + throws org.apache.uima.UIMAException, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">This method creates a new JCas and loads the contents of an XMI or XCAS file into it.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fileName</code> - a file name for the serialized CAS data</dd> +<dd><code>typeSystemDescription</code> - a type system description to initialize the JCas</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new JCas</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.UIMAException</code> - if the JCas could not be initialized</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if there is a problem reading the file</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/JCasFactory.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/JCasBuilder.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/ResourceCreationSpecifierFactory.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/JCasFactory.html" target="_top">Frames</a></li> +<li><a href="JCasFactory.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 © 2012–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
Propchange: uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/JCasFactory.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/JCasFactory.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ResourceCreationSpecifierFactory.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ResourceCreationSpecifierFactory.html?rev=1877018&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ResourceCreationSpecifierFactory.html (added) +++ uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ResourceCreationSpecifierFactory.html Sun Apr 26 12:12:18 2020 @@ -0,0 +1,404 @@ +<!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>ResourceCreationSpecifierFactory (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="ResourceCreationSpecifierFactory (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}; +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/ResourceCreationSpecifierFactory.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/JCasFactory.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/ResourceMetaDataFactory.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/ResourceCreationSpecifierFactory.html" target="_top">Frames</a></li> +<li><a href="ResourceCreationSpecifierFactory.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.fit.factory</div> +<h2 title="Class ResourceCreationSpecifierFactory" class="title">Class ResourceCreationSpecifierFactory</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.ResourceCreationSpecifierFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">ResourceCreationSpecifierFactory</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> +</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="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 org.apache.uima.resource.ResourceCreationSpecifier</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ResourceCreationSpecifierFactory.html#createResourceCreationSpecifier-java.lang.String-java.lang.Object:A-">createResourceCreationSpecifier</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> descriptorPath, + <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>[] parameters)</code> +<div class="block">Parse a ResourceCreationSpecifier from an XML descriptor file, setting additional configuration + parameters as necessary.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.resource.ResourceCreationSpecifier</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ResourceCreationSpecifierFactory.html#createResourceCreationSpecifier-java.net.URL-java.lang.Object:A-">createResourceCreationSpecifier</a></span>(<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> descriptorURL, + <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>[] parameters)</code> +<div class="block">Parse a ResourceCreationSpecifier from the URL of an XML descriptor file, setting additional + configuration parameters as necessary.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.resource.ResourceCreationSpecifier</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/ResourceCreationSpecifierFactory.html#createResourceCreationSpecifier-org.apache.uima.util.XMLInputSource-java.lang.Object:A-">createResourceCreationSpecifier</a></span>(org.apache.uima.util.XMLInputSource xmlInput, + <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>[] parameters)</code> +<div class="block">Parse a ResourceCreationSpecifier from XML descriptor file input, setting additional + configuration parameters as necessary.</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/ResourceCreationSpecifierFactory.html#setConfigurationParameters-org.apache.uima.resource.ResourceCreationSpecifier-org.apache.uima.resource.metadata.ConfigurationParameter:A-java.lang.Object:A-">setConfigurationParameters</a></span>(org.apache.uima.resource.ResourceCreationSpecifier specifier, + org.apache.uima.resource.metadata.ConfigurationParameter[] configurationParameters, + <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>[] configurationValues)</code> +<div class="block">This method passes through to + <a href="../../../../../org/apache/uima/fit/factory/ResourceCreationSpecifierFactory.html#setConfigurationParameters-org.apache.uima.resource.metadata.ResourceMetaData-org.apache.uima.resource.metadata.ConfigurationParameter:A-java.lang.Object:A-"><code>setConfigurationParameters(ResourceMetaData, ConfigurationParameter[], Object[])</code></a></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/ResourceCreationSpecifierFactory.html#setConfigurationParameters-org.apache.uima.resource.ResourceCreationSpecifier-java.lang.Object...-">setConfigurationParameters</a></span>(org.apache.uima.resource.ResourceCreationSpecifier specifier, + <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">Create configuration parameter declarations and settings from a list of (name, value) pairs.</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/ResourceCreationSpecifierFactory.html#setConfigurationParameters-org.apache.uima.resource.metadata.ResourceMetaData-org.apache.uima.resource.metadata.ConfigurationParameter:A-java.lang.Object:A-">setConfigurationParameters</a></span>(org.apache.uima.resource.metadata.ResourceMetaData metaData, + org.apache.uima.resource.metadata.ConfigurationParameter[] configurationParameters, + <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>[] configurationValues)</code> +<div class="block">This method sets the configuration parameters of a resource.</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createResourceCreationSpecifier-java.net.URL-java.lang.Object:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createResourceCreationSpecifier</h4> +<pre>public static org.apache.uima.resource.ResourceCreationSpecifier createResourceCreationSpecifier(<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> descriptorURL, + <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>[] parameters) + throws org.apache.uima.util.InvalidXMLException, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Parse a ResourceCreationSpecifier from the URL of an XML descriptor file, setting additional + configuration parameters as necessary.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>descriptorURL</code> - The URL of the XML descriptor file.</dd> +<dd><code>parameters</code> - Any additional configuration parameters to be set. These should be supplied as (name, + value) pairs, so there should always be an even number of parameters.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The ResourceCreationSpecifier for the XML descriptor with all the configuration + parameters set.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd> +<dd><code>org.apache.uima.util.InvalidXMLException</code> - if the input XML is not valid or does not specify a valid <code>ResourceSpecifier</code></dd> +</dl> +</li> +</ul> +<a name="createResourceCreationSpecifier-org.apache.uima.util.XMLInputSource-java.lang.Object:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createResourceCreationSpecifier</h4> +<pre>public static org.apache.uima.resource.ResourceCreationSpecifier createResourceCreationSpecifier(org.apache.uima.util.XMLInputSource xmlInput, + <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>[] parameters) + throws org.apache.uima.util.InvalidXMLException</pre> +<div class="block">Parse a ResourceCreationSpecifier from XML descriptor file input, setting additional + configuration parameters as necessary.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>xmlInput</code> - The descriptor file as an XMLInputSource.</dd> +<dd><code>parameters</code> - Any additional configuration parameters to be set. These should be supplied as (name, + value) pairs, so there should always be an even number of parameters.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The ResourceCreationSpecifier for the XML descriptor with all the configuration + parameters set.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.util.InvalidXMLException</code> - if the input XML is not valid or does not specify a valid <code>ResourceSpecifier</code></dd> +</dl> +</li> +</ul> +<a name="createResourceCreationSpecifier-java.lang.String-java.lang.Object:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createResourceCreationSpecifier</h4> +<pre>public static org.apache.uima.resource.ResourceCreationSpecifier createResourceCreationSpecifier(<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> descriptorPath, + <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>[] parameters) + throws org.apache.uima.util.InvalidXMLException, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Parse a ResourceCreationSpecifier from an XML descriptor file, setting additional configuration + parameters as necessary.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>descriptorPath</code> - The path to the XML descriptor file.</dd> +<dd><code>parameters</code> - Any additional configuration parameters to be set. These should be supplied as (name, + value) pairs, so there should always be an even number of parameters.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The ResourceCreationSpecifier for the XML descriptor with all the configuration + parameters set.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd> +<dd><code>org.apache.uima.util.InvalidXMLException</code> - if the input XML is not valid or does not specify a valid <code>ResourceSpecifier</code></dd> +</dl> +</li> +</ul> +<a name="setConfigurationParameters-org.apache.uima.resource.ResourceCreationSpecifier-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConfigurationParameters</h4> +<pre>public static void setConfigurationParameters(org.apache.uima.resource.ResourceCreationSpecifier specifier, + <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)</pre> +<div class="block">Create configuration parameter declarations and settings from a list of (name, value) pairs.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>specifier</code> - The ResourceCreationSpecifier whose parameters are to be set.</dd> +<dd><code>configurationData</code> - The configuration parameters to be set. These should be supplied as (name, value) + pairs, so there should always be an even number of parameters.</dd> +</dl> +</li> +</ul> +<a name="setConfigurationParameters-org.apache.uima.resource.ResourceCreationSpecifier-org.apache.uima.resource.metadata.ConfigurationParameter:A-java.lang.Object:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConfigurationParameters</h4> +<pre>public static void setConfigurationParameters(org.apache.uima.resource.ResourceCreationSpecifier specifier, + org.apache.uima.resource.metadata.ConfigurationParameter[] configurationParameters, + <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>[] configurationValues)</pre> +<div class="block">This method passes through to + <a href="../../../../../org/apache/uima/fit/factory/ResourceCreationSpecifierFactory.html#setConfigurationParameters-org.apache.uima.resource.metadata.ResourceMetaData-org.apache.uima.resource.metadata.ConfigurationParameter:A-java.lang.Object:A-"><code>setConfigurationParameters(ResourceMetaData, ConfigurationParameter[], Object[])</code></a></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>specifier</code> - The ResourceCreationSpecifier whose parameters are to be set.</dd> +<dd><code>configurationParameters</code> - the configuration parameter declarations.</dd> +<dd><code>configurationValues</code> - the configuration parameter values.</dd> +</dl> +</li> +</ul> +<a name="setConfigurationParameters-org.apache.uima.resource.metadata.ResourceMetaData-org.apache.uima.resource.metadata.ConfigurationParameter:A-java.lang.Object:A-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setConfigurationParameters</h4> +<pre>public static void setConfigurationParameters(org.apache.uima.resource.metadata.ResourceMetaData metaData, + org.apache.uima.resource.metadata.ConfigurationParameter[] configurationParameters, + <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>[] configurationValues)</pre> +<div class="block">This method sets the configuration parameters of a resource. The length of + configurationParameters and configurationValues should be equal</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>metaData</code> - The ResourceMetaData whose parameters are to be set.</dd> +<dd><code>configurationParameters</code> - an array of configuration parameters</dd> +<dd><code>configurationValues</code> - an array of configuration parameter values</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/ResourceCreationSpecifierFactory.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/JCasFactory.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/ResourceMetaDataFactory.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/ResourceCreationSpecifierFactory.html" target="_top">Frames</a></li> +<li><a href="ResourceCreationSpecifierFactory.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 © 2012–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Propchange: uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ResourceCreationSpecifierFactory.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ResourceCreationSpecifierFactory.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ResourceMetaDataFactory.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ResourceMetaDataFactory.html?rev=1877018&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ResourceMetaDataFactory.html (added) +++ uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ResourceMetaDataFactory.html Sun Apr 26 12:12:18 2020 @@ -0,0 +1,364 @@ +<!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>ResourceMetaDataFactory (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="ResourceMetaDataFactory (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}; +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/ResourceMetaDataFactory.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/ResourceCreationSpecifierFactory.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/SofaMappingFactory.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/ResourceMetaDataFactory.html" target="_top">Frames</a></li> +<li><a href="ResourceMetaDataFactory.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.fit.factory</div> +<h2 title="Class ResourceMetaDataFactory" class="title">Class ResourceMetaDataFactory</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.ResourceMetaDataFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">ResourceMetaDataFactory</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">Convenience methods to create resource metadata.</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="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/ResourceMetaDataFactory.html#configureResourceMetaData-org.apache.uima.resource.metadata.ResourceMetaData-java.lang.Class-">configureResourceMetaData</a></span>(org.apache.uima.resource.metadata.ResourceMetaData aMetaData, + <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><?> aComponentClass)</code> +<div class="block">Adds meta data from a <a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html" title="annotation in org.apache.uima.fit.descriptor"><code>ResourceMetaData</code></a> annotation to the + given meta data object if such an annotation is present on the component class.</div> +</td> +</tr> +<tr id="i1" 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/ResourceMetaDataFactory.html#getDefaultCopyright-java.lang.Class-">getDefaultCopyright</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><?> aComponentClass)</code> +<div class="block">Get the default copyright of a component class.</div> +</td> +</tr> +<tr id="i2" 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/ResourceMetaDataFactory.html#getDefaultDescription-java.lang.Class-">getDefaultDescription</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><?> aComponentClass)</code> +<div class="block">Get the default description of a component class.</div> +</td> +</tr> +<tr id="i3" 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/ResourceMetaDataFactory.html#getDefaultName-java.lang.Class-">getDefaultName</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><?> aComponentClass)</code> +<div class="block">Get the default name of a component class.</div> +</td> +</tr> +<tr id="i4" 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/ResourceMetaDataFactory.html#getDefaultVendor-java.lang.Class-">getDefaultVendor</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><?> aComponentClass)</code> +<div class="block">Get the default vendor of a component class.</div> +</td> +</tr> +<tr id="i5" 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/ResourceMetaDataFactory.html#getDefaultVersion-java.lang.Class-">getDefaultVersion</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><?> aComponentClass)</code> +<div class="block">Get the default version of a component class.</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="configureResourceMetaData-org.apache.uima.resource.metadata.ResourceMetaData-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>configureResourceMetaData</h4> +<pre>public static void configureResourceMetaData(org.apache.uima.resource.metadata.ResourceMetaData aMetaData, + <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><?> aComponentClass)</pre> +<div class="block">Adds meta data from a <a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html" title="annotation in org.apache.uima.fit.descriptor"><code>ResourceMetaData</code></a> annotation to the + given meta data object if such an annotation is present on the component class. If no + annotation is present, default values are be added.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aMetaData</code> - the meta data object to configure.</dd> +<dd><code>aComponentClass</code> - the class that may carry the <a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html" title="annotation in org.apache.uima.fit.descriptor"><code>ResourceMetaData</code></a> + annotation</dd> +</dl> +</li> +</ul> +<a name="getDefaultCopyright-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultCopyright</h4> +<pre>public 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> getDefaultCopyright(<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><?> aComponentClass)</pre> +<div class="block">Get the default copyright of a component class.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aComponentClass</code> - the class to analyze</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the default copyright</dd> +</dl> +</li> +</ul> +<a name="getDefaultVersion-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultVersion</h4> +<pre>public 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> getDefaultVersion(<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><?> aComponentClass)</pre> +<div class="block">Get the default version of a component class.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aComponentClass</code> - the class to analyze</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the default version</dd> +</dl> +</li> +</ul> +<a name="getDefaultDescription-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultDescription</h4> +<pre>public 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> getDefaultDescription(<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><?> aComponentClass)</pre> +<div class="block">Get the default description of a component class.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aComponentClass</code> - the class to analyze</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the default description</dd> +</dl> +</li> +</ul> +<a name="getDefaultVendor-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultVendor</h4> +<pre>public 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> getDefaultVendor(<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><?> aComponentClass)</pre> +<div class="block">Get the default vendor of a component class.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aComponentClass</code> - the class to analyze</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the package name of the component, if the component is in a package, otherwise + <code>null</code>.</dd> +</dl> +</li> +</ul> +<a name="getDefaultName-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getDefaultName</h4> +<pre>public 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> getDefaultName(<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><?> aComponentClass)</pre> +<div class="block">Get the default name of a component class.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aComponentClass</code> - the class to analyze</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the fully qualified name of the class.</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/ResourceMetaDataFactory.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/ResourceCreationSpecifierFactory.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/SofaMappingFactory.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/ResourceMetaDataFactory.html" target="_top">Frames</a></li> +<li><a href="ResourceMetaDataFactory.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 © 2012–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Propchange: uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ResourceMetaDataFactory.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/ResourceMetaDataFactory.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/SofaMappingFactory.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/SofaMappingFactory.html?rev=1877018&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/SofaMappingFactory.html (added) +++ uima/site/trunk/uima-website/docs/d/uimafit-2.5.0/api/org/apache/uima/fit/factory/SofaMappingFactory.html Sun Apr 26 12:12:18 2020 @@ -0,0 +1,292 @@ +<!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>SofaMappingFactory (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="SofaMappingFactory (Apache uimaFIT 2.5.0 User-Level API Documentation)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":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/SofaMappingFactory.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/ResourceMetaDataFactory.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/TypePrioritiesFactory.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/SofaMappingFactory.html" target="_top">Frames</a></li> +<li><a href="SofaMappingFactory.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.fit.factory</div> +<h2 title="Class SofaMappingFactory" class="title">Class SofaMappingFactory</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.SofaMappingFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">SofaMappingFactory</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">Convenience methods to handle SofA mappings.</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="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 org.apache.uima.analysis_engine.metadata.SofaMapping</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/SofaMappingFactory.html#createSofaMapping-java.lang.Class-java.lang.String-java.lang.String-">createSofaMapping</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.analysis_component.AnalysisComponent> componentClass, + <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> componentSofaName, + <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> aggregateSofaName)</code> +<div class="block">Create a sofa mapping using the component class rather than the component name.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.analysis_engine.metadata.SofaMapping</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/SofaMappingFactory.html#createSofaMapping-java.lang.String-java.lang.String-java.lang.String-">createSofaMapping</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> componentKey, + <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> componentSofaName, + <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> aggregateSofaName)</code> +<div class="block">This method creates a sofa mapping which is useful for mapping view names in individual + components used in aggregate analysis engines to the view names used by the aggregate.</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createSofaMapping-java.lang.String-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createSofaMapping</h4> +<pre>public static org.apache.uima.analysis_engine.metadata.SofaMapping createSofaMapping(<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> componentKey, + <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> componentSofaName, + <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> aggregateSofaName)</pre> +<div class="block">This method creates a sofa mapping which is useful for mapping view names in individual + components used in aggregate analysis engines to the view names used by the aggregate. + <p> + WARNING: in version 0.9.12 the ordering of the parameters was changed! The order used to be + aggregateSofaName, componentKey, componentSofaName. This was changed because it seemed an + unnatural ordering.</p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>componentKey</code> - the key/name used by the aggregate analysis engine for the component whose view is + being mapped.</dd> +<dd><code>componentSofaName</code> - the sofa name used by the the component</dd> +<dd><code>aggregateSofaName</code> - the view name that the component name is mapped to and used by the aggregate analysis + engine</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a sofa mapping with the componentSofaName mapped to the aggregateSofaName</dd> +</dl> +</li> +</ul> +<a name="createSofaMapping-java.lang.Class-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createSofaMapping</h4> +<pre>public static org.apache.uima.analysis_engine.metadata.SofaMapping createSofaMapping(<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.analysis_component.AnalysisComponent> componentClass, + <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> componentSofaName, + <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> aggregateSofaName)</pre> +<div class="block">Create a sofa mapping using the component class rather than the component name. Actually, the + name of the class is used as the component name.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>componentClass</code> - the component clas</dd> +<dd><code>componentSofaName</code> - the sofa name used by the the component</dd> +<dd><code>aggregateSofaName</code> - the view name that the component name is mapped to and used by the aggregate analysis + engine</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a sofa mapping with the componentSofaName mapped to the aggregateSofaName</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/SofaMappingFactory.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/ResourceMetaDataFactory.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/TypePrioritiesFactory.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/SofaMappingFactory.html" target="_top">Frames</a></li> +<li><a href="SofaMappingFactory.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 © 2012–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>