You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by re...@apache.org on 2014/06/13 01:26:36 UTC
svn commit: r1602312 [16/45] - in /uima/site/trunk/uima-website: docs/
docs/d/uimafit-2.1.0/ docs/d/uimafit-2.1.0/api/
docs/d/uimafit-2.1.0/api/org/apache/uima/fit/component/
docs/d/uimafit-2.1.0/api/org/apache/uima/fit/component/class-use/
docs/d/uima...
Modified: uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/FsIndexKey.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/FsIndexKey.html?rev=1602312&r1=1602311&r2=1602312&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/FsIndexKey.html (original)
+++ uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/FsIndexKey.html Thu Jun 12 23:26:32 2014
@@ -2,14 +2,20 @@
<!-- NewPage -->
<html lang="en">
<head>
-<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
-<title>FsIndexKey (Apache uimaFIT 2.0.0 User-Level API Documentation)</title>
+<!-- Generated by javadoc -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>FsIndexKey (Apache uimaFIT 2.1.0 User-Level API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="FsIndexKey (Apache uimaFIT 2.0.0 User-Level API Documentation)";
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="FsIndexKey (Apache uimaFIT 2.1.0 User-Level API Documentation)";
+ }
+ }
+ catch(err) {
}
//-->
</script>
@@ -17,9 +23,11 @@
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
-<div class="topNav"><a name="navbar_top">
+<div class="topNav"><a name="navbar.top">
<!-- -->
-</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
+</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">
@@ -35,15 +43,15 @@
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexCollection.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexCollection.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/uima/fit/descriptor/FsIndexKey.html" target="_top">Frames</a></li>
-<li><a href="FsIndexKey.html" target="_top">No Frames</a></li>
+<li><a href="FsIndexKey.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>
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -60,15 +68,17 @@
<div>
<ul class="subNavList">
<li>Summary: </li>
-<li><a href="#annotation_type_required_element_summary">Required</a> | </li>
-<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+<li><a href="#annotation.type.field.summary">Field</a> | </li>
+<li><a href="#annotation.type.required.element.summary">Required</a> | </li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#annotation_type_element_detail">Element</a></li>
+<li><a href="#annotation.type.field.detail">Field</a> | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
-<a name="skip-navbar_top">
+<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
@@ -83,24 +93,50 @@
<li class="blockList">
<hr>
<br>
-<pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
-<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>)
-public @interface <span class="strong">FsIndexKey</span></pre>
-<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://uima.apache.org/d/uimaj-2.4.2/apidocs/org/apache/uima/resource/metadata/FsIndexKeyDescription.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata"><code>FsIndexKeyDescription</code></a>,
-<a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html" title="class in org.apache.uima.fit.factory"><code>FsIndexFactory</code></a></dd></dl>
+<pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
+ <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>)
+public @interface <span class="memberNameLabel">FsIndexKey</span></pre>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><code>FsIndexKeyDescription</code>,
+<a href="../../../../../org/apache/uima/fit/factory/FsIndexFactory.html" title="class in org.apache.uima.fit.factory"><code>FsIndexFactory</code></a></dd>
+</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
+<!-- =========== ANNOTATION TYPE FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation.type.field.summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Fields and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexKey.html#REVERSE_STANDARD_COMPARE">REVERSE_STANDARD_COMPARE</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexKey.html#STANDARD_COMPARE">STANDARD_COMPARE</a></span></code> </td>
+</tr>
+</table>
+</li>
+</ul>
<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
<ul class="blockList">
-<li class="blockList"><a name="annotation_type_required_element_summary">
+<li class="blockList"><a name="annotation.type.required.element.summary">
<!-- -->
</a>
<h3>Required Element Summary</h3>
-<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
<caption><span>Required Elements</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
@@ -108,18 +144,18 @@ public @interface <span class="strong">F
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexKey.html#featureName()">featureName</a></strong></code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexKey.html#featureName--">featureName</a></span></code> </td>
</tr>
</table>
</li>
</ul>
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
-<li class="blockList"><a name="annotation_type_optional_element_summary">
+<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
-<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
@@ -127,7 +163,7 @@ public @interface <span class="strong">F
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexKey.html#comparator()">comparator</a></strong></code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexKey.html#comparator--">comparator</a></span></code> </td>
</tr>
</table>
</li>
@@ -138,30 +174,81 @@ public @interface <span class="strong">F
<div class="details">
<ul class="blockList">
<li class="blockList">
+<!-- ============ ANNOTATION TYPE FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation.type.field.detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="STANDARD_COMPARE">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>STANDARD_COMPARE</h4>
+<pre>public static final int STANDARD_COMPARE</pre>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><code>FsIndexKeyDescription.STANDARD_COMPARE</code></dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="REVERSE_STANDARD_COMPARE">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>REVERSE_STANDARD_COMPARE</h4>
+<pre>public static final int REVERSE_STANDARD_COMPARE</pre>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><code>FsIndexKeyDescription.REVERSE_STANDARD_COMPARE</code></dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
-<li class="blockList"><a name="annotation_type_element_detail">
+<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
-<a name="featureName()">
+<a name="featureName--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>featureName</h4>
<pre>public abstract <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> featureName</pre>
-<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://uima.apache.org/d/uimaj-2.4.2/apidocs/org/apache/uima/resource/metadata/FsIndexKeyDescription.html?is-external=true#getFeatureName()" title="class or interface in org.apache.uima.resource.metadata"><code>FsIndexKeyDescription.getFeatureName()</code></a></dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the name of this key's Feature</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><code>FsIndexKeyDescription.getFeatureName()</code></dd>
+</dl>
+</li>
+</ul>
</li>
</ul>
-<a name="comparator()">
+<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="comparator--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>comparator</h4>
<pre>public abstract int comparator</pre>
-<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://uima.apache.org/d/uimaj-2.4.2/apidocs/org/apache/uima/resource/metadata/FsIndexKeyDescription.html?is-external=true#getComparator()" title="class or interface in org.apache.uima.resource.metadata"><code>FsIndexKeyDescription.getComparator()</code></a></dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>this key's comparator</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><code>FsIndexKeyDescription.getComparator()</code></dd>
+</dl>
<dl>
<dt>Default:</dt>
<dd>0</dd>
@@ -176,9 +263,11 @@ public @interface <span class="strong">F
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<div class="bottomNav"><a name="navbar_bottom">
+<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
-</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
+</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">
@@ -194,15 +283,15 @@ public @interface <span class="strong">F
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexCollection.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexCollection.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/uima/fit/descriptor/FsIndexKey.html" target="_top">Frames</a></li>
-<li><a href="FsIndexKey.html" target="_top">No Frames</a></li>
+<li><a href="FsIndexKey.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
-<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -219,18 +308,20 @@ public @interface <span class="strong">F
<div>
<ul class="subNavList">
<li>Summary: </li>
-<li><a href="#annotation_type_required_element_summary">Required</a> | </li>
-<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+<li><a href="#annotation.type.field.summary">Field</a> | </li>
+<li><a href="#annotation.type.required.element.summary">Required</a> | </li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#annotation_type_element_detail">Element</a></li>
+<li><a href="#annotation.type.field.detail">Field</a> | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
-<a name="skip-navbar_bottom">
+<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-<p class="legalCopy"><small>Copyright © 2012–2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
+<p class="legalCopy"><small>Copyright © 2012–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
Modified: uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/OperationalProperties.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/OperationalProperties.html?rev=1602312&r1=1602311&r2=1602312&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/OperationalProperties.html (original)
+++ uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/OperationalProperties.html Thu Jun 12 23:26:32 2014
@@ -2,14 +2,20 @@
<!-- NewPage -->
<html lang="en">
<head>
-<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
-<title>OperationalProperties (Apache uimaFIT 2.0.0 User-Level API Documentation)</title>
+<!-- Generated by javadoc -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>OperationalProperties (Apache uimaFIT 2.1.0 User-Level API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="OperationalProperties (Apache uimaFIT 2.0.0 User-Level API Documentation)";
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="OperationalProperties (Apache uimaFIT 2.1.0 User-Level API Documentation)";
+ }
+ }
+ catch(err) {
}
//-->
</script>
@@ -17,9 +23,11 @@
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
-<div class="topNav"><a name="navbar_top">
+<div class="topNav"><a name="navbar.top">
<!-- -->
-</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
+</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">
@@ -35,15 +43,15 @@
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexKey.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexKey.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/uima/fit/descriptor/OperationalProperties.html" target="_top">Frames</a></li>
-<li><a href="OperationalProperties.html" target="_top">No Frames</a></li>
+<li><a href="OperationalProperties.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>
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -60,15 +68,17 @@
<div>
<ul class="subNavList">
<li>Summary: </li>
+<li><a href="#annotation.type.field.summary">Field</a> | </li>
<li>Required | </li>
-<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#annotation_type_element_detail">Element</a></li>
+<li><a href="#annotation.type.field.detail">Field</a> | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
-<a name="skip-navbar_top">
+<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
@@ -83,23 +93,56 @@
<li class="blockList">
<hr>
<br>
-<pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
-<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>)
-public @interface <span class="strong">OperationalProperties</span></pre>
-<div class="block">Control aspects of the UIMA analysis component.<br/></div>
+<pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
+ <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>)
+public @interface <span class="memberNameLabel">OperationalProperties</span></pre>
+<div class="block">Control aspects of the UIMA analysis component.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
+<!-- =========== ANNOTATION TYPE FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation.type.field.summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Fields and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html#MODIFIES_CAS_DEFAULT">MODIFIES_CAS_DEFAULT</a></span></code>
+<div class="block">the default value for modifiesCas if none is given</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html#MULTIPLE_DEPLOYMENT_ALLOWED_DEFAULT">MULTIPLE_DEPLOYMENT_ALLOWED_DEFAULT</a></span></code>
+<div class="block">the default value for multipleDeploymentAllowed if none is given.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html#OUTPUTS_NEW_CASES_DEFAULT">OUTPUTS_NEW_CASES_DEFAULT</a></span></code>
+<div class="block">the default value for outputsNewCases if none is given</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
-<li class="blockList"><a name="annotation_type_optional_element_summary">
+<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
-<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
@@ -107,20 +150,20 @@ public @interface <span class="strong">O
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html#modifiesCas()">modifiesCas</a></strong></code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html#modifiesCas--">modifiesCas</a></span></code>
<div class="block">Gets whether this component will modify the CAS.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html#multipleDeploymentAllowed()">multipleDeploymentAllowed</a></strong></code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html#multipleDeploymentAllowed--">multipleDeploymentAllowed</a></span></code>
<div class="block">Gets whether multiple instances of this component can be run in parallel, each receiving a
subset of the documents from a collection.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html#outputsNewCases()">outputsNewCases</a></strong></code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html#outputsNewCases--">outputsNewCases</a></span></code>
<div class="block">Gets whether this AnalysisEngine may output new CASes.</div>
</td>
</tr>
@@ -133,13 +176,57 @@ public @interface <span class="strong">O
<div class="details">
<ul class="blockList">
<li class="blockList">
+<!-- ============ ANNOTATION TYPE FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation.type.field.detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="MULTIPLE_DEPLOYMENT_ALLOWED_DEFAULT">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>MULTIPLE_DEPLOYMENT_ALLOWED_DEFAULT</h4>
+<pre>public static final boolean MULTIPLE_DEPLOYMENT_ALLOWED_DEFAULT</pre>
+<div class="block">the default value for multipleDeploymentAllowed if none is given.</div>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="MODIFIES_CAS_DEFAULT">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>MODIFIES_CAS_DEFAULT</h4>
+<pre>public static final boolean MODIFIES_CAS_DEFAULT</pre>
+<div class="block">the default value for modifiesCas if none is given</div>
+</li>
+</ul>
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="OUTPUTS_NEW_CASES_DEFAULT">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>OUTPUTS_NEW_CASES_DEFAULT</h4>
+<pre>public static final boolean OUTPUTS_NEW_CASES_DEFAULT</pre>
+<div class="block">the default value for outputsNewCases if none is given</div>
+</li>
+</ul>
+</li>
+</ul>
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
-<li class="blockList"><a name="annotation_type_element_detail">
+<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
-<a name="multipleDeploymentAllowed()">
+<a name="multipleDeploymentAllowed--">
<!-- -->
</a>
<ul class="blockList">
@@ -148,14 +235,22 @@ public @interface <span class="strong">O
<pre>public abstract boolean multipleDeploymentAllowed</pre>
<div class="block">Gets whether multiple instances of this component can be run in parallel, each receiving a
subset of the documents from a collection.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>true if multiple instances can be run in parallel, false if not</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://uima.apache.org/d/uimaj-2.4.2/apidocs/org/apache/uima/resource/metadata/OperationalProperties.html?is-external=true#isMultipleDeploymentAllowed()" title="class or interface in org.apache.uima.resource.metadata"><code>OperationalProperties.isMultipleDeploymentAllowed()</code></a></dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if multiple instances can be run in parallel, false if not</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><code>OperationalProperties.isMultipleDeploymentAllowed()</code></dd>
+</dl>
<dl>
<dt>Default:</dt>
<dd>true</dd>
</dl>
</li>
</ul>
-<a name="modifiesCas()">
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="modifiesCas--">
<!-- -->
</a>
<ul class="blockList">
@@ -163,14 +258,22 @@ public @interface <span class="strong">O
<h4>modifiesCas</h4>
<pre>public abstract boolean modifiesCas</pre>
<div class="block">Gets whether this component will modify the CAS.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>true if this component modifies the CAS, false if it does not.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://uima.apache.org/d/uimaj-2.4.2/apidocs/org/apache/uima/resource/metadata/OperationalProperties.html?is-external=true#getModifiesCas()" title="class or interface in org.apache.uima.resource.metadata"><code>OperationalProperties.getModifiesCas()</code></a></dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if this component modifies the CAS, false if it does not.</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><code>OperationalProperties.getModifiesCas()</code></dd>
+</dl>
<dl>
<dt>Default:</dt>
<dd>true</dd>
</dl>
</li>
</ul>
-<a name="outputsNewCases()">
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="outputsNewCases--">
<!-- -->
</a>
<ul class="blockListLast">
@@ -179,11 +282,16 @@ public @interface <span class="strong">O
<pre>public abstract boolean outputsNewCases</pre>
<div class="block">Gets whether this AnalysisEngine may output new CASes. If this property is set to true, an
application can use the
- <a href="http://uima.apache.org/d/uimaj-2.4.2/apidocs/org/apache/uima/analysis_engine/AnalysisEngine.html?is-external=true#processAndOutputNewCASes(org.apache.uima.cas.CAS)" title="class or interface in org.apache.uima.analysis_engine"><code>AnalysisEngine.processAndOutputNewCASes(org.apache.uima.cas.CAS)</code></a> to pass a CAS to this
+ <code>AnalysisEngine.processAndOutputNewCASes(org.apache.uima.cas.CAS)</code> to pass a CAS to this
this AnalysisEngine and then step through all of the output CASes that it produces. For
example, such an AnalysisEngine could segment a CAS into smaller pieces, emitting each as a
separate CAS.</div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>true if this component may output new CASes, false if it does not</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://uima.apache.org/d/uimaj-2.4.2/apidocs/org/apache/uima/resource/metadata/OperationalProperties.html?is-external=true#getOutputsNewCASes()" title="class or interface in org.apache.uima.resource.metadata"><code>OperationalProperties.getOutputsNewCASes()</code></a></dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if this component may output new CASes, false if it does not</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><code>OperationalProperties.getOutputsNewCASes()</code></dd>
+</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
@@ -198,9 +306,11 @@ public @interface <span class="strong">O
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<div class="bottomNav"><a name="navbar_bottom">
+<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
-</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
+</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">
@@ -216,15 +326,15 @@ public @interface <span class="strong">O
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexKey.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexKey.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/uima/fit/descriptor/OperationalProperties.html" target="_top">Frames</a></li>
-<li><a href="OperationalProperties.html" target="_top">No Frames</a></li>
+<li><a href="OperationalProperties.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
-<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -241,18 +351,20 @@ public @interface <span class="strong">O
<div>
<ul class="subNavList">
<li>Summary: </li>
+<li><a href="#annotation.type.field.summary">Field</a> | </li>
<li>Required | </li>
-<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#annotation_type_element_detail">Element</a></li>
+<li><a href="#annotation.type.field.detail">Field</a> | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
-<a name="skip-navbar_bottom">
+<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-<p class="legalCopy"><small>Copyright © 2012–2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
+<p class="legalCopy"><small>Copyright © 2012–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
Modified: uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/ResourceMetaData.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/ResourceMetaData.html?rev=1602312&r1=1602311&r2=1602312&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/ResourceMetaData.html (original)
+++ uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/ResourceMetaData.html Thu Jun 12 23:26:32 2014
@@ -2,14 +2,20 @@
<!-- NewPage -->
<html lang="en">
<head>
-<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
-<title>ResourceMetaData (Apache uimaFIT 2.0.0 User-Level API Documentation)</title>
+<!-- Generated by javadoc -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>ResourceMetaData (Apache uimaFIT 2.1.0 User-Level API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="ResourceMetaData (Apache uimaFIT 2.0.0 User-Level API Documentation)";
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="ResourceMetaData (Apache uimaFIT 2.1.0 User-Level API Documentation)";
+ }
+ }
+ catch(err) {
}
//-->
</script>
@@ -17,9 +23,11 @@
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
-<div class="topNav"><a name="navbar_top">
+<div class="topNav"><a name="navbar.top">
<!-- -->
-</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
+</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">
@@ -35,15 +43,15 @@
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/uima/fit/descriptor/SofaCapability.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/SofaCapability.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/uima/fit/descriptor/ResourceMetaData.html" target="_top">Frames</a></li>
-<li><a href="ResourceMetaData.html" target="_top">No Frames</a></li>
+<li><a href="ResourceMetaData.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>
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -60,15 +68,17 @@
<div>
<ul class="subNavList">
<li>Summary: </li>
+<li>Field | </li>
<li>Required | </li>
-<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#annotation_type_element_detail">Element</a></li>
+<li>Field | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
-<a name="skip-navbar_top">
+<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
@@ -83,11 +93,14 @@
<li class="blockList">
<hr>
<br>
-<pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
-<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>)
-public @interface <span class="strong">ResourceMetaData</span></pre>
+<pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
+ <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>)
+public @interface <span class="memberNameLabel">ResourceMetaData</span></pre>
<div class="block">This can be used to add component-level meta data such as version, vendor, etc.</div>
-<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://uima.apache.org/d/uimaj-2.4.2/apidocs/org/apache/uima/resource/metadata/ResourceMetaData.html?is-external=true" title="class or interface in org.apache.uima.resource.metadata"><code>ResourceMetaData</code></a></dd></dl>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><code>ResourceMetaData</code></dd>
+</dl>
</li>
</ul>
</div>
@@ -96,11 +109,11 @@ public @interface <span class="strong">R
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
-<li class="blockList"><a name="annotation_type_optional_element_summary">
+<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
-<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
@@ -108,31 +121,31 @@ public @interface <span class="strong">R
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html#copyright()">copyright</a></strong></code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html#copyright--">copyright</a></span></code>
<div class="block">Gets the copyright notice for this Resource.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html#description()">description</a></strong></code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html#description--">description</a></span></code>
<div class="block">Gets the description of this Resource.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html#name()">name</a></strong></code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html#name--">name</a></span></code>
<div class="block">Gets the name of this Resource.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html#vendor()">vendor</a></strong></code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html#vendor--">vendor</a></span></code>
<div class="block">Gets the vendor of this Resource.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html#version()">version</a></strong></code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html#version--">version</a></span></code>
<div class="block">Gets the version number of this Resource.</div>
</td>
</tr>
@@ -147,11 +160,11 @@ public @interface <span class="strong">R
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
-<li class="blockList"><a name="annotation_type_element_detail">
+<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
-<a name="name()">
+<a name="name--">
<!-- -->
</a>
<ul class="blockList">
@@ -159,14 +172,22 @@ public @interface <span class="strong">R
<h4>name</h4>
<pre>public abstract <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name</pre>
<div class="block">Gets the name of this Resource.</div>
-<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://uima.apache.org/d/uimaj-2.4.2/apidocs/org/apache/uima/resource/metadata/ResourceMetaData.html?is-external=true#getName()" title="class or interface in org.apache.uima.resource.metadata"><code>ResourceMetaData.getName()</code></a></dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the name of this Resource</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><code>ResourceMetaData.getName()</code></dd>
+</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
-<a name="copyright()">
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="copyright--">
<!-- -->
</a>
<ul class="blockList">
@@ -174,14 +195,22 @@ public @interface <span class="strong">R
<h4>copyright</h4>
<pre>public abstract <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> copyright</pre>
<div class="block">Gets the copyright notice for this Resource.</div>
-<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://uima.apache.org/d/uimaj-2.4.2/apidocs/org/apache/uima/resource/metadata/ResourceMetaData.html?is-external=true#getCopyright()" title="class or interface in org.apache.uima.resource.metadata"><code>ResourceMetaData.getCopyright()</code></a></dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the copyright notice for this Resource</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><code>ResourceMetaData.getCopyright()</code></dd>
+</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
-<a name="description()">
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="description--">
<!-- -->
</a>
<ul class="blockList">
@@ -189,14 +218,22 @@ public @interface <span class="strong">R
<h4>description</h4>
<pre>public abstract <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> description</pre>
<div class="block">Gets the description of this Resource.</div>
-<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://uima.apache.org/d/uimaj-2.4.2/apidocs/org/apache/uima/resource/metadata/ResourceMetaData.html?is-external=true#getDescription()" title="class or interface in org.apache.uima.resource.metadata"><code>ResourceMetaData.getDescription()</code></a></dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the description of this Resource</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><code>ResourceMetaData.getDescription()</code></dd>
+</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
-<a name="vendor()">
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="vendor--">
<!-- -->
</a>
<ul class="blockList">
@@ -204,14 +241,22 @@ public @interface <span class="strong">R
<h4>vendor</h4>
<pre>public abstract <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> vendor</pre>
<div class="block">Gets the vendor of this Resource.</div>
-<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://uima.apache.org/d/uimaj-2.4.2/apidocs/org/apache/uima/resource/metadata/ResourceMetaData.html?is-external=true#getVendor()" title="class or interface in org.apache.uima.resource.metadata"><code>ResourceMetaData.getVendor()</code></a></dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the vendor of this Resource, as a String</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><code>ResourceMetaData.getVendor()</code></dd>
+</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
-<a name="version()">
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="version--">
<!-- -->
</a>
<ul class="blockListLast">
@@ -219,7 +264,12 @@ public @interface <span class="strong">R
<h4>version</h4>
<pre>public abstract <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> version</pre>
<div class="block">Gets the version number of this Resource.</div>
-<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://uima.apache.org/d/uimaj-2.4.2/apidocs/org/apache/uima/resource/metadata/ResourceMetaData.html?is-external=true#getVersion()" title="class or interface in org.apache.uima.resource.metadata"><code>ResourceMetaData.getVersion()</code></a></dd></dl>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the version number of this Resource, as a String</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><code>ResourceMetaData.getVersion()</code></dd>
+</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
@@ -234,9 +284,11 @@ public @interface <span class="strong">R
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<div class="bottomNav"><a name="navbar_bottom">
+<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
-</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
+</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">
@@ -252,15 +304,15 @@ public @interface <span class="strong">R
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/uima/fit/descriptor/SofaCapability.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/OperationalProperties.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/SofaCapability.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/uima/fit/descriptor/ResourceMetaData.html" target="_top">Frames</a></li>
-<li><a href="ResourceMetaData.html" target="_top">No Frames</a></li>
+<li><a href="ResourceMetaData.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
-<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -277,18 +329,20 @@ public @interface <span class="strong">R
<div>
<ul class="subNavList">
<li>Summary: </li>
+<li>Field | </li>
<li>Required | </li>
-<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#annotation_type_element_detail">Element</a></li>
+<li>Field | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
-<a name="skip-navbar_bottom">
+<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-<p class="legalCopy"><small>Copyright © 2012–2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
+<p class="legalCopy"><small>Copyright © 2012–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
Modified: uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/SofaCapability.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/SofaCapability.html?rev=1602312&r1=1602311&r2=1602312&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/SofaCapability.html (original)
+++ uima/site/trunk/uima-website/docs/d/uimafit-2.1.0/api/org/apache/uima/fit/descriptor/SofaCapability.html Thu Jun 12 23:26:32 2014
@@ -2,14 +2,20 @@
<!-- NewPage -->
<html lang="en">
<head>
-<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
-<title>SofaCapability (Apache uimaFIT 2.0.0 User-Level API Documentation)</title>
+<!-- Generated by javadoc -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>SofaCapability (Apache uimaFIT 2.1.0 User-Level API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="SofaCapability (Apache uimaFIT 2.0.0 User-Level API Documentation)";
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="SofaCapability (Apache uimaFIT 2.1.0 User-Level API Documentation)";
+ }
+ }
+ catch(err) {
}
//-->
</script>
@@ -17,9 +23,11 @@
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
-<div class="topNav"><a name="navbar_top">
+<div class="topNav"><a name="navbar.top">
<!-- -->
-</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
+</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">
@@ -35,15 +43,15 @@
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/uima/fit/descriptor/TypeCapability.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/TypeCapability.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/uima/fit/descriptor/SofaCapability.html" target="_top">Frames</a></li>
-<li><a href="SofaCapability.html" target="_top">No Frames</a></li>
+<li><a href="SofaCapability.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>
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -60,15 +68,17 @@
<div>
<ul class="subNavList">
<li>Summary: </li>
+<li><a href="#annotation.type.field.summary">Field</a> | </li>
<li>Required | </li>
-<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#annotation_type_element_detail">Element</a></li>
+<li><a href="#annotation.type.field.detail">Field</a> | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
-<a name="skip-navbar_top">
+<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
@@ -83,16 +93,16 @@
<li class="blockList">
<hr>
<br>
-<pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
-<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>)
-public @interface <span class="strong">SofaCapability</span></pre>
-<div class="block"><code><pre>
- @SofaCapability(inputSofas = { GOLD_VIEW, SYSTEM_VIEW })
- </pre></code>
+<pre><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
+ <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>)
+public @interface <span class="memberNameLabel">SofaCapability</span></pre>
+<div class="block"><pre><code>
+ @SofaCapability(inputSofas = { GOLD_VIEW, SYSTEM_VIEW })
+ </code></pre>
or
- <code><pre>
- @SofaCapability(inputSofas = CAS.NAME_DEFAULT_SOFA, outputSofas = GOLD_VIEW)
- </pre></code>
+ <pre><code>
+ @SofaCapability(inputSofas = CAS.NAME_DEFAULT_SOFA, outputSofas = GOLD_VIEW)
+ </code></pre>
Adding this annotation to your analysis engine description makes your component "sofa aware." The
base CAS delivered to "sofa aware" components has no explicit view associated with it. The logic
@@ -100,28 +110,52 @@ public @interface <span class="strong">S
as needed. You should therefore be aware that if you need to work with the "_InitialView" view,
then you must explicitly request it with a call like:
- <code><pre>
+ <pre><code>
JCas initialView = jCas.getView(CAS.NAME_DEFAULT_SOFA);
- </pre></code>
+ </code></pre>
This is because the base CAS that it passed into the process method to "sofa aware" components is
not the same as the "_InitialView". See how the following member variable is used to understand
why/how:
- org.apache.uima.analysis_engine.impl.PrimitiveAnalysisEngine_impl. mSofaAware</div>
+ <pre><code>
+ org.apache.uima.analysis_engine.impl.PrimitiveAnalysisEngine_impl.mSofaAware
+ </code></pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
+<!-- =========== ANNOTATION TYPE FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation.type.field.summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Fields and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static <a href="http://download.oracle.com/javase/1.5.0/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/descriptor/SofaCapability.html#NO_DEFAULT_VALUE">NO_DEFAULT_VALUE</a></span></code>
+<div class="block">Provides the default value for the inputs and the outputs that tells the CapabilityFactory that
+ no value has been given to the inputs or outputs elements.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
-<li class="blockList"><a name="annotation_type_optional_element_summary">
+<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
-<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
@@ -129,14 +163,14 @@ public @interface <span class="strong">S
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/fit/descriptor/SofaCapability.html#inputSofas()">inputSofas</a></strong></code>
-<div class="block">the values should be string vales corresponding to view names such as e.g.</div>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/SofaCapability.html#inputSofas--">inputSofas</a></span></code>
+<div class="block">The values should be string vales corresponding to view names such as e.g.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
-<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/fit/descriptor/SofaCapability.html#outputSofas()">outputSofas</a></strong></code>
-<div class="block">the values should be string vales corresponding to view names that this analysis component will
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/SofaCapability.html#outputSofas--">outputSofas</a></span></code>
+<div class="block">The values should be string vales corresponding to view names that this analysis component will
create.</div>
</td>
</tr>
@@ -149,37 +183,67 @@ public @interface <span class="strong">S
<div class="details">
<ul class="blockList">
<li class="blockList">
+<!-- ============ ANNOTATION TYPE FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="annotation.type.field.detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="NO_DEFAULT_VALUE">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>NO_DEFAULT_VALUE</h4>
+<pre>public static final <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> NO_DEFAULT_VALUE</pre>
+<div class="block">Provides the default value for the inputs and the outputs that tells the CapabilityFactory that
+ no value has been given to the inputs or outputs elements.</div>
+</li>
+</ul>
+</li>
+</ul>
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
-<li class="blockList"><a name="annotation_type_element_detail">
+<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
-<a name="inputSofas()">
+<a name="inputSofas--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>inputSofas</h4>
<pre>public abstract <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] inputSofas</pre>
-<div class="block">the values should be string vales corresponding to view names such as e.g.
+<div class="block">The values should be string vales corresponding to view names such as e.g.
CAS.NAME_DEFAULT_SOFA that this analysis component expects to be present in the CAS.</div>
<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the input sofas</dd>
+</dl>
+<dl>
<dt>Default:</dt>
<dd>"org.apache.uima.fit.descriptor.SofaCapability.NO_DEFAULT_VALUE"</dd>
</dl>
</li>
</ul>
-<a name="outputSofas()">
+</li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="outputSofas--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>outputSofas</h4>
<pre>public abstract <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] outputSofas</pre>
-<div class="block">the values should be string vales corresponding to view names that this analysis component will
+<div class="block">The values should be string vales corresponding to view names that this analysis component will
create.</div>
<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the output sofas</dd>
+</dl>
+<dl>
<dt>Default:</dt>
<dd>"org.apache.uima.fit.descriptor.SofaCapability.NO_DEFAULT_VALUE"</dd>
</dl>
@@ -193,9 +257,11 @@ public @interface <span class="strong">S
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<div class="bottomNav"><a name="navbar_bottom">
+<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
-</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
+</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">
@@ -211,15 +277,15 @@ public @interface <span class="strong">S
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/uima/fit/descriptor/TypeCapability.html" title="annotation in org.apache.uima.fit.descriptor"><span class="strong">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/ResourceMetaData.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/fit/descriptor/TypeCapability.html" title="annotation in org.apache.uima.fit.descriptor"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/uima/fit/descriptor/SofaCapability.html" target="_top">Frames</a></li>
-<li><a href="SofaCapability.html" target="_top">No Frames</a></li>
+<li><a href="SofaCapability.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
-<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -236,18 +302,20 @@ public @interface <span class="strong">S
<div>
<ul class="subNavList">
<li>Summary: </li>
+<li><a href="#annotation.type.field.summary">Field</a> | </li>
<li>Required | </li>
-<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
+<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#annotation_type_element_detail">Element</a></li>
+<li><a href="#annotation.type.field.detail">Field</a> | </li>
+<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
-<a name="skip-navbar_bottom">
+<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-<p class="legalCopy"><small>Copyright © 2012–2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
+<p class="legalCopy"><small>Copyright © 2012–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>