blob: 7808c5e230e1a88effb7e69c206bb28607936d22 [file] [log] [blame]
<!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>AnnotationBaseFS (Apache UIMA Java SDK 3.1.1 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="AnnotationBaseFS (Apache UIMA Java SDK 3.1.1 User-Level API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/AnnotationBaseFS.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/cas/AbstractCas_ImplBase.html" title="class in org.apache.uima.cas"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/uima/cas/ArrayFS.html" title="interface in org.apache.uima.cas"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/uima/cas/AnnotationBaseFS.html" target="_top">Frames</a></li>
<li><a href="AnnotationBaseFS.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.cas</div>
<h2 title="Interface AnnotationBaseFS" class="title">Interface AnnotationBaseFS</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html" title="interface in org.apache.uima.cas">FeatureStructure</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/uima/cas/text/AnnotationFS.html" title="interface in org.apache.uima.cas.text">AnnotationFS</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/uima/jcas/tcas/Annotation.html" title="class in org.apache.uima.jcas.tcas">Annotation</a>, <a href="../../../../org/apache/uima/jcas/cas/AnnotationBase.html" title="class in org.apache.uima.jcas.cas">AnnotationBase</a>, <a href="../../../../org/apache/uima/jcas/tcas/DocumentAnnotation.html" title="class in org.apache.uima.jcas.tcas">DocumentAnnotation</a>, <a href="../../../../org/apache/uima/examples/SourceDocumentInformation.html" title="class in org.apache.uima.examples">SourceDocumentInformation</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">AnnotationBaseFS</span>
extends <a href="../../../../org/apache/uima/cas/FeatureStructure.html" title="interface in org.apache.uima.cas">FeatureStructure</a></pre>
<div class="block">Annotation Base API.
<p>
The <code>AnnotationBase</code> object holds one feature, the Sofa, which is a reference to the
SofaFS object associated with subtypes of this type.
<p>
It implements the methods to get the CAS view associated with this sofa.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/uima/cas/CAS.html" title="interface in org.apache.uima.cas">CAS</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/cas/AnnotationBaseFS.html#getView--">getView</a></span>()</code>
<div class="block">Gets the CAS view associated with the Sofa that this Annotation is over.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.uima.cas.FeatureStructure">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.uima.cas.<a href="../../../../org/apache/uima/cas/FeatureStructure.html" title="interface in org.apache.uima.cas">FeatureStructure</a></h3>
<code><a href="../../../../org/apache/uima/cas/FeatureStructure.html#Z:Z_getTypeCode--">_getTypeCode</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#Z:Z_id--">_id</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#clone--">clone</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#equals-java.lang.Object-">equals</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#getAddress--">getAddress</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#getBooleanValue-org.apache.uima.cas.Feature-">getBooleanValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#getByteValue-org.apache.uima.cas.Feature-">getByteValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#getCAS--">getCAS</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#getDoubleValue-org.apache.uima.cas.Feature-">getDoubleValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#getFeatureValue-org.apache.uima.cas.Feature-">getFeatureValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#getFeatureValueAsString-org.apache.uima.cas.Feature-">getFeatureValueAsString</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#getFloatValue-org.apache.uima.cas.Feature-">getFloatValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#getIntValue-org.apache.uima.cas.Feature-">getIntValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#getJCas--">getJCas</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#getLongValue-org.apache.uima.cas.Feature-">getLongValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#getShortValue-org.apache.uima.cas.Feature-">getShortValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#getStringValue-org.apache.uima.cas.Feature-">getStringValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#getType--">getType</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#hashCode--">hashCode</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#setBooleanValue-org.apache.uima.cas.Feature-boolean-">setBooleanValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#setByteValue-org.apache.uima.cas.Feature-byte-">setByteValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#setDoubleValue-org.apache.uima.cas.Feature-double-">setDoubleValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#setFeatureValue-org.apache.uima.cas.Feature-org.apache.uima.cas.FeatureStructure-">setFeatureValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#setFeatureValueFromString-org.apache.uima.cas.Feature-java.lang.String-">setFeatureValueFromString</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#setFloatValue-org.apache.uima.cas.Feature-float-">setFloatValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#setIntValue-org.apache.uima.cas.Feature-int-">setIntValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#setLongValue-org.apache.uima.cas.Feature-long-">setLongValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#setShortValue-org.apache.uima.cas.Feature-short-">setShortValue</a>, <a href="../../../../org/apache/uima/cas/FeatureStructure.html#setStringValue-org.apache.uima.cas.Feature-java.lang.String-">setStringValue</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="getView--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getView</h4>
<pre><a href="../../../../org/apache/uima/cas/CAS.html" title="interface in org.apache.uima.cas">CAS</a>&nbsp;getView()</pre>
<div class="block">Gets the CAS view associated with the Sofa that this Annotation is over.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the CAS view associated with the Annotation's Sofa</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/AnnotationBaseFS.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/cas/AbstractCas_ImplBase.html" title="class in org.apache.uima.cas"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/uima/cas/ArrayFS.html" title="interface in org.apache.uima.cas"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/uima/cas/AnnotationBaseFS.html" target="_top">Frames</a></li>
<li><a href="AnnotationBaseFS.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2006&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>