You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by re...@apache.org on 2019/04/16 11:40:22 UTC
svn commit: r1857643 [32/46] - in /uima/site/trunk/uima-website: docs/
docs/d/uimafit-3.0.0/ docs/d/uimafit-3.0.0/api/
docs/d/uimafit-3.0.0/api/org/ docs/d/uimafit-3.0.0/api/org/apache/
docs/d/uimafit-3.0.0/api/org/apache/uima/ docs/d/uimafit-3.0.0/api...
Added: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/JCasIterable.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/JCasIterable.html?rev=1857643&view=auto
==============================================================================
--- uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/JCasIterable.html (added)
+++ uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/JCasIterable.html Tue Apr 16 11:40:19 2019
@@ -0,0 +1,310 @@
+<!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>JCasIterable (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="JCasIterable (Apache uimaFIT 3.0.0 User-Level API Documentation)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":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/JCasIterable.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>Prev Class</li>
+<li><a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html" title="class in org.apache.uima.fit.pipeline"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/uima/fit/pipeline/JCasIterable.html" target="_top">Frames</a></li>
+<li><a href="JCasIterable.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.pipeline</div>
+<h2 title="Class JCasIterable" class="title">Class JCasIterable</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.pipeline.JCasIterable</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><org.apache.uima.jcas.JCas></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">JCasIterable</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>
+implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><org.apache.uima.jcas.JCas></pre>
+<div class="block"><p>
+ A class implementing iteration over a the documents of a collection. Each element in the Iterable
+ is a JCas containing a single document. The documents have been loaded by the CollectionReader
+ and processed by the AnalysisEngine (if any).
+ </p>
+ <p>
+ External resources can be shared between the reader and the analysis engines.
+ </p></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/pipeline/JCasIterable.html#JCasIterable-org.apache.uima.collection.CollectionReaderDescription-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">JCasIterable</a></span>(org.apache.uima.collection.CollectionReaderDescription aReader,
+ org.apache.uima.analysis_engine.AnalysisEngineDescription... aEngines)</code>
+<div class="block">Iterate over the documents loaded by the CollectionReader, running the AnalysisEngine on each
+ one before yielding them.</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><a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html" title="class in org.apache.uima.fit.pipeline">JCasIterator</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/JCasIterable.html#iterator--">iterator</a></span>()</code> </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>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
+<!-- -->
+</a>
+<h3>Methods inherited from interface java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3>
+<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</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="JCasIterable-org.apache.uima.collection.CollectionReaderDescription-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>JCasIterable</h4>
+<pre>public JCasIterable(org.apache.uima.collection.CollectionReaderDescription aReader,
+ org.apache.uima.analysis_engine.AnalysisEngineDescription... aEngines)</pre>
+<div class="block">Iterate over the documents loaded by the CollectionReader, running the AnalysisEngine on each
+ one before yielding them. When created with this constructor, analysis engines by default
+ receive a collectionProcessComplete call when all documents have been read from the reader and
+ all components get destroyed.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>aReader</code> - The CollectionReader for loading documents.</dd>
+<dd><code>aEngines</code> - The AnalysisEngines for processing documents.</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="iterator--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>iterator</h4>
+<pre>public <a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html" title="class in org.apache.uima.fit.pipeline">JCasIterator</a> iterator()</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator--" title="class or interface in java.lang">iterator</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><org.apache.uima.jcas.JCas></code></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/JCasIterable.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>Prev Class</li>
+<li><a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html" title="class in org.apache.uima.fit.pipeline"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/uima/fit/pipeline/JCasIterable.html" target="_top">Frames</a></li>
+<li><a href="JCasIterable.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/pipeline/JCasIterable.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/JCasIterable.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/JCasIterator.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/JCasIterator.html?rev=1857643&view=auto
==============================================================================
--- uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/JCasIterator.html (added)
+++ uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/JCasIterator.html Tue Apr 16 11:40:19 2019
@@ -0,0 +1,527 @@
+<!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>JCasIterator (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="JCasIterator (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,"i6":10,"i7":10,"i8":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/JCasIterator.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/pipeline/JCasIterable.html" title="class in org.apache.uima.fit.pipeline"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/pipeline/SimplePipeline.html" title="class in org.apache.uima.fit.pipeline"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/uima/fit/pipeline/JCasIterator.html" target="_top">Frames</a></li>
+<li><a href="JCasIterator.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.pipeline</div>
+<h2 title="Class JCasIterator" class="title">Class JCasIterator</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.pipeline.JCasIterator</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><org.apache.uima.jcas.JCas></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">JCasIterator</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>
+implements <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><org.apache.uima.jcas.JCas></pre>
+<div class="block">A class implementing iteration over a the documents of a collection. Each element in the Iterable
+ is a JCas containing a single document. The documents have been loaded by the CollectionReader
+ and processed by the AnalysisEngine (if any).</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/pipeline/JCasIterator.html#JCasIterator-org.apache.uima.collection.CollectionReader-org.apache.uima.analysis_engine.AnalysisEngine...-">JCasIterator</a></span>(org.apache.uima.collection.CollectionReader aReader,
+ org.apache.uima.analysis_engine.AnalysisEngine... aEngines)</code>
+<div class="block">Iterate over the documents loaded by the CollectionReader, running the AnalysisEngine on each
+ one before yielding them.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#JCasIterator-org.apache.uima.collection.CollectionReader-org.apache.uima.resource.metadata.TypeSystemDescription-">JCasIterator</a></span>(org.apache.uima.collection.CollectionReader aReader,
+ org.apache.uima.resource.metadata.TypeSystemDescription aTypeSystemDescription)</code>
+<div class="block">Iterate over the documents loaded by the CollectionReader.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#JCasIterator-org.apache.uima.resource.ResourceManager-org.apache.uima.collection.CollectionReader-org.apache.uima.analysis_engine.AnalysisEngine...-">JCasIterator</a></span>(org.apache.uima.resource.ResourceManager aResMgr,
+ org.apache.uima.collection.CollectionReader aReader,
+ org.apache.uima.analysis_engine.AnalysisEngine... aEngines)</code>
+<div class="block">Iterate over the documents loaded by the CollectionReader, running the AnalysisEngine on each
+ one before yielding them.</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>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#collectionProcessComplete--">collectionProcessComplete</a></span>()</code>
+<div class="block">Notify analysis engines that the collection process is complete.</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/pipeline/JCasIterator.html#destroy--">destroy</a></span>()</code>
+<div class="block">Close and destroy all components.s</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#hasNext--">hasNext</a></span>()</code> </td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#isSelfComplete--">isSelfComplete</a></span>()</code>
+<div class="block">Get whether <a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#collectionProcessComplete--"><code>collectionProcessComplete()</code></a> is automatically called.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#isSelfDestroy--">isSelfDestroy</a></span>()</code>
+<div class="block">Get whether <a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#destroy--"><code>destroy()</code></a> is automatically called.</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code>org.apache.uima.jcas.JCas</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#next--">next</a></span>()</code> </td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#remove--">remove</a></span>()</code> </td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#setSelfComplete-boolean-">setSelfComplete</a></span>(boolean aSelfComplete)</code>
+<div class="block">Send a <a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#collectionProcessComplete--"><code>collectionProcessComplete()</code></a> call to analysis engines when the reader has no
+ further CASes to produce.</div>
+</td>
+</tr>
+<tr id="i8" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#setSelfDestroy-boolean-">setSelfDestroy</a></span>(boolean aSelfDestroy)</code>
+<div class="block">Send a destroy call to analysis engines when the reader has no further CASes to produce or if
+ an error occurs.</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>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.util.Iterator">
+<!-- -->
+</a>
+<h3>Methods inherited from interface java.util.<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></h3>
+<code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true#forEachRemaining-java.util.function.Consumer-" title="class or interface in java.util">forEachRemaining</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="JCasIterator-org.apache.uima.collection.CollectionReader-org.apache.uima.analysis_engine.AnalysisEngine...-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>JCasIterator</h4>
+<pre>public JCasIterator(org.apache.uima.collection.CollectionReader aReader,
+ org.apache.uima.analysis_engine.AnalysisEngine... aEngines)
+ throws org.apache.uima.cas.CASException,
+ org.apache.uima.resource.ResourceInitializationException</pre>
+<div class="block">Iterate over the documents loaded by the CollectionReader, running the AnalysisEngine on each
+ one before yielding them. By default, components get no lifecycle events, such as
+ collectionProcessComplete or destroy when this constructor is used.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>aReader</code> - The CollectionReader for loading documents.</dd>
+<dd><code>aEngines</code> - The AnalysisEngines for processing documents.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.uima.resource.ResourceInitializationException</code> - if a failure occurs during initialization of the components</dd>
+<dd><code>org.apache.uima.cas.CASException</code> - if the JCas could not be initialized</dd>
+</dl>
+</li>
+</ul>
+<a name="JCasIterator-org.apache.uima.resource.ResourceManager-org.apache.uima.collection.CollectionReader-org.apache.uima.analysis_engine.AnalysisEngine...-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>JCasIterator</h4>
+<pre>public JCasIterator(org.apache.uima.resource.ResourceManager aResMgr,
+ org.apache.uima.collection.CollectionReader aReader,
+ org.apache.uima.analysis_engine.AnalysisEngine... aEngines)
+ throws org.apache.uima.cas.CASException,
+ org.apache.uima.resource.ResourceInitializationException</pre>
+<div class="block">Iterate over the documents loaded by the CollectionReader, running the AnalysisEngine on each
+ one before yielding them. By default, components get no lifecycle events, such as
+ collectionProcessComplete or destroy when this constructor is used.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>aResMgr</code> - The ResourceManager. Should be the one also used by the CollectionReader and
+ AnalysisEngines.</dd>
+<dd><code>aReader</code> - The CollectionReader for loading documents.</dd>
+<dd><code>aEngines</code> - The AnalysisEngines for processing documents.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.uima.resource.ResourceInitializationException</code> - if a failure occurs during initialization of the components</dd>
+<dd><code>org.apache.uima.cas.CASException</code> - if the JCas could not be initialized</dd>
+</dl>
+</li>
+</ul>
+<a name="JCasIterator-org.apache.uima.collection.CollectionReader-org.apache.uima.resource.metadata.TypeSystemDescription-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>JCasIterator</h4>
+<pre>public JCasIterator(org.apache.uima.collection.CollectionReader aReader,
+ org.apache.uima.resource.metadata.TypeSystemDescription aTypeSystemDescription)
+ throws org.apache.uima.cas.CASException,
+ org.apache.uima.resource.ResourceInitializationException</pre>
+<div class="block">Iterate over the documents loaded by the CollectionReader. (Uses an JCasAnnotatorAdapter to
+ create the document JCas.) By default, components get no lifecycle events, such as
+ collectionProcessComplete or destroy when this constructor is used.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>aReader</code> - The CollectionReader for loading documents.</dd>
+<dd><code>aTypeSystemDescription</code> - a type system description</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.uima.resource.ResourceInitializationException</code> - if a failure occurs during initialization of the components</dd>
+<dd><code>org.apache.uima.cas.CASException</code> - if the JCas could not be initialized</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="hasNext--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>hasNext</h4>
+<pre>public boolean hasNext()</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true#hasNext--" title="class or interface in java.util">hasNext</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><org.apache.uima.jcas.JCas></code></dd>
+</dl>
+</li>
+</ul>
+<a name="next--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>next</h4>
+<pre>public org.apache.uima.jcas.JCas next()</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true#next--" title="class or interface in java.util">next</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><org.apache.uima.jcas.JCas></code></dd>
+</dl>
+</li>
+</ul>
+<a name="remove--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>remove</h4>
+<pre>public void remove()</pre>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true#remove--" title="class or interface in java.util">remove</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><org.apache.uima.jcas.JCas></code></dd>
+</dl>
+</li>
+</ul>
+<a name="collectionProcessComplete--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>collectionProcessComplete</h4>
+<pre>public void collectionProcessComplete()
+ throws org.apache.uima.analysis_engine.AnalysisEngineProcessException</pre>
+<div class="block">Notify analysis engines that the collection process is complete.</div>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code> - if there was a problem completing the process</dd>
+</dl>
+</li>
+</ul>
+<a name="destroy--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>destroy</h4>
+<pre>public void destroy()</pre>
+<div class="block">Close and destroy all components.s</div>
+</li>
+</ul>
+<a name="isSelfComplete--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isSelfComplete</h4>
+<pre>public boolean isSelfComplete()</pre>
+<div class="block">Get whether <a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#collectionProcessComplete--"><code>collectionProcessComplete()</code></a> is automatically called.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>whether <a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#collectionProcessComplete--"><code>collectionProcessComplete()</code></a> is automatically called.</dd>
+</dl>
+</li>
+</ul>
+<a name="setSelfComplete-boolean-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setSelfComplete</h4>
+<pre>public void setSelfComplete(boolean aSelfComplete)</pre>
+<div class="block">Send a <a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#collectionProcessComplete--"><code>collectionProcessComplete()</code></a> call to analysis engines when the reader has no
+ further CASes to produce.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>aSelfComplete</code> - whether to enable the automatic call to <a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#collectionProcessComplete--"><code>collectionProcessComplete()</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="isSelfDestroy--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isSelfDestroy</h4>
+<pre>public boolean isSelfDestroy()</pre>
+<div class="block">Get whether <a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#destroy--"><code>destroy()</code></a> is automatically called.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>whether <a href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#destroy--"><code>destroy()</code></a> is automatically called.</dd>
+</dl>
+</li>
+</ul>
+<a name="setSelfDestroy-boolean-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>setSelfDestroy</h4>
+<pre>public void setSelfDestroy(boolean aSelfDestroy)</pre>
+<div class="block">Send a destroy call to analysis engines when the reader has no further CASes to produce or if
+ an error occurs.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>aSelfDestroy</code> - whether to enable the automatic call to <code>Resource.destroy()</code></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/JCasIterator.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/pipeline/JCasIterable.html" title="class in org.apache.uima.fit.pipeline"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/pipeline/SimplePipeline.html" title="class in org.apache.uima.fit.pipeline"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/uima/fit/pipeline/JCasIterator.html" target="_top">Frames</a></li>
+<li><a href="JCasIterator.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/pipeline/JCasIterator.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/JCasIterator.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/SimplePipeline.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/SimplePipeline.html?rev=1857643&view=auto
==============================================================================
--- uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/SimplePipeline.html (added)
+++ uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/SimplePipeline.html Tue Apr 16 11:40:19 2019
@@ -0,0 +1,602 @@
+<!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>SimplePipeline (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="SimplePipeline (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};
+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/SimplePipeline.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/pipeline/JCasIterator.html" title="class in org.apache.uima.fit.pipeline"><span class="typeNameLink">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/uima/fit/pipeline/SimplePipeline.html" target="_top">Frames</a></li>
+<li><a href="SimplePipeline.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.pipeline</div>
+<h2 title="Class SimplePipeline" class="title">Class SimplePipeline</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.pipeline.SimplePipeline</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public final class <span class="typeNameLabel">SimplePipeline</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 <a href="../../../../../org/apache/uima/fit/pipeline/JCasIterable.html" title="class in org.apache.uima.fit.pipeline">JCasIterable</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/SimplePipeline.html#iteratePipeline-org.apache.uima.collection.CollectionReaderDescription-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">iteratePipeline</a></span>(org.apache.uima.collection.CollectionReaderDescription aReader,
+ org.apache.uima.analysis_engine.AnalysisEngineDescription... aEngines)</code>
+<div class="block">
+ Iterate through the <code>JCases</code> processed by the pipeline, allowing to access each one
+ after it has been processed.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/SimplePipeline.html#runPipeline-org.apache.uima.cas.CAS-org.apache.uima.analysis_engine.AnalysisEngine...-">runPipeline</a></span>(org.apache.uima.cas.CAS cas,
+ org.apache.uima.analysis_engine.AnalysisEngine... engines)</code>
+<div class="block">
+ Run a sequence of <code>analysis engines</code> over a <code>CAS</code>.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/SimplePipeline.html#runPipeline-org.apache.uima.cas.CAS-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">runPipeline</a></span>(org.apache.uima.cas.CAS aCas,
+ org.apache.uima.analysis_engine.AnalysisEngineDescription... aDescs)</code>
+<div class="block">
+ Run a sequence of <code>analysis engines</code> over a <code>JCas</code>.</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/pipeline/SimplePipeline.html#runPipeline-org.apache.uima.collection.CollectionReader-org.apache.uima.analysis_engine.AnalysisEngine...-">runPipeline</a></span>(org.apache.uima.collection.CollectionReader reader,
+ org.apache.uima.analysis_engine.AnalysisEngine... engines)</code>
+<div class="block">
+ Provides a simple way to run a pipeline for a given collection reader and sequence of analysis
+ engines.</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/pipeline/SimplePipeline.html#runPipeline-org.apache.uima.collection.CollectionReader-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">runPipeline</a></span>(org.apache.uima.collection.CollectionReader reader,
+ org.apache.uima.analysis_engine.AnalysisEngineDescription... descs)</code>
+<div class="block">
+ Run the CollectionReader and AnalysisEngines as a pipeline.</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/pipeline/SimplePipeline.html#runPipeline-org.apache.uima.collection.CollectionReaderDescription-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">runPipeline</a></span>(org.apache.uima.collection.CollectionReaderDescription readerDesc,
+ org.apache.uima.analysis_engine.AnalysisEngineDescription... descs)</code>
+<div class="block">
+ Run the CollectionReader and AnalysisEngines as a pipeline.</div>
+</td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/SimplePipeline.html#runPipeline-org.apache.uima.jcas.JCas-org.apache.uima.analysis_engine.AnalysisEngine...-">runPipeline</a></span>(org.apache.uima.jcas.JCas jCas,
+ org.apache.uima.analysis_engine.AnalysisEngine... engines)</code>
+<div class="block">
+ Run a sequence of <code>analysis engines</code> over a <code>JCas</code>.</div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/pipeline/SimplePipeline.html#runPipeline-org.apache.uima.jcas.JCas-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">runPipeline</a></span>(org.apache.uima.jcas.JCas jCas,
+ org.apache.uima.analysis_engine.AnalysisEngineDescription... descs)</code>
+<div class="block">
+ Run a sequence of <code>analysis engines</code> over a <code>JCas</code>.</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/pipeline/SimplePipeline.html#runPipeline-org.apache.uima.resource.ResourceManager-org.apache.uima.collection.CollectionReader-org.apache.uima.analysis_engine.AnalysisEngine...-">runPipeline</a></span>(org.apache.uima.resource.ResourceManager aResMgr,
+ org.apache.uima.collection.CollectionReader reader,
+ org.apache.uima.analysis_engine.AnalysisEngine... engines)</code>
+<div class="block">
+ Provides a simple way to run a pipeline for a given collection reader and sequence of analysis
+ engines.</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="runPipeline-org.apache.uima.collection.CollectionReader-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>runPipeline</h4>
+<pre>public static void runPipeline(org.apache.uima.collection.CollectionReader reader,
+ org.apache.uima.analysis_engine.AnalysisEngineDescription... descs)
+ throws <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>,
+ org.apache.uima.resource.ResourceInitializationException,
+ org.apache.uima.analysis_engine.AnalysisEngineProcessException,
+ org.apache.uima.collection.CollectionException</pre>
+<div class="block"><p>
+ Run the CollectionReader and AnalysisEngines as a pipeline. After processing all CASes provided
+ by the reader, the method calls the life-cycle methods
+ (<code>collectionProcessComplete()</code> on the engines
+ and <code>destroy()</code>) on all engines. Note that the life-cycle methods are
+ <b>NOT</b> called on the reader. As the reader was instantiated by the caller, it must also be
+ managed (i.e. destroyed) the caller.
+ </p>
+ <p>
+ Note that with this method, external resources cannot be shared between the reader and the
+ analysis engines. They can be shared amongst the analysis engines.
+ </p>
+ <p>
+ The CAS is created using the resource manager used by the collection reader.
+ </p></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>reader</code> - The CollectionReader that loads the documents into the CAS.</dd>
+<dd><code>descs</code> - Primitive AnalysisEngineDescriptions that process the CAS, in order. If you have a mix
+ of primitive and aggregate engines, then please create the AnalysisEngines yourself
+ and call the other runPipeline method.</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 there is an I/O problem in the reader</dd>
+<dd><code>org.apache.uima.resource.ResourceInitializationException</code> - if there is a problem initializing or running the pipeline.</dd>
+<dd><code>org.apache.uima.collection.CollectionException</code> - if there is a problem initializing or running the pipeline.</dd>
+<dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code> - if there is a problem initializing or running the pipeline.</dd>
+</dl>
+</li>
+</ul>
+<a name="runPipeline-org.apache.uima.collection.CollectionReaderDescription-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>runPipeline</h4>
+<pre>public static void runPipeline(org.apache.uima.collection.CollectionReaderDescription readerDesc,
+ org.apache.uima.analysis_engine.AnalysisEngineDescription... descs)
+ throws <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>,
+ org.apache.uima.resource.ResourceInitializationException,
+ org.apache.uima.analysis_engine.AnalysisEngineProcessException,
+ org.apache.uima.collection.CollectionException</pre>
+<div class="block"><p>
+ Run the CollectionReader and AnalysisEngines as a pipeline. After processing all CASes provided
+ by the reader, the method calls <code>collectionProcessComplete()</code> on the engines, <code>close()</code> on the
+ reader and <code>destroy()</code> on the reader and all engines.
+ </p>
+ <p>
+ External resources can be shared between the reader and the analysis engines.
+ </p>
+ <p>
+ This method is suitable for the batch-processing of sets of documents where the overheaded
+ of instantiating the pipeline components does not significantly impact the overall runtime
+ of the pipeline. If you need to avoid this overhead, e.g. because you wish to run a pipeline
+ on individual documents, then you should not use this method. Instead, create a CAS using
+ <a href="../../../../../org/apache/uima/fit/factory/JCasFactory.html" title="class in org.apache.uima.fit.factory"><code>JCasFactory</code></a>, create a reader instance using <a href="../../../../../org/apache/uima/fit/factory/CollectionReaderFactory.html#createReader-java.lang.String-java.lang.Object...-"><code>CollectionReaderFactory.createReader(java.lang.String, java.lang.Object...)</code></a>,
+ create an engine instance using <a href="../../../../../org/apache/uima/fit/factory/AnalysisEngineFactory.html#createEngine-java.lang.String-java.lang.Object...-"><code>AnalysisEngineFactory.createEngine(java.lang.String, java.lang.Object...)</code></a> and then use
+ a loop to process the data, resetting the CAS after each step.
+ </p>
+ <pre><code>
+ while (reader.hasNext()) {
+ reader.getNext(cas);
+ engine.process(cas);
+ cas.reset();
+ }
+ </code></pre></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>readerDesc</code> - The CollectionReader that loads the documents into the CAS.</dd>
+<dd><code>descs</code> - Primitive AnalysisEngineDescriptions that process the CAS, in order. If you have a mix
+ of primitive and aggregate engines, then please create the AnalysisEngines yourself
+ and call the other runPipeline method.</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 there is an I/O problem in the reader</dd>
+<dd><code>org.apache.uima.resource.ResourceInitializationException</code> - if there is a problem initializing or running the pipeline.</dd>
+<dd><code>org.apache.uima.collection.CollectionException</code> - if there is a problem initializing or running the pipeline.</dd>
+<dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code> - if there is a problem initializing or running the pipeline.</dd>
+</dl>
+</li>
+</ul>
+<a name="runPipeline-org.apache.uima.collection.CollectionReader-org.apache.uima.analysis_engine.AnalysisEngine...-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>runPipeline</h4>
+<pre>public static void runPipeline(org.apache.uima.collection.CollectionReader reader,
+ org.apache.uima.analysis_engine.AnalysisEngine... engines)
+ throws <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>,
+ org.apache.uima.analysis_engine.AnalysisEngineProcessException,
+ org.apache.uima.resource.ResourceInitializationException,
+ org.apache.uima.collection.CollectionException</pre>
+<div class="block"><p>
+ Provides a simple way to run a pipeline for a given collection reader and sequence of analysis
+ engines. After processing all CASes provided by the reader, the method calls
+ <code>collectionProcessComplete()</code> on the engines.
+ Note that <code>Resource.destroy()</code> and <code>Resource.destroy()</code> are
+ <b>NOT</b> called. As the components were instantiated by the caller, they must also be managed
+ (i.e. destroyed) the caller.
+ </p>
+ <p>
+ External resources can only be shared between the reader and/or the analysis engines if the
+ reader/engines have been previously instantiated using a shared resource manager.
+ </p>
+ <p>
+ The CAS is created using the resource manager used by the collection reader.
+ </p></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>reader</code> - a collection reader</dd>
+<dd><code>engines</code> - a sequence of analysis engines</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 there is an I/O problem in the reader</dd>
+<dd><code>org.apache.uima.collection.CollectionException</code> - if there is a problem initializing or running the pipeline.</dd>
+<dd><code>org.apache.uima.resource.ResourceInitializationException</code> - if there is a problem initializing or running the pipeline.</dd>
+<dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code> - if there is a problem initializing or running the pipeline.</dd>
+</dl>
+</li>
+</ul>
+<a name="runPipeline-org.apache.uima.resource.ResourceManager-org.apache.uima.collection.CollectionReader-org.apache.uima.analysis_engine.AnalysisEngine...-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>runPipeline</h4>
+<pre>public static void runPipeline(org.apache.uima.resource.ResourceManager aResMgr,
+ org.apache.uima.collection.CollectionReader reader,
+ org.apache.uima.analysis_engine.AnalysisEngine... engines)
+ throws <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>,
+ org.apache.uima.resource.ResourceInitializationException,
+ org.apache.uima.analysis_engine.AnalysisEngineProcessException,
+ org.apache.uima.collection.CollectionException</pre>
+<div class="block"><p>
+ Provides a simple way to run a pipeline for a given collection reader and sequence of analysis
+ engines. After processing all CASes provided by the reader, the method calls
+ <code>collectionProcessComplete()</code> on the engines.
+ Note that <code>Resource.destroy()</code> and <code>Resource.destroy()</code> are
+ <b>NOT</b> called. As the components were instantiated by the caller, they must also be managed
+ (i.e. destroyed) the caller.
+ </p>
+ <p>
+ External resources can only be shared between the reader and/or the analysis engines if the
+ reader/engines have been previously instantiated using a shared resource manager.
+ </p></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>aResMgr</code> - a resource manager. Normally the same one used by the collection reader and analysis
+ engines.</dd>
+<dd><code>reader</code> - a collection reader</dd>
+<dd><code>engines</code> - a sequence of analysis engines</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 there is an I/O problem in the reader</dd>
+<dd><code>org.apache.uima.resource.ResourceInitializationException</code> - if there is a problem initializing or running the pipeline.</dd>
+<dd><code>org.apache.uima.collection.CollectionException</code> - if there is a problem initializing or running the pipeline.</dd>
+<dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code> - if there is a problem initializing or running the pipeline.</dd>
+</dl>
+</li>
+</ul>
+<a name="runPipeline-org.apache.uima.cas.CAS-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>runPipeline</h4>
+<pre>public static void runPipeline(org.apache.uima.cas.CAS aCas,
+ org.apache.uima.analysis_engine.AnalysisEngineDescription... aDescs)
+ throws org.apache.uima.resource.ResourceInitializationException,
+ org.apache.uima.analysis_engine.AnalysisEngineProcessException</pre>
+<div class="block"><p>
+ Run a sequence of <code>analysis engines</code> over a <code>JCas</code>. The result of
+ the analysis can be read from the JCas.
+ </p>
+ <p>
+ External resources can be shared between the analysis engines.
+ </p></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>aCas</code> - the CAS to process</dd>
+<dd><code>aDescs</code> - a sequence of analysis engines to run on the jCas</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.uima.resource.ResourceInitializationException</code> - if there is a problem initializing the components</dd>
+<dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code> - if there is a problem during the execution of the components</dd>
+</dl>
+</li>
+</ul>
+<a name="runPipeline-org.apache.uima.jcas.JCas-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>runPipeline</h4>
+<pre>public static void runPipeline(org.apache.uima.jcas.JCas jCas,
+ org.apache.uima.analysis_engine.AnalysisEngineDescription... descs)
+ throws org.apache.uima.analysis_engine.AnalysisEngineProcessException,
+ org.apache.uima.resource.ResourceInitializationException</pre>
+<div class="block"><p>
+ Run a sequence of <code>analysis engines</code> over a <code>JCas</code>. The result of
+ the analysis can be read from the JCas.
+ </p>
+ <p>
+ External resources can be shared between the analysis engines.
+ </p></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>jCas</code> - the jCas to process</dd>
+<dd><code>descs</code> - a sequence of analysis engines to run on the jCas</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.uima.resource.ResourceInitializationException</code> - if there is a problem initializing the components</dd>
+<dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code> - if there is a problem during the execution of the components</dd>
+</dl>
+</li>
+</ul>
+<a name="runPipeline-org.apache.uima.jcas.JCas-org.apache.uima.analysis_engine.AnalysisEngine...-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>runPipeline</h4>
+<pre>public static void runPipeline(org.apache.uima.jcas.JCas jCas,
+ org.apache.uima.analysis_engine.AnalysisEngine... engines)
+ throws org.apache.uima.analysis_engine.AnalysisEngineProcessException</pre>
+<div class="block"><p>
+ Run a sequence of <code>analysis engines</code> over a <code>JCas</code>. This method does
+ not <code>destroy</code> the engines or send them other events like
+ <code>AnalysisEngine.collectionProcessComplete()</code>. This is left to the caller.
+ </p>
+ <p>
+ External resources can only be shared between the analysis engines if the engines have been
+ previously instantiated using a shared resource manager.
+ </p></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>jCas</code> - the jCas to process</dd>
+<dd><code>engines</code> - a sequence of analysis engines to run on the jCas</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code> - if there is a problem during the execution of the components</dd>
+</dl>
+</li>
+</ul>
+<a name="runPipeline-org.apache.uima.cas.CAS-org.apache.uima.analysis_engine.AnalysisEngine...-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>runPipeline</h4>
+<pre>public static void runPipeline(org.apache.uima.cas.CAS cas,
+ org.apache.uima.analysis_engine.AnalysisEngine... engines)
+ throws org.apache.uima.analysis_engine.AnalysisEngineProcessException</pre>
+<div class="block"><p>
+ Run a sequence of <code>analysis engines</code> over a <code>CAS</code>. This method does
+ not <code>destroy</code> the engines or send them other events like
+ <code>AnalysisEngine.collectionProcessComplete()</code>. This is left to the caller.
+ </p>
+ <p>
+ External resources can only be shared between the analysis engines if the engines have been
+ previously instantiated using a shared resource manager.
+ </p></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>cas</code> - the CAS to process</dd>
+<dd><code>engines</code> - a sequence of analysis engines to run on the jCas</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.uima.analysis_engine.AnalysisEngineProcessException</code> - if there is a problem during the execution of the components</dd>
+</dl>
+</li>
+</ul>
+<a name="iteratePipeline-org.apache.uima.collection.CollectionReaderDescription-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>iteratePipeline</h4>
+<pre>public static <a href="../../../../../org/apache/uima/fit/pipeline/JCasIterable.html" title="class in org.apache.uima.fit.pipeline">JCasIterable</a> iteratePipeline(org.apache.uima.collection.CollectionReaderDescription aReader,
+ org.apache.uima.analysis_engine.AnalysisEngineDescription... aEngines)</pre>
+<div class="block"><p>
+ Iterate through the <code>JCases</code> processed by the pipeline, allowing to access each one
+ after it has been processed.
+ </p>
+ <p>
+ External resources can be shared between the reader and the analysis engines.
+ </p></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>aReader</code> - the collection reader.</dd>
+<dd><code>aEngines</code> - the analysis engines.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a><<code>JCas</code>> which can be used in an extended for-loop.</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/SimplePipeline.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/pipeline/JCasIterator.html" title="class in org.apache.uima.fit.pipeline"><span class="typeNameLink">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/uima/fit/pipeline/SimplePipeline.html" target="_top">Frames</a></li>
+<li><a href="SimplePipeline.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/pipeline/SimplePipeline.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/SimplePipeline.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/class-use/JCasIterable.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/class-use/JCasIterable.html?rev=1857643&view=auto
==============================================================================
--- uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/class-use/JCasIterable.html (added)
+++ uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/class-use/JCasIterable.html Tue Apr 16 11:40:19 2019
@@ -0,0 +1,172 @@
+<!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>Uses of Class org.apache.uima.fit.pipeline.JCasIterable (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="Uses of Class org.apache.uima.fit.pipeline.JCasIterable (Apache uimaFIT 3.0.0 User-Level API Documentation)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+</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><a href="../../../../../../org/apache/uima/fit/pipeline/JCasIterable.html" title="class in org.apache.uima.fit.pipeline">Class</a></li>
+<li class="navBarCell1Rev">Use</li>
+<li><a href="../../../../../../overview-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>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/uima/fit/pipeline/class-use/JCasIterable.html" target="_top">Frames</a></li>
+<li><a href="JCasIterable.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>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h2 title="Uses of Class org.apache.uima.fit.pipeline.JCasIterable" class="title">Uses of Class<br>org.apache.uima.fit.pipeline.JCasIterable</h2>
+</div>
+<div class="classUseContainer">
+<ul class="blockList">
+<li class="blockList">
+<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
+<caption><span>Packages that use <a href="../../../../../../org/apache/uima/fit/pipeline/JCasIterable.html" title="class in org.apache.uima.fit.pipeline">JCasIterable</a></span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Package</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="#org.apache.uima.fit.pipeline">org.apache.uima.fit.pipeline</a></td>
+<td class="colLast">
+<div class="block">Executing UIMA pipelines.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList">
+<ul class="blockList">
+<li class="blockList"><a name="org.apache.uima.fit.pipeline">
+<!-- -->
+</a>
+<h3>Uses of <a href="../../../../../../org/apache/uima/fit/pipeline/JCasIterable.html" title="class in org.apache.uima.fit.pipeline">JCasIterable</a> in <a href="../../../../../../org/apache/uima/fit/pipeline/package-summary.html">org.apache.uima.fit.pipeline</a></h3>
+<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
+<caption><span>Methods in <a href="../../../../../../org/apache/uima/fit/pipeline/package-summary.html">org.apache.uima.fit.pipeline</a> that return <a href="../../../../../../org/apache/uima/fit/pipeline/JCasIterable.html" title="class in org.apache.uima.fit.pipeline">JCasIterable</a></span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><code>static <a href="../../../../../../org/apache/uima/fit/pipeline/JCasIterable.html" title="class in org.apache.uima.fit.pipeline">JCasIterable</a></code></td>
+<td class="colLast"><span class="typeNameLabel">SimplePipeline.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/uima/fit/pipeline/SimplePipeline.html#iteratePipeline-org.apache.uima.collection.CollectionReaderDescription-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">iteratePipeline</a></span>(org.apache.uima.collection.CollectionReaderDescription aReader,
+ org.apache.uima.analysis_engine.AnalysisEngineDescription... aEngines)</code>
+<div class="block">
+ Iterate through the <code>JCases</code> processed by the pipeline, allowing to access each one
+ after it has been processed.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<!-- ======= 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><a href="../../../../../../org/apache/uima/fit/pipeline/JCasIterable.html" title="class in org.apache.uima.fit.pipeline">Class</a></li>
+<li class="navBarCell1Rev">Use</li>
+<li><a href="../../../../../../overview-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>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/uima/fit/pipeline/class-use/JCasIterable.html" target="_top">Frames</a></li>
+<li><a href="JCasIterable.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>
+<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/pipeline/class-use/JCasIterable.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/pipeline/class-use/JCasIterable.html
------------------------------------------------------------------------------
svn:mime-type = text/html