Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/ExternalResourceFactory.html ------------------------------------------------------------------------------ svn:eol-style = native
Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/ExternalResourceFactory.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/FlowControllerFactory.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/FlowControllerFactory.html?rev=1857643&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/FlowControllerFactory.html (added) +++ uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/FlowControllerFactory.html Tue Apr 16 11:40:19 2019 @@ -0,0 +1,317 @@ +<!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>FlowControllerFactory (Apache uimaFIT 3.0.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="FlowControllerFactory (Apache uimaFIT 3.0.0 User-Level API Documentation)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":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/FlowControllerFactory.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/ExternalResourceFactory.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/FsIndexFactory.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/FlowControllerFactory.html" target="_top">Frames</a></li> +<li><a href="FlowControllerFactory.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 FlowControllerFactory" class="title">Class FlowControllerFactory</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.FlowControllerFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">FlowControllerFactory</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.flow.FlowControllerDescription</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/FlowControllerFactory.html#createFlowControllerDescription-java.lang.Class-org.apache.uima.resource.metadata.ConfigurationParameter:A-java.lang.Object:A-">createFlowControllerDescription</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.flow.FlowController> flowControllerClass, + 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> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.flow.FlowControllerDescription</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/FlowControllerFactory.html#createFlowControllerDescription-java.lang.Class-org.apache.uima.resource.metadata.ConfigurationParameter:A-java.lang.Object:A-java.util.Map-">createFlowControllerDescription</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.flow.FlowController> flowControllerClass, + 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, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,org.apache.uima.resource.ExternalResourceDescription> externalResources)</code> +<div class="block">Creates a new FlowControllerDescription for a given class and configuration parameters with + values</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.flow.FlowControllerDescription</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/FlowControllerFactory.html#createFlowControllerDescription-java.lang.Class-java.lang.Object...-">createFlowControllerDescription</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.flow.FlowController> flowControllerClass, + <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">Creates a new FlowControllerDescription for a given class and configuration data</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="createFlowControllerDescription-java.lang.Class-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createFlowControllerDescription</h4> +<pre>public static org.apache.uima.flow.FlowControllerDescription createFlowControllerDescription(<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.flow.FlowController> flowControllerClass, + <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) + throws org.apache.uima.resource.ResourceInitializationException</pre> +<div class="block">Creates a new FlowControllerDescription for a given class and configuration data</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>flowControllerClass</code> - the flow controller class</dd> +<dd><code>configurationData</code> - should be configuration parameter name / value pairs.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a flow controller description</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.resource.ResourceInitializationException</code> - if the description could not be created</dd> +</dl> +</li> +</ul> +<a name="createFlowControllerDescription-java.lang.Class-org.apache.uima.resource.metadata.ConfigurationParameter:A-java.lang.Object:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createFlowControllerDescription</h4> +<pre>public static org.apache.uima.flow.FlowControllerDescription createFlowControllerDescription(<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.flow.FlowController> flowControllerClass, + 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) + throws org.apache.uima.resource.ResourceInitializationException</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>flowControllerClass</code> - the flow controller class</dd> +<dd><code>configurationParameters</code> - the configuration parameters</dd> +<dd><code>configurationValues</code> - the configuration parameter values</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a flow controller description</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.resource.ResourceInitializationException</code> - if the description could not be created</dd> +</dl> +</li> +</ul> +<a name="createFlowControllerDescription-java.lang.Class-org.apache.uima.resource.metadata.ConfigurationParameter:A-java.lang.Object:A-java.util.Map-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createFlowControllerDescription</h4> +<pre>public static org.apache.uima.flow.FlowControllerDescription createFlowControllerDescription(<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.flow.FlowController> flowControllerClass, + 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, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,org.apache.uima.resource.ExternalResourceDescription> externalResources) + throws org.apache.uima.resource.ResourceInitializationException</pre> +<div class="block">Creates a new FlowControllerDescription for a given class and configuration parameters with + values</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>flowControllerClass</code> - the flow controller class</dd> +<dd><code>configurationParameters</code> - the configuration parameters</dd> +<dd><code>configurationValues</code> - the configuration parameter values</dd> +<dd><code>externalResources</code> - the external resources</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a flow controller description</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.resource.ResourceInitializationException</code> - if the description could not be created</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/FlowControllerFactory.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/ExternalResourceFactory.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/FsIndexFactory.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/FlowControllerFactory.html" target="_top">Frames</a></li> +<li><a href="FlowControllerFactory.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–2019 <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-3.0.0/api/org/apache/uima/fit/factory/FlowControllerFactory.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/FlowControllerFactory.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/FsIndexFactory.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/FsIndexFactory.html?rev=1857643&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/FsIndexFactory.html (added) +++ uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/FsIndexFactory.html Tue Apr 16 11:40:19 2019 @@ -0,0 +1,523 @@ +<!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>FsIndexFactory (Apache uimaFIT 3.0.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="FsIndexFactory (Apache uimaFIT 3.0.0 User-Level API Documentation)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9}; +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/FsIndexFactory.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/FlowControllerFactory.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/JCasBuilder.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/FsIndexFactory.html" target="_top">Frames</a></li> +<li><a href="FsIndexFactory.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.uima.fit.factory</div> +<h2 title="Class FsIndexFactory" class="title">Class FsIndexFactory</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.FsIndexFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">FsIndexFactory</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"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#REVERSE_STANDARD_COMPARE">REVERSE_STANDARD_COMPARE</a></span></code> +<div class="block">Comparator that orders FeatureStructures according to the reverse order of their key features + (the opposite order as that defined by STANDARD_COMPARE).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#STANDARD_COMPARE">STANDARD_COMPARE</a></span></code> +<div class="block">Comparator that orders FeatureStructures according to the standard order of their key features.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.resource.metadata.FsIndexCollection</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#createFsIndexCollection--">createFsIndexCollection</a></span>()</code> +<div class="block">Creates a <code>FsIndexCollection</code> from all index descriptions that can be found via the + pattern specified in the system property <code>org.apache.uima.fit.fsindex.import_pattern</code> or + via the <code>META-INF/org.apache.uima.fit/fsindexes.txt</code> files in the classpath.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.resource.metadata.FsIndexCollection</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#createFsIndexCollection-java.lang.Class-">createFsIndexCollection</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><?> componentClass)</code> +<div class="block">Create index configuration data for a given class definition using reflection and the + configuration parameter annotation.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.resource.metadata.FsIndexCollection</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#createFsIndexCollection-org.apache.uima.resource.metadata.FsIndexDescription...-">createFsIndexCollection</a></span>(org.apache.uima.resource.metadata.FsIndexDescription... descriptions)</code> +<div class="block">Create a index collection from a set of descriptions.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.resource.metadata.FsIndexCollection</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#createFsIndexCollection-java.lang.String...-">createFsIndexCollection</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>... descriptorNames)</code> +<div class="block">Creates a <code>FsIndexCollection</code> from descriptor names.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.resource.metadata.FsIndexDescription</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#createFsIndexDescription-java.lang.String-java.lang.String-java.lang.String-boolean-org.apache.uima.resource.metadata.FsIndexKeyDescription...-">createFsIndexDescription</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> label, + <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> kind, + <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> typeName, + boolean useTypePriorities, + org.apache.uima.resource.metadata.FsIndexKeyDescription... keys)</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.resource.metadata.FsIndexKeyDescription</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#createFsIndexKeyDescription-java.lang.String-">createFsIndexKeyDescription</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> featureName)</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.resource.metadata.FsIndexKeyDescription</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#createFsIndexKeyDescription-java.lang.String-int-">createFsIndexKeyDescription</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> featureName, + int comparator)</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.resource.metadata.FsIndexCollection</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#createTypeSystemDescriptionFromPath-java.lang.String...-">createTypeSystemDescriptionFromPath</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>... descriptorURIs)</code> +<div class="block">Creates a <code>FsIndexCollection</code> from a descriptor file</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#forceIndexDescriptorsScan--">forceIndexDescriptorsScan</a></span>()</code> +<div class="block">Force rescan of index descriptors.</div> +</td> +</tr> +<tr id="i9" 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/FsIndexFactory.html#scanIndexDescriptors--">scanIndexDescriptors</a></span>()</code> +<div class="block">Get all currently accessible index descriptor locations.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="STANDARD_COMPARE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>STANDARD_COMPARE</h4> +<pre>public static final int STANDARD_COMPARE</pre> +<div class="block">Comparator that orders FeatureStructures according to the standard order of their key features. + For integer and float values, this is the standard linear order, and for strings it is + lexicographic order.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.uima.fit.factory.FsIndexFactory.STANDARD_COMPARE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="REVERSE_STANDARD_COMPARE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>REVERSE_STANDARD_COMPARE</h4> +<pre>public static final int REVERSE_STANDARD_COMPARE</pre> +<div class="block">Comparator that orders FeatureStructures according to the reverse order of their key features + (the opposite order as that defined by STANDARD_COMPARE).</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.uima.fit.factory.FsIndexFactory.REVERSE_STANDARD_COMPARE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createFsIndexCollection-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createFsIndexCollection</h4> +<pre>public static org.apache.uima.resource.metadata.FsIndexCollection createFsIndexCollection(<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><?> componentClass)</pre> +<div class="block">Create index configuration data for a given class definition using reflection and the + configuration parameter annotation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>componentClass</code> - the class to analyze</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the index collection</dd> +</dl> +</li> +</ul> +<a name="createFsIndexDescription-java.lang.String-java.lang.String-java.lang.String-boolean-org.apache.uima.resource.metadata.FsIndexKeyDescription...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createFsIndexDescription</h4> +<pre>public static org.apache.uima.resource.metadata.FsIndexDescription createFsIndexDescription(<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> label, + <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> kind, + <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> typeName, + boolean useTypePriorities, + org.apache.uima.resource.metadata.FsIndexKeyDescription... keys)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>label</code> - the index label</dd> +<dd><code>kind</code> - the type of index</dd> +<dd><code>typeName</code> - the indexed feature structure type</dd> +<dd><code>useTypePriorities</code> - whether to respect type priorities</dd> +<dd><code>keys</code> - the index keys</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the index description</dd> +</dl> +</li> +</ul> +<a name="createFsIndexCollection-org.apache.uima.resource.metadata.FsIndexDescription...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createFsIndexCollection</h4> +<pre>public static org.apache.uima.resource.metadata.FsIndexCollection createFsIndexCollection(org.apache.uima.resource.metadata.FsIndexDescription... descriptions)</pre> +<div class="block">Create a index collection from a set of descriptions.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>descriptions</code> - the index descriptions</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the index collection</dd> +</dl> +</li> +</ul> +<a name="createFsIndexKeyDescription-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createFsIndexKeyDescription</h4> +<pre>public static org.apache.uima.resource.metadata.FsIndexKeyDescription createFsIndexKeyDescription(<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> featureName)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>featureName</code> - the feature to index</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the index key description</dd> +</dl> +</li> +</ul> +<a name="createFsIndexKeyDescription-java.lang.String-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createFsIndexKeyDescription</h4> +<pre>public static org.apache.uima.resource.metadata.FsIndexKeyDescription createFsIndexKeyDescription(<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> featureName, + int comparator)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>featureName</code> - the feature to index</dd> +<dd><code>comparator</code> - the index comparator</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the index key description</dd> +</dl> +</li> +</ul> +<a name="createFsIndexCollection-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createFsIndexCollection</h4> +<pre>public static org.apache.uima.resource.metadata.FsIndexCollection createFsIndexCollection(<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>... descriptorNames)</pre> +<div class="block">Creates a <code>FsIndexCollection</code> from descriptor names.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>descriptorNames</code> - The fully qualified, Java-style, dotted descriptor names.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a <code>FsIndexCollection</code> that includes the indexes from all of the specified files.</dd> +</dl> +</li> +</ul> +<a name="createTypeSystemDescriptionFromPath-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createTypeSystemDescriptionFromPath</h4> +<pre>public static org.apache.uima.resource.metadata.FsIndexCollection createTypeSystemDescriptionFromPath(<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>... descriptorURIs)</pre> +<div class="block">Creates a <code>FsIndexCollection</code> from a descriptor file</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>descriptorURIs</code> - The descriptor file paths.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A <code>FsIndexCollection</code> that includes the indexes from all of the specified files.</dd> +</dl> +</li> +</ul> +<a name="createFsIndexCollection--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createFsIndexCollection</h4> +<pre>public static org.apache.uima.resource.metadata.FsIndexCollection createFsIndexCollection() + throws org.apache.uima.resource.ResourceInitializationException</pre> +<div class="block">Creates a <code>FsIndexCollection</code> from all index descriptions that can be found via the + pattern specified in the system property <code>org.apache.uima.fit.fsindex.import_pattern</code> or + via the <code>META-INF/org.apache.uima.fit/fsindexes.txt</code> files in the classpath.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the auto-scanned indexes.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.resource.ResourceInitializationException</code> - if the index collection could not be assembled</dd> +</dl> +</li> +</ul> +<a name="scanIndexDescriptors--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>scanIndexDescriptors</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>[] scanIndexDescriptors() + throws org.apache.uima.resource.ResourceInitializationException</pre> +<div class="block">Get all currently accessible index descriptor locations. A scan is actually only performed on + the first call and the locations are cached. To force a re-scan use + <a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#forceIndexDescriptorsScan--"><code>forceIndexDescriptorsScan()</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array of locations.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.uima.resource.ResourceInitializationException</code> - if the locations could not be resolved.</dd> +</dl> +</li> +</ul> +<a name="forceIndexDescriptorsScan--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>forceIndexDescriptorsScan</h4> +<pre>public static void forceIndexDescriptorsScan()</pre> +<div class="block">Force rescan of index descriptors. The next call to <a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html#scanIndexDescriptors--"><code>scanIndexDescriptors()</code></a> will rescan + all auto-import locations.</div> +</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/FsIndexFactory.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/FlowControllerFactory.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/JCasBuilder.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/FsIndexFactory.html" target="_top">Frames</a></li> +<li><a href="FsIndexFactory.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><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2012–2019 <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-3.0.0/api/org/apache/uima/fit/factory/FsIndexFactory.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/FsIndexFactory.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/JCasBuilder.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/JCasBuilder.html?rev=1857643&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/JCasBuilder.html (added) +++ uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/JCasBuilder.html Tue Apr 16 11:40:19 2019 @@ -0,0 +1,401 @@ +<!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>JCasBuilder (Apache uimaFIT 3.0.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="JCasBuilder (Apache uimaFIT 3.0.0 User-Level API Documentation)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/JCasBuilder.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/FsIndexFactory.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/JCasFactory.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/JCasBuilder.html" target="_top">Frames</a></li> +<li><a href="JCasBuilder.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 JCasBuilder" class="title">Class JCasBuilder</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.JCasBuilder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">JCasBuilder</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">Allows to add types and text to a CAS easily piece by piece.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/JCasBuilder.html#JCasBuilder-org.apache.uima.jcas.JCas-">JCasBuilder</a></span>(org.apache.uima.jcas.JCas aJCas)</code> +<div class="block">Create a new JCas builder working on the specified JCas.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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><T> T</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/JCasBuilder.html#add-int-java.lang.Class-">add</a></span>(int aBegin, + <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><T> aClass)</code> +<div class="block">Add an annotation starting at the specified position and ending at the current end of the text.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/JCasBuilder.html#add-java.lang.String-">add</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">Append a text.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><T> T</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/JCasBuilder.html#add-java.lang.String-java.lang.Class-">add</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/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> aClass)</code> +<div class="block">Append a text annotated with the specified annotation.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/JCasBuilder.html#close--">close</a></span>()</code> +<div class="block">Complete the building process by writing the text into the CAS.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>org.apache.uima.jcas.JCas</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/JCasBuilder.html#getJCas--">getJCas</a></span>()</code> +<div class="block">Get the JCas.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/factory/JCasBuilder.html#getPosition--">getPosition</a></span>()</code> +<div class="block">Get the current "cursor" position (current text length).</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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="JCasBuilder-org.apache.uima.jcas.JCas-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>JCasBuilder</h4> +<pre>public JCasBuilder(org.apache.uima.jcas.JCas aJCas)</pre> +<div class="block">Create a new JCas builder working on the specified JCas. The JCas must not have any content + yet.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aJCas</code> - the working JCas.</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="add-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre>public void add(<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)</pre> +<div class="block">Append a text.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aText</code> - the text to append.</dd> +</dl> +</li> +</ul> +<a name="add-java.lang.String-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre>public <T> T add(<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/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> aClass)</pre> +<div class="block">Append a text annotated with the specified annotation. The created annotation is returned and + further properties can be set on it. The annotation is already added to the indexes.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - annotation type</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aText</code> - covered text</dd> +<dd><code>aClass</code> - annotation type</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>annotation instance - can be used to set features or determine offsets</dd> +</dl> +</li> +</ul> +<a name="add-int-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre>public <T> T add(int aBegin, + <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><T> aClass)</pre> +<div class="block">Add an annotation starting at the specified position and ending at the current end of the text. + The created annotation is returned and further properties can be set on it. The annotation is + already added to the indexes.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - annotation type</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aBegin</code> - begin offset.</dd> +<dd><code>aClass</code> - annotation type</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>annotation instance - can be used to set features or determine offsets</dd> +</dl> +</li> +</ul> +<a name="getPosition--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPosition</h4> +<pre>public int getPosition()</pre> +<div class="block">Get the current "cursor" position (current text length).</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>current text length.</dd> +</dl> +</li> +</ul> +<a name="getJCas--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJCas</h4> +<pre>public org.apache.uima.jcas.JCas getJCas()</pre> +<div class="block">Get the JCas.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the JCas.</dd> +</dl> +</li> +</ul> +<a name="close--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block">Complete the building process by writing the text into the CAS. This can only be called once.</div> +</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/JCasBuilder.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/FsIndexFactory.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/JCasFactory.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/JCasBuilder.html" target="_top">Frames</a></li> +<li><a href="JCasBuilder.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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–2019 <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-3.0.0/api/org/apache/uima/fit/factory/JCasBuilder.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/factory/JCasBuilder.html ------------------------------------------------------------------------------ svn:mime-type = text/html