Added:
uima/site/trunk/uima-website/docs/d/uimafit-3.1.0/api/org/apache/uima/fit/pipeline/JCasIterator.html
URL:
http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-3.1.0/api/org/apache/uima/fit/pipeline/JCasIterator.html?rev=1877633&view=auto
==============================================================================
---
uima/site/trunk/uima-website/docs/d/uimafit-3.1.0/api/org/apache/uima/fit/pipeline/JCasIterator.html
(added)
+++
uima/site/trunk/uima-website/docs/d/uimafit-3.1.0/api/org/apache/uima/fit/pipeline/JCasIterator.html
Tue May 12 08:11:24 2020
@@ -0,0 +1,596 @@
+<!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.1.0 User-Level API Documentation)</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css"
title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="JCasIterator (Apache uimaFIT 3.1.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><<a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/jcas/JCas.html?is-external=true";
title="class or interface in org.apache.uima.jcas">JCas</a>></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><<a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/jcas/JCas.html?is-external=true";
title="class or interface in org.apache.uima.jcas">JCas</a>></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>(<a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/collection/CollectionReader.html?is-external=true";
title="class or interface in
org.apache.uima.collection">CollectionReader</a> aReader,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/analysis_engine/AnalysisEngine.html?is-external=true";
title="class or interface in
org.apache.uima.analysis_engine">AnalysisEngine</a>... 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.CollectionReaderDescription-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">JCasIterator</a></span>(<a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/collection/CollectionReaderDescription.html?is-external=true";
title="class or interface in
org.apache.uima.collection">CollectionReaderDescription</a> aReader,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/analysis_engine/AnalysisEngineDescription.html?is-external=true";
title="class or interface in
org.apache.uima.analysis_engine">AnalysisEngineDescription</a>... aEngines)</code>
+<div class="block">Iterate over the documents loaded by the given reader,
running the analysis engines on each
+ one before yielding them.</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.collection.CollectionReader-org.apache.uima.resource.metadata.TypeSystemDescription-">JCasIterator</a></span>(<a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/collection/CollectionReader.html?is-external=true";
title="class or interface in
org.apache.uima.collection">CollectionReader</a> aReader,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/metadata/TypeSystemDescription.html?is-external=true";
title="class or interface in
org.apache.uima.resource.metadata">TypeSystemDescription</a> aTypeSystemDescription)</code>
+<div class="block">Iterate over the documents loaded by the
CollectionReader.</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.resource.ResourceManager-org.apache.uima.collection.CollectionReader-org.apache.uima.analysis_engine.AnalysisEngine...-">JCasIterator</a></span>(<a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceManager.html?is-external=true";
title="class or interface in
org.apache.uima.resource">ResourceManager</a> aResMgr,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/collection/CollectionReader.html?is-external=true";
title="class or interface in
org.apache.uima.collection">CollectionReader</a> aReader,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/analysis_engine/AnalysisEngine.html?is-external=true";
title="class or interface in
org.apache.uima.analysis_engine">AnalysisEngine</a>... 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="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.CollectionReaderDescription-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">JCasIterator</a></span>(<a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceManager.html?is-external=true";
title="class or interface in
org.apache.uima.resource">ResourceManager</a> aResMgr,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/collection/CollectionReaderDescription.html?is-external=true";
title="class or interface in
org.apache.uima.collection">CollectionReaderDescription</a> aReader,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/analysis_engine/AnalysisEngineDescription.html?is-external=true";
title="class or interface in
org.apache.uima.analysis_engine">AnalysisEngineDescription</a>... aEngines)</code>
+<div class="block">Iterate over the documents loaded by the given reader,
running the analysis engines 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><a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/jcas/JCas.html?is-external=true";
title="class or interface in org.apache.uima.jcas">JCas</a></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.CollectionReaderDescription-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>JCasIterator</h4>
+<pre>public JCasIterator(<a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/collection/CollectionReaderDescription.html?is-external=true";
title="class or interface in
org.apache.uima.collection">CollectionReaderDescription</a> aReader,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/analysis_engine/AnalysisEngineDescription.html?is-external=true";
title="class or interface in
org.apache.uima.analysis_engine">AnalysisEngineDescription</a>... aEngines)
+ throws <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/cas/CASException.html?is-external=true";
title="class or interface in org.apache.uima.cas">CASException</a>,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceInitializationException.html?is-external=true";
title="class or interface in
org.apache.uima.resource">ResourceInitializationException</a></pre>
+<div class="block">Iterate over the documents loaded by the given reader,
running the analysis engines on each
+ one before yielding them. By default, components <b>DO get</b> life-cycle
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><a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceInitializationException.html?is-external=true";
title="class or interface in
org.apache.uima.resource">ResourceInitializationException</a></code> - if a
failure occurs during initialization of the components</dd>
+<dd><code><a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/cas/CASException.html?is-external=true";
title="class or interface in org.apache.uima.cas">CASException</a></code> - if
the JCas could not be initialized</dd>
+</dl>
+</li>
+</ul>
+<a
name="JCasIterator-org.apache.uima.resource.ResourceManager-org.apache.uima.collection.CollectionReaderDescription-org.apache.uima.analysis_engine.AnalysisEngineDescription...-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>JCasIterator</h4>
+<pre>public JCasIterator(<a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceManager.html?is-external=true";
title="class or interface in
org.apache.uima.resource">ResourceManager</a> aResMgr,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/collection/CollectionReaderDescription.html?is-external=true";
title="class or interface in
org.apache.uima.collection">CollectionReaderDescription</a> aReader,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/analysis_engine/AnalysisEngineDescription.html?is-external=true";
title="class or interface in
org.apache.uima.analysis_engine">AnalysisEngineDescription</a>... aEngines)
+ throws <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/cas/CASException.html?is-external=true";
title="class or interface in org.apache.uima.cas">CASException</a>,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceInitializationException.html?is-external=true";
title="class or interface in
org.apache.uima.resource">ResourceInitializationException</a></pre>
+<div class="block">Iterate over the documents loaded by the given reader,
running the analysis engines on each
+ one before yielding them. By default, components <b>DO get</b> life-cycle
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 <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceManager.html?is-external=true";
title="class or interface in
org.apache.uima.resource"><code>ResourceManager</code></a> used to create the
components and the JCas. If this
+ parameter is <code>null</code> then <a
href="../../../../../org/apache/uima/fit/internal/ResourceManagerFactory.html#newResourceManager--"><code>ResourceManagerFactory.newResourceManager()</code></a>
+ will be used to obtain a resource manager. If a new resource manager
was internally
+ created, it is destroyed at the end of the pipeline (if <a
href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#isSelfDestroy--"><code>isSelfDestroy()</code></a>).</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><a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceInitializationException.html?is-external=true";
title="class or interface in
org.apache.uima.resource">ResourceInitializationException</a></code> - if a
failure occurs during initialization of the components</dd>
+<dd><code><a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/cas/CASException.html?is-external=true";
title="class or interface in org.apache.uima.cas">CASException</a></code> - if
the JCas could not be initialized</dd>
+</dl>
+</li>
+</ul>
+<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(<a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/collection/CollectionReader.html?is-external=true";
title="class or interface in
org.apache.uima.collection">CollectionReader</a> aReader,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/analysis_engine/AnalysisEngine.html?is-external=true";
title="class or interface in
org.apache.uima.analysis_engine">AnalysisEngine</a>... aEngines)
+ throws <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/cas/CASException.html?is-external=true";
title="class or interface in org.apache.uima.cas">CASException</a>,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceInitializationException.html?is-external=true";
title="class or interface in
org.apache.uima.resource">ResourceInitializationException</a></pre>
+<div class="block">Iterate over the documents loaded by the CollectionReader,
running the AnalysisEngine on each
+ one before yielding them. By default, components <b>do NOT get</b> life-cycle
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><a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceInitializationException.html?is-external=true";
title="class or interface in
org.apache.uima.resource">ResourceInitializationException</a></code> - if a
failure occurs during initialization of the components</dd>
+<dd><code><a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/cas/CASException.html?is-external=true";
title="class or interface in org.apache.uima.cas">CASException</a></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="blockList">
+<li class="blockList">
+<h4>JCasIterator</h4>
+<pre>public JCasIterator(<a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/collection/CollectionReader.html?is-external=true";
title="class or interface in
org.apache.uima.collection">CollectionReader</a> aReader,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/metadata/TypeSystemDescription.html?is-external=true";
title="class or interface in
org.apache.uima.resource.metadata">TypeSystemDescription</a> aTypeSystemDescription)
+ throws <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/cas/CASException.html?is-external=true";
title="class or interface in org.apache.uima.cas">CASException</a>,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceInitializationException.html?is-external=true";
title="class or interface in
org.apache.uima.resource">ResourceInitializationException</a></pre>
+<div class="block">Iterate over the documents loaded by the CollectionReader.
(Uses an JCasAnnotatorAdapter to
+ create the document JCas.) By default, components <b>do NOT get</b>
life-cycle 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><a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceInitializationException.html?is-external=true";
title="class or interface in
org.apache.uima.resource">ResourceInitializationException</a></code> - if a
failure occurs during initialization of the components</dd>
+<dd><code><a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/cas/CASException.html?is-external=true";
title="class or interface in org.apache.uima.cas">CASException</a></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="blockListLast">
+<li class="blockList">
+<h4>JCasIterator</h4>
+<pre>public JCasIterator(<a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceManager.html?is-external=true";
title="class or interface in
org.apache.uima.resource">ResourceManager</a> aResMgr,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/collection/CollectionReader.html?is-external=true";
title="class or interface in
org.apache.uima.collection">CollectionReader</a> aReader,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/analysis_engine/AnalysisEngine.html?is-external=true";
title="class or interface in
org.apache.uima.analysis_engine">AnalysisEngine</a>... aEngines)
+ throws <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/cas/CASException.html?is-external=true";
title="class or interface in org.apache.uima.cas">CASException</a>,
+ <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceInitializationException.html?is-external=true";
title="class or interface in
org.apache.uima.resource">ResourceInitializationException</a></pre>
+<div class="block">Iterate over the documents loaded by the CollectionReader,
running the AnalysisEngine on each
+ one before yielding them. By default, components <b>do NOT get</b> life-cycle
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 <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceManager.html?is-external=true";
title="class or interface in
org.apache.uima.resource"><code>ResourceManager</code></a> used to create the
JCas. Should be the one also used by
+ the CollectionReader and the AnalysisEngines. If this parameter is
<code>null</code> then
+ <a
href="../../../../../org/apache/uima/fit/internal/ResourceManagerFactory.html#newResourceManager--"><code>ResourceManagerFactory.newResourceManager()</code></a>
will be used to obtain a resource
+ manager. If a new resource manager was internally created, it is
destroyed at the end
+ of the pipeline (if <a
href="../../../../../org/apache/uima/fit/pipeline/JCasIterator.html#isSelfDestroy--"><code>isSelfDestroy()</code></a>).</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><a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/ResourceInitializationException.html?is-external=true";
title="class or interface in
org.apache.uima.resource">ResourceInitializationException</a></code> - if a
failure occurs during initialization of the components</dd>
+<dd><code><a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/cas/CASException.html?is-external=true";
title="class or interface in org.apache.uima.cas">CASException</a></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><<a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/jcas/JCas.html?is-external=true";
title="class or interface in org.apache.uima.jcas">JCas</a>></code></dd>
+</dl>
+</li>
+</ul>
+<a name="next--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>next</h4>
+<pre>public <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/jcas/JCas.html?is-external=true";
title="class or interface in org.apache.uima.jcas">JCas</a> 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><<a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/jcas/JCas.html?is-external=true";
title="class or interface in org.apache.uima.jcas">JCas</a>></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><<a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/jcas/JCas.html?is-external=true";
title="class or interface in org.apache.uima.jcas">JCas</a>></code></dd>
+</dl>
+</li>
+</ul>
+<a name="collectionProcessComplete--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>collectionProcessComplete</h4>
+<pre>public void collectionProcessComplete()
+ throws <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/analysis_engine/AnalysisEngineProcessException.html?is-external=true";
title="class or interface in
org.apache.uima.analysis_engine">AnalysisEngineProcessException</a></pre>
+<div class="block">Notify analysis engines that the collection process is
complete.</div>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/analysis_engine/AnalysisEngineProcessException.html?is-external=true";
title="class or interface in
org.apache.uima.analysis_engine">AnalysisEngineProcessException</a></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 <a
href="http://uima.apache.org/d/uimaj-3.1.1/apidocs/org/apache/uima/resource/Resource.html?is-external=true#destroy--";
title="class or interface in
org.apache.uima.resource"><code>Resource.destroy()</code></a></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–2020 <a
href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights
reserved.</small></p>
+</body>
+</html>
Propchange:
uima/site/trunk/uima-website/docs/d/uimafit-3.1.0/api/org/apache/uima/fit/pipeline/JCasIterator.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
uima/site/trunk/uima-website/docs/d/uimafit-3.1.0/api/org/apache/uima/fit/pipeline/JCasIterator.html
------------------------------------------------------------------------------
svn:mime-type = text/html
