Added: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/util/JCasUtil.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/util/JCasUtil.html?rev=1857643&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/util/JCasUtil.html (added) +++ uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/util/JCasUtil.html Tue Apr 16 11:40:19 2019 @@ -0,0 +1,1398 @@ +<!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>JCasUtil (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="JCasUtil (Apache uimaFIT 3.0.0 User-Level API Documentation)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":41,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9,"i21":9,"i22":9,"i23":9,"i24":9,"i25":9,"i26":9,"i27":9,"i28":9,"i29":9,"i30":9,"i31":9,"i32":9,"i33":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/JCasUtil.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/util/FSUtil.html" title="class in org.apache.uima.fit.util"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/uima/fit/util/LifeCycleUtil.html" title="class in org.apache.uima.fit.util"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/uima/fit/util/JCasUtil.html" target="_top">Frames</a></li> +<li><a href="JCasUtil.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.util</div> +<h2 title="Class JCasUtil" class="title">Class JCasUtil</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.util.JCasUtil</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">JCasUtil</span> +extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Utility methods for convenient access to the <code>JCas</code>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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 boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#contains-org.apache.uima.jcas.JCas-org.apache.uima.cas.text.AnnotationFS-java.lang.Class-">contains</a></span>(org.apache.uima.jcas.JCas jCas, + org.apache.uima.cas.text.AnnotationFS coveringAnnotation, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.jcas.tcas.Annotation> type)</code> +<div class="block">Check if the given annotation contains any annotation of the given type.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.cas.TOP><br>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#exists-org.apache.uima.jcas.JCas-java.lang.Class-">exists</a></span>(org.apache.uima.jcas.JCas aJCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> aType)</code> +<div class="block">Test if a JCas contains an annotation of the given type.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.cas.Type</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#getAnnotationType-org.apache.uima.jcas.JCas-java.lang.Class-">getAnnotationType</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> type)</code> +<div class="block">Get the CAS type for the given JCas wrapper class type making sure it inherits from + <code>Annotation</code>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.cas.Type</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#getType-org.apache.uima.jcas.JCas-java.lang.Class-">getType</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> type)</code> +<div class="block">Get the CAS type for the given JCas wrapper class type.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static org.apache.uima.jcas.JCas</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#getView-org.apache.uima.jcas.JCas-java.lang.String-boolean-">getView</a></span>(org.apache.uima.jcas.JCas jcas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> viewName, + boolean create)</code> +<div class="block">Convenience method to get the specified view or create a new view if the requested view does + not exist.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static org.apache.uima.jcas.JCas</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#getView-org.apache.uima.jcas.JCas-java.lang.String-org.apache.uima.jcas.JCas-">getView</a></span>(org.apache.uima.jcas.JCas jcas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> viewName, + org.apache.uima.jcas.JCas fallback)</code> +<div class="block">Convenience method to get the specified view or a default view if the requested view does not + exist.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation,S extends org.apache.uima.jcas.tcas.Annotation><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><T,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><S>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#indexCovered-org.apache.uima.jcas.JCas-java.lang.Class-java.lang.Class-">indexCovered</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends T> type, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends S> coveredType)</code> +<div class="block">Create an index for quickly lookup up the annotations covered by a particular annotation.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation,S extends org.apache.uima.jcas.tcas.Annotation><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><T,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><S>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#indexCovering-org.apache.uima.jcas.JCas-java.lang.Class-java.lang.Class-">indexCovering</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends T> type, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends S> coveringType)</code> +<div class="block">Create an index for quickly lookup up the annotations covering a particular annotation.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.cas.text.AnnotationFS><br><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><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#iterator-org.apache.uima.cas.text.AnnotationFS-java.lang.Class-boolean-boolean-">iterator</a></span>(org.apache.uima.cas.text.AnnotationFS container, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + boolean ambiguous, + boolean strict)</code> +<div class="block">Convenience method to get a sub-iterator for the specified type.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.cas.TOP><br><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><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#iterator-org.apache.uima.jcas.JCas-java.lang.Class-">iterator</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Use <code>jcas.select(type).iterator()</code></span></div> +</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.cas.TOP><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#select-org.apache.uima.jcas.cas.FSArray-java.lang.Class-">select</a></span>(org.apache.uima.jcas.cas.FSArray array, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</code> +<div class="block">Convenience method select all feature structure from the given type from an array.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.cas.TOP><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#select-org.apache.uima.jcas.cas.FSList-java.lang.Class-">select</a></span>(org.apache.uima.jcas.cas.FSList list, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</code> +<div class="block">Convenience method select all feature structure from the given type from a list.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.cas.TOP><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#select-org.apache.uima.jcas.JCas-java.lang.Class-">select</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</code> +<div class="block">Convenience method to iterator over all features structures of a given type.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><org.apache.uima.jcas.cas.TOP></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectAll-org.apache.uima.jcas.JCas-">selectAll</a></span>(org.apache.uima.jcas.JCas jCas)</code> +<div class="block">Convenience method to iterator over all features structures.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectAt-org.apache.uima.jcas.JCas-java.lang.Class-int-int-">selectAt</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + int aBegin, + int aEnd)</code> +<div class="block">Get all annotations of the given type at the specified offsets.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectBetween-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-org.apache.uima.cas.text.AnnotationFS-">selectBetween</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + org.apache.uima.cas.text.AnnotationFS ann1, + org.apache.uima.cas.text.AnnotationFS ann2)</code> +<div class="block">Get a list of annotations of the given annotation type located between two annotations.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectBetween-org.apache.uima.jcas.JCas-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-org.apache.uima.cas.text.AnnotationFS-">selectBetween</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + org.apache.uima.cas.text.AnnotationFS ann1, + org.apache.uima.cas.text.AnnotationFS ann2)</code> +<div class="block">Get a list of annotations of the given annotation type located between two annotations.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br>T</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectByIndex-org.apache.uima.jcas.JCas-java.lang.Class-int-">selectByIndex</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> cls, + int index)</code> +<div class="block">This method exists simply as a convenience method for unit testing.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.cas.text.AnnotationFS><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectCovered-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-">selectCovered</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + org.apache.uima.cas.text.AnnotationFS coveringAnnotation)</code> +<div class="block">Get a list of annotations of the given annotation type constrained by a 'covering' annotation.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectCovered-org.apache.uima.jcas.JCas-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-">selectCovered</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + org.apache.uima.cas.text.AnnotationFS coveringAnnotation)</code> +<div class="block">Get a list of annotations of the given annotation type constrained by a 'covering' annotation.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectCovered-org.apache.uima.jcas.JCas-java.lang.Class-int-int-">selectCovered</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + int begin, + int end)</code> +<div class="block">Get a list of annotations of the given annotation type constrained by a 'covering' annotation.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectCovering-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-">selectCovering</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + org.apache.uima.cas.text.AnnotationFS coveredAnnotation)</code> +<div class="block">Get a list of annotations of the given annotation type constraint by a certain annotation.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectCovering-org.apache.uima.jcas.JCas-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-">selectCovering</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + org.apache.uima.cas.text.AnnotationFS coveredAnnotation)</code> +<div class="block">Get a list of annotations of the given annotation type constraint by a certain annotation.</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectCovering-org.apache.uima.jcas.JCas-java.lang.Class-int-int-">selectCovering</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + int begin, + int end)</code> +<div class="block">Get a list of annotations of the given annotation type constraint by a certain annotation.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectFollowing-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-int-">selectFollowing</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> aType, + org.apache.uima.cas.text.AnnotationFS annotation, + int count)</code> +<div class="block">Returns the n annotations following the given annotation</div> +</td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectFollowing-org.apache.uima.jcas.JCas-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-int-">selectFollowing</a></span>(org.apache.uima.jcas.JCas aJCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> aType, + org.apache.uima.cas.text.AnnotationFS annotation, + int count)</code> +<div class="block">Returns the n annotations following the given annotation</div> +</td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectPreceding-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-int-">selectPreceding</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> aType, + org.apache.uima.cas.text.AnnotationFS annotation, + int count)</code> +<div class="block">Returns the n annotations preceding the given annotation</div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectPreceding-org.apache.uima.jcas.JCas-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-int-">selectPreceding</a></span>(org.apache.uima.jcas.JCas aJCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> aType, + org.apache.uima.cas.text.AnnotationFS annotation, + int count)</code> +<div class="block">Returns the n annotations preceding the given annotation</div> +</td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.cas.TOP><br>T</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectSingle-org.apache.uima.jcas.JCas-java.lang.Class-">selectSingle</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</code> +<div class="block">Get the single instance of the specified type from the JCas.</div> +</td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br>T</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectSingleAt-org.apache.uima.jcas.JCas-java.lang.Class-int-int-">selectSingleAt</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + int aBegin, + int aEnd)</code> +<div class="block">Get a single annotations of the given type at the specified offsets.</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br>T</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectSingleRelative-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-int-">selectSingleRelative</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> aType, + org.apache.uima.cas.text.AnnotationFS annotation, + int index)</code> +<div class="block">Return an annotation preceding or following of a given reference annotation.</div> +</td> +</tr> +<tr id="i31" class="rowColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br>T</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectSingleRelative-org.apache.uima.jcas.JCas-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-int-">selectSingleRelative</a></span>(org.apache.uima.jcas.JCas aJCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> aType, + org.apache.uima.cas.text.AnnotationFS aAnchor, + int aPosition)</code> +<div class="block">Return an annotation preceding or following of a given reference annotation.</div> +</td> +</tr> +<tr id="i32" class="altColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.jcas.tcas.Annotation><br><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><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#subiterate-org.apache.uima.jcas.JCas-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-boolean-boolean-">subiterate</a></span>(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + org.apache.uima.cas.text.AnnotationFS container, + boolean ambiguous, + boolean strict)</code> +<div class="block">Convenience method to iterator over all annotations of a given type occurring within the scope + of a provided annotation (sub-iteration).</div> +</td> +</tr> +<tr id="i33" class="rowColor"> +<td class="colFirst"><code>static <T extends org.apache.uima.cas.text.AnnotationFS><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#toText-java.lang.Iterable-">toText</a></span>(<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><T> iterable)</code> +<div class="block">Fetch the text covered by the specified annotations and return it as a list of strings.</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="subiterate-org.apache.uima.jcas.JCas-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-boolean-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>subiterate</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> <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><T> subiterate(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + org.apache.uima.cas.text.AnnotationFS container, + boolean ambiguous, + boolean strict)</pre> +<div class="block">Convenience method to iterator over all annotations of a given type occurring within the scope + of a provided annotation (sub-iteration).</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the iteration type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - a JCas.</dd> +<dd><code>container</code> - the containing annotation.</dd> +<dd><code>type</code> - the type.</dd> +<dd><code>ambiguous</code> - If set to <code>false</code>, resulting iterator will be unambiguous.</dd> +<dd><code>strict</code> - Controls if annotations that overlap to the right are considered in or out.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A sub-iterator iterable.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>AnnotationIndex.subiterator(AnnotationFS, boolean, boolean)</code>, +<a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="iterator-org.apache.uima.jcas.JCas-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>iterator</h4> +<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public static <T extends org.apache.uima.jcas.cas.TOP> <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><T> iterator(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <code>jcas.select(type).iterator()</code></span></div> +<div class="block">Get an iterator over the given feature structure type.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - a JCas.</dd> +<dd><code>type</code> - a type.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a return value.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="iterator-org.apache.uima.cas.text.AnnotationFS-java.lang.Class-boolean-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>iterator</h4> +<pre>public static <T extends org.apache.uima.cas.text.AnnotationFS> <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><T> iterator(org.apache.uima.cas.text.AnnotationFS container, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + boolean ambiguous, + boolean strict)</pre> +<div class="block">Convenience method to get a sub-iterator for the specified type.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the iteration type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>container</code> - the containing annotation.</dd> +<dd><code>type</code> - the type.</dd> +<dd><code>ambiguous</code> - If set to <code>false</code>, resulting iterator will be unambiguous.</dd> +<dd><code>strict</code> - Controls if annotations that overlap to the right are considered in or out.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A sub-iterator.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="getType-org.apache.uima.jcas.JCas-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>public static org.apache.uima.cas.Type getType(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> type)</pre> +<div class="block">Get the CAS type for the given JCas wrapper class type.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - the JCas containing the type system.</dd> +<dd><code>type</code> - the JCas wrapper class type.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the CAS type.</dd> +</dl> +</li> +</ul> +<a name="getAnnotationType-org.apache.uima.jcas.JCas-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAnnotationType</h4> +<pre>public static org.apache.uima.cas.Type getAnnotationType(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> type)</pre> +<div class="block">Get the CAS type for the given JCas wrapper class type making sure it inherits from + <code>Annotation</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - the JCas containing the type system.</dd> +<dd><code>type</code> - the JCas wrapper class type.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the CAS type.</dd> +</dl> +</li> +</ul> +<a name="select-org.apache.uima.jcas.cas.FSArray-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>select</h4> +<pre>public static <T extends org.apache.uima.jcas.cas.TOP> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T> select(org.apache.uima.jcas.cas.FSArray array, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</pre> +<div class="block">Convenience method select all feature structure from the given type from an array.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>array</code> - a feature structure array.</dd> +<dd><code>type</code> - the type.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A collection of the selected type.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="select-org.apache.uima.jcas.cas.FSList-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>select</h4> +<pre>public static <T extends org.apache.uima.jcas.cas.TOP> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T> select(org.apache.uima.jcas.cas.FSList list, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</pre> +<div class="block">Convenience method select all feature structure from the given type from a list.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>list</code> - a feature structure list.</dd> +<dd><code>type</code> - the type.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A collection of the selected type.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="select-org.apache.uima.jcas.JCas-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>select</h4> +<pre>public static <T extends org.apache.uima.jcas.cas.TOP> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><T> select(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</pre> +<div class="block">Convenience method to iterator over all features structures of a given type.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the iteration type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - the JCas containing the type system.</dd> +<dd><code>type</code> - the type.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A collection of the selected type.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectAt-org.apache.uima.jcas.JCas-java.lang.Class-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectAt</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T> selectAt(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + int aBegin, + int aEnd)</pre> +<div class="block">Get all annotations of the given type at the specified offsets.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the type of annotations to fetch.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - the CAS containing the annotations.</dd> +<dd><code>type</code> - the type of annotations to fetch.</dd> +<dd><code>aBegin</code> - the begin offset.</dd> +<dd><code>aEnd</code> - the end offset.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the annotations at the specified offsets.</dd> +</dl> +</li> +</ul> +<a name="selectSingleAt-org.apache.uima.jcas.JCas-java.lang.Class-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectSingleAt</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> T selectSingleAt(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + int aBegin, + int aEnd)</pre> +<div class="block">Get a single annotations of the given type at the specified offsets.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the type of annotations to fetch.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - the CAS containing the annotations.</dd> +<dd><code>type</code> - the type of annotations to fetch.</dd> +<dd><code>aBegin</code> - the begin offset.</dd> +<dd><code>aEnd</code> - the end offset.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the annotation at the specified offsets.</dd> +</dl> +</li> +</ul> +<a name="selectAll-org.apache.uima.jcas.JCas-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectAll</h4> +<pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><org.apache.uima.jcas.cas.TOP> selectAll(org.apache.uima.jcas.JCas jCas)</pre> +<div class="block">Convenience method to iterator over all features structures.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - the JCas containing the type system. the type.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A collection of the selected type.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectBetween-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-org.apache.uima.cas.text.AnnotationFS-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectBetween</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T> selectBetween(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + org.apache.uima.cas.text.AnnotationFS ann1, + org.apache.uima.cas.text.AnnotationFS ann2)</pre> +<div class="block">Get a list of annotations of the given annotation type located between two annotations. Does + not use subiterators and does not respect type priorities. Zero-width annotations what lie on + the borders are included in the result, e.g. if the boundary annotations are [1..2] and [2..3] + then an annotation [2..2] is returned. If there is a non-zero overlap between the boundary + annotations, the result is empty. The method properly handles cases where the second boundary + annotations occurs before the first boundary annotation by switching their roles.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>type</code> - a UIMA type.</dd> +<dd><code>ann1</code> - the first boundary annotation.</dd> +<dd><code>ann2</code> - the second boundary annotation.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a return value.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>Subiterator</code>, +<a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectBetween-org.apache.uima.jcas.JCas-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-org.apache.uima.cas.text.AnnotationFS-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectBetween</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T> selectBetween(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + org.apache.uima.cas.text.AnnotationFS ann1, + org.apache.uima.cas.text.AnnotationFS ann2)</pre> +<div class="block">Get a list of annotations of the given annotation type located between two annotations. Does + not use subiterators and does not respect type priorities. Zero-width annotations what lie on + the borders are included in the result, e.g. if the boundary annotations are [1..2] and [2..3] + then an annotation [2..2] is returned. If there is a non-zero overlap between the boundary + annotations, the result is empty. The method properly handles cases where the second boundary + annotations occurs before the first boundary annotation by switching their roles.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - a JCas containing the annotation.</dd> +<dd><code>type</code> - a UIMA type.</dd> +<dd><code>ann1</code> - the first boundary annotation.</dd> +<dd><code>ann2</code> - the second boundary annotation.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a return value.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>Subiterator</code>, +<a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectCovered-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectCovered</h4> +<pre>public static <T extends org.apache.uima.cas.text.AnnotationFS> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T> selectCovered(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + org.apache.uima.cas.text.AnnotationFS coveringAnnotation)</pre> +<div class="block">Get a list of annotations of the given annotation type constrained by a 'covering' annotation. + Iterates over all annotations of the given type to find the covered annotations. Does not use + subiterators. + <p> + The covering annotation is never returned itself, even if it is of the queried-for type or a + subtype of that type. + <p> + The method only returns properly covered annotations, that is annotations where the begin/end + offsets are equal to the 'covering' annotation or where both the begin/end are included in + the span of the 'covering' annotation. Partially overlapping annotations are not returned.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>type</code> - a UIMA type.</dd> +<dd><code>coveringAnnotation</code> - the covering annotation.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a return value.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>Subiterator</code>, +<a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectCovered-org.apache.uima.jcas.JCas-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectCovered</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T> selectCovered(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + org.apache.uima.cas.text.AnnotationFS coveringAnnotation)</pre> +<div class="block">Get a list of annotations of the given annotation type constrained by a 'covering' annotation. + Iterates over all annotations of the given type to find the covered annotations. Does not use + subiterators. + <p> + The covering annotation is never returned itself, even if it is of the queried-for type or a + subtype of that type. + <p> + The method only returns properly covered annotations, that is annotations where the begin/end + offsets are equal to the 'covering' annotation or where both the begin/end are included in + the span of the 'covering' annotation. Partially overlapping annotations are not returned.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - a JCas containing the annotation.</dd> +<dd><code>type</code> - a UIMA type.</dd> +<dd><code>coveringAnnotation</code> - the covering annotation.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a return value.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>Subiterator</code>, +<a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectCovered-org.apache.uima.jcas.JCas-java.lang.Class-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectCovered</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T> selectCovered(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + int begin, + int end)</pre> +<div class="block">Get a list of annotations of the given annotation type constrained by a 'covering' annotation. + Iterates over all annotations of the given type to find the covered annotations. Does not use + subiterators. + <p> + <b>Note:</b> this is significantly slower than using + <a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectCovered-org.apache.uima.jcas.JCas-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-"><code>selectCovered(JCas, Class, AnnotationFS)</code></a>. It is possible to use + <code>selectCovered(jCas, cls, new Annotation(jCas, int, int))</code>, but that will allocate memory + in the jCas for the new annotation. If you do that repeatedly many times, memory may fill up. + <p> + The method only returns properly covered annotations, that is annotations where the begin/end + offsets are equal to the given begin/end or where both the begin/end are included in + the span of the given span. Partially overlapping annotations are not returned.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - a JCas containing the annotation.</dd> +<dd><code>type</code> - a UIMA type.</dd> +<dd><code>begin</code> - begin offset.</dd> +<dd><code>end</code> - end offset.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a return value.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectCovering-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectCovering</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T> selectCovering(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + org.apache.uima.cas.text.AnnotationFS coveredAnnotation)</pre> +<div class="block">Get a list of annotations of the given annotation type constraint by a certain annotation. + Iterates over all annotations to find the covering annotations. + <p> + The method only returns properly covering annotations, that is annotations where the begin/end + offsets are equal to the begin/end of the given annotation or where given 'covered' annotation + is properly contained within the span of the 'covering' annotation. Partially overlapping + annotations are not returned. + + <p> + <b>Note:</b> this is <b>REALLY SLOW!</b> You don't want to use this. Instead, consider using + <a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#indexCovering-org.apache.uima.jcas.JCas-java.lang.Class-java.lang.Class-"><code>indexCovering(JCas, Class, Class)</code></a> or a <a href="../../../../../org/apache/uima/fit/util/ContainmentIndex.html" title="class in org.apache.uima.fit.util"><code>ContainmentIndex</code></a>.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>type</code> - a UIMA type.</dd> +<dd><code>coveredAnnotation</code> - the covered annotation.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a return value.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectCovering-org.apache.uima.jcas.JCas-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectCovering</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T> selectCovering(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + org.apache.uima.cas.text.AnnotationFS coveredAnnotation)</pre> +<div class="block">Get a list of annotations of the given annotation type constraint by a certain annotation. + Iterates over all annotations to find the covering annotations. + <p> + The method only returns properly covering annotations, that is annotations where the begin/end + offsets are equal to the begin/end of the given annotation or where given 'covered' annotation + is properly contained within the span of the 'covering' annotation. Partially overlapping + annotations are not returned. + + <p> + <b>Note:</b> this is <b>REALLY SLOW!</b> You don't want to use this. Instead, consider using + <a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#indexCovering-org.apache.uima.jcas.JCas-java.lang.Class-java.lang.Class-"><code>indexCovering(JCas, Class, Class)</code></a> or a <a href="../../../../../org/apache/uima/fit/util/ContainmentIndex.html" title="class in org.apache.uima.fit.util"><code>ContainmentIndex</code></a>.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - a CAS.</dd> +<dd><code>type</code> - a UIMA type.</dd> +<dd><code>coveredAnnotation</code> - the covered annotation.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a return value.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectCovering-org.apache.uima.jcas.JCas-java.lang.Class-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectCovering</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T> selectCovering(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type, + int begin, + int end)</pre> +<div class="block">Get a list of annotations of the given annotation type constraint by a certain annotation. + Iterates over all annotations to find the covering annotations. + <p> + The method only returns properly covering annotations, that is annotations where the begin/end + offsets are equal to the given begin/end to or where given span is properly contained within + the span of the 'covering' annotation. Partially overlapping annotations are not returned. + + <p> + <b>Note:</b> this is <b>REALLY SLOW!</b> You don't want to use this. Instead, consider using + <a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#indexCovering-org.apache.uima.jcas.JCas-java.lang.Class-java.lang.Class-"><code>indexCovering(JCas, Class, Class)</code></a> or a <a href="../../../../../org/apache/uima/fit/util/ContainmentIndex.html" title="class in org.apache.uima.fit.util"><code>ContainmentIndex</code></a>.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - a CAS.</dd> +<dd><code>type</code> - a UIMA type.</dd> +<dd><code>begin</code> - begin offset.</dd> +<dd><code>end</code> - end offset.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a return value.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="indexCovering-org.apache.uima.jcas.JCas-java.lang.Class-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>indexCovering</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation,S extends org.apache.uima.jcas.tcas.Annotation> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><T,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><S>> indexCovering(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends T> type, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends S> coveringType)</pre> +<div class="block">Create an index for quickly lookup up the annotations covering a particular annotation. This is + preferable to using <a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectCovering-org.apache.uima.jcas.JCas-java.lang.Class-int-int-"><code>selectCovering(JCas, Class, int, int)</code></a> because the overhead of + scanning the CAS occurs only when the index is build. Subsequent lookups to the index are fast. + <p> + The method only returns properly covering annotations, that is annotations where the begin/end + offsets are equal to the begin/end of the given annotation or where given 'covered' annotation + is properly contained within the span of the 'covering' annotation. Partially overlapping + annotations are not returned.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the covered JCAs type.</dd> +<dd><code>S</code> - the covering JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - a JCas.</dd> +<dd><code>type</code> - type to create the index for - this is used in lookups.</dd> +<dd><code>coveringType</code> - type of covering annotations.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the index.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="indexCovered-org.apache.uima.jcas.JCas-java.lang.Class-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>indexCovered</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation,S extends org.apache.uima.jcas.tcas.Annotation> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><T,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><S>> indexCovered(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends T> type, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends S> coveredType)</pre> +<div class="block">Create an index for quickly lookup up the annotations covered by a particular annotation. This + is preferable to using <a href="../../../../../org/apache/uima/fit/util/JCasUtil.html#selectCovered-org.apache.uima.jcas.JCas-java.lang.Class-int-int-"><code>selectCovered(JCas, Class, int, int)</code></a> because the overhead of + scanning the CAS occurs only when the index is build. Subsequent lookups to the index are fast. + The order of entries in the map is not defined. However, lists of covered annotations in + the map are guaranteed to be in the same order as in the UIMA default annotation index. + <p> + The method only returns properly covered annotations, that is annotations where the begin/end + offsets are equal to the 'covering' annotation or where both the begin/end are included in + the span of the 'covering' annotation. Partially overlapping annotations are not returned.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the covering JCas type.</dd> +<dd><code>S</code> - the covered JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - a JCas.</dd> +<dd><code>type</code> - type to create the index for - this is used in lookups.</dd> +<dd><code>coveredType</code> - type of covered annotations.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the index.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="contains-org.apache.uima.jcas.JCas-org.apache.uima.cas.text.AnnotationFS-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contains</h4> +<pre>public static boolean contains(org.apache.uima.jcas.JCas jCas, + org.apache.uima.cas.text.AnnotationFS coveringAnnotation, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.uima.jcas.tcas.Annotation> type)</pre> +<div class="block">Check if the given annotation contains any annotation of the given type.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - a JCas containing the annotation.</dd> +<dd><code>coveringAnnotation</code> - the covering annotation.</dd> +<dd><code>type</code> - a UIMA type.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>if an annotation of the given type is present.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectByIndex-org.apache.uima.jcas.JCas-java.lang.Class-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectByIndex</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> T selectByIndex(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> cls, + int index)</pre> +<div class="block">This method exists simply as a convenience method for unit testing. It is not very efficient + and should not, in general be used outside the context of unit testing. + <p> + It is intentional that this method only allows annotation types. The CAS indexing mechanisms + are not well defined for non-annotation types. There are no reliably, built-in indexes for + non-annotation types.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - JCas wrapper type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - a JCas containing the annotation.</dd> +<dd><code>cls</code> - a UIMA type.</dd> +<dd><code>index</code> - this can be either positive (0 corresponds to the first annotation of a type) or + negative (-1 corresponds to the last annotation of a type.)</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an annotation of the given type</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectSingle-org.apache.uima.jcas.JCas-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectSingle</h4> +<pre>public static <T extends org.apache.uima.jcas.cas.TOP> T selectSingle(org.apache.uima.jcas.JCas jCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</pre> +<div class="block">Get the single instance of the specified type from the JCas.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - JCas wrapper type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jCas</code> - a JCas containing the annotation.</dd> +<dd><code>type</code> - a UIMA type.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the single instance of the given type. throws IllegalArgumentException if not exactly + one instance if the given type is present.</dd> +</dl> +</li> +</ul> +<a name="selectSingleRelative-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectSingleRelative</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> T selectSingleRelative(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> aType, + org.apache.uima.cas.text.AnnotationFS annotation, + int index)</pre> +<div class="block">Return an annotation preceding or following of a given reference annotation.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aType</code> - a type.</dd> +<dd><code>annotation</code> - anchor annotation</dd> +<dd><code>index</code> - relative position to access. A negative value selects a preceding annotation while a + positive number selects a following annotation.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the addressed annotation.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true"; title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - if the relative index points beyond the type index bounds.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectSingleRelative-org.apache.uima.jcas.JCas-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectSingleRelative</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> T selectSingleRelative(org.apache.uima.jcas.JCas aJCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> aType, + org.apache.uima.cas.text.AnnotationFS aAnchor, + int aPosition)</pre> +<div class="block">Return an annotation preceding or following of a given reference annotation. If the type + parameter corresponds to the type or a subtype of the anchor annotation and the relative + position is 0, then the anchor annotation is returned.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aJCas</code> - a JCas.</dd> +<dd><code>aType</code> - type of the annotation to be returned.</dd> +<dd><code>aAnchor</code> - anchor annotation</dd> +<dd><code>aPosition</code> - relative position to access. A negative value selects a preceding annotation while a + positive number selects a following annotation.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the addressed annotation.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true"; title="class or interface in java.lang">IndexOutOfBoundsException</a></code> - if the relative position points beyond the type index bounds.</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if the relative position is <code>0</code> and the anchor type does not subsume the + selected type.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectPreceding-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectPreceding</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T> selectPreceding(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> aType, + org.apache.uima.cas.text.AnnotationFS annotation, + int count)</pre> +<div class="block">Returns the n annotations preceding the given annotation</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aType</code> - a type.</dd> +<dd><code>annotation</code> - anchor annotation</dd> +<dd><code>count</code> - number of annotations to collect</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>List of aType annotations preceding anchor annotation</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectPreceding-org.apache.uima.jcas.JCas-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectPreceding</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T> selectPreceding(org.apache.uima.jcas.JCas aJCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> aType, + org.apache.uima.cas.text.AnnotationFS annotation, + int count)</pre> +<div class="block">Returns the n annotations preceding the given annotation</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aJCas</code> - a JCas.</dd> +<dd><code>aType</code> - a type.</dd> +<dd><code>annotation</code> - anchor annotation</dd> +<dd><code>count</code> - number of annotations to collect</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>List of aType annotations preceding anchor annotation</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectFollowing-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectFollowing</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T> selectFollowing(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> aType, + org.apache.uima.cas.text.AnnotationFS annotation, + int count)</pre> +<div class="block">Returns the n annotations following the given annotation</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - the JCas type.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>aType</code> - a type.</dd> +<dd><code>annotation</code> - anchor annotation</dd> +<dd><code>count</code> - number of annotations to collect</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>List of aType annotations following anchor annotation</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="package-summary.html#SortOrder">Order of selected feature structures</a></dd> +</dl> +</li> +</ul> +<a name="selectFollowing-org.apache.uima.jcas.JCas-java.lang.Class-org.apache.uima.cas.text.AnnotationFS-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectFollowing</h4> +<pre>public static <T extends org.apache.uima.jcas.tcas.Annotation> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><T> selectFollowing(org.apache.uima.jcas.JCas aJCas, + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> aType,
[... 175 lines stripped ...]
