Added: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndex.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndex.html?rev=1857643&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndex.html (added) +++ uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndex.html Tue Apr 16 11:40:19 2019 @@ -0,0 +1,478 @@ +<!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>FsIndex (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="FsIndex (Apache uimaFIT 3.0.0 User-Level API Documentation)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/FsIndex.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/descriptor/ExternalResourceLocator.html" title="interface in org.apache.uima.fit.descriptor"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/uima/fit/descriptor/FsIndex.NoClassSet.html" title="class 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/FsIndex.html" target="_top">Frames</a></li> +<li><a href="FsIndex.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><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.field.detail">Field</a> | </li> +<li><a href="#annotation.type.element.detail">Element</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.descriptor</div> +<h2 title="Annotation Type FsIndex" class="title">Annotation Type FsIndex</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/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">FsIndex</span></pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FsIndexDescription</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 <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/descriptor/FsIndex.html#KIND_BAG">KIND_BAG</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <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/descriptor/FsIndex.html#KIND_SET">KIND_SET</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <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/descriptor/FsIndex.html#KIND_SORTED">KIND_SORTED</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <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/descriptor/FsIndex.html#NO_NAME_TYPE_SET">NO_NAME_TYPE_SET</a></span></code> +<div class="block">Indicated that no type name has been set.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.required.element.summary"> +<!-- --> +</a> +<h3>Required Element Summary</h3> +<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> +<th class="colLast" scope="col">Required Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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/descriptor/FsIndex.html#label--">label</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"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<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> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexKey.html" title="annotation in org.apache.uima.fit.descriptor">FsIndexKey</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/FsIndex.html#keys--">keys</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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/descriptor/FsIndex.html#kind--">kind</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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.cas.TOP></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/FsIndex.html#type--">type</a></span></code> +<div class="block">The type of the index as class.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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/descriptor/FsIndex.html#typeName--">typeName</a></span></code> +<div class="block">The type of the index as name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/FsIndex.html#typePriorities--">typePriorities</a></span></code> </td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<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="KIND_SORTED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KIND_SORTED</h4> +<pre>public static final <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> KIND_SORTED</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FsIndexDescription.KIND_SORTED</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="KIND_SET"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KIND_SET</h4> +<pre>public static final <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> KIND_SET</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FsIndexDescription.KIND_SET</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="KIND_BAG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KIND_BAG</h4> +<pre>public static final <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> KIND_BAG</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FsIndexDescription.KIND_BAG</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="NO_NAME_TYPE_SET"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>NO_NAME_TYPE_SET</h4> +<pre>public static final <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> NO_NAME_TYPE_SET</pre> +<div class="block">Indicated that no type name has been set.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.element.detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="label--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>label</h4> +<pre>public abstract <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> label</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the label of this index</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FsIndexDescription.getLabel()</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="typeName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>typeName</h4> +<pre>public abstract <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> typeName</pre> +<div class="block">The type of the index as name. As an alternative, the index can be defined using a class with + <a href="../../../../../org/apache/uima/fit/descriptor/FsIndex.html#type--"><code>type()</code></a>. One method or the other must be used to set the index type.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the type name for this index</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FsIndexDescription.getTypeName()</code></dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>"org.apache.uima.fit.descriptor.FsIndex.NO_NAME_TYPE_SET"</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="type--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>type</h4> +<pre>public abstract <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.cas.TOP> type</pre> +<div class="block">The type of the index as class. As an alternative, the index can be defined using a type name + with <a href="../../../../../org/apache/uima/fit/descriptor/FsIndex.html#typeName--"><code>typeName()</code></a>. One method or the other must be used to set the index type.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the type for this index</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FsIndexDescription.getTypeName()</code></dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>org.apache.uima.fit.descriptor.FsIndex.NoClassSet.class</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="kind--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>kind</h4> +<pre>public abstract <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> kind</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the kind of index</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FsIndexDescription.getKind()</code></dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>"bag"</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="keys--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keys</h4> +<pre>public abstract <a href="../../../../../org/apache/uima/fit/descriptor/FsIndexKey.html" title="annotation in org.apache.uima.fit.descriptor">FsIndexKey</a>[] keys</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the keys for this index</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FsIndexDescription.getKeys()</code></dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="typePriorities--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>typePriorities</h4> +<pre>public abstract boolean typePriorities</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if and only if this is a type priority key</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FsIndexKeyDescription.isTypePriority()</code></dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>true</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/FsIndex.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/descriptor/ExternalResourceLocator.html" title="interface in org.apache.uima.fit.descriptor"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/uima/fit/descriptor/FsIndex.NoClassSet.html" title="class 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/FsIndex.html" target="_top">Frames</a></li> +<li><a href="FsIndex.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><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.field.detail">Field</a> | </li> +<li><a href="#annotation.type.element.detail">Element</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndex.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndex.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndexCollection.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndexCollection.html?rev=1857643&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndexCollection.html (added) +++ uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndexCollection.html Tue Apr 16 11:40:19 2019 @@ -0,0 +1,225 @@ +<!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>FsIndexCollection (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="FsIndexCollection (Apache uimaFIT 3.0.0 User-Level API Documentation)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/FsIndexCollection.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/descriptor/FsIndex.NoClassSet.html" title="class in org.apache.uima.fit.descriptor"><span class="typeNameLink">Prev 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">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/uima/fit/descriptor/FsIndexCollection.html" target="_top">Frames</a></li> +<li><a href="FsIndexCollection.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>Field | </li> +<li><a href="#annotation.type.required.element.summary">Required</a> | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#annotation.type.element.detail">Element</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.descriptor</div> +<h2 title="Annotation Type FsIndexCollection" class="title">Annotation Type FsIndexCollection</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/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">FsIndexCollection</span></pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FsIndexCollection</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 REQUIRED MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.required.element.summary"> +<!-- --> +</a> +<h3>Required Element Summary</h3> +<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> +<th class="colLast" scope="col">Required Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/uima/fit/descriptor/FsIndex.html" title="annotation in org.apache.uima.fit.descriptor">FsIndex</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/fit/descriptor/FsIndexCollection.html#fsIndexes--">fsIndexes</a></span></code> </td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.element.detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="fsIndexes--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>fsIndexes</h4> +<pre>public abstract <a href="../../../../../org/apache/uima/fit/descriptor/FsIndex.html" title="annotation in org.apache.uima.fit.descriptor">FsIndex</a>[] fsIndexes</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a description of the FS Indexes that comprise this FS Index Collection</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>FsIndexCollection.getFsIndexes()</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/FsIndexCollection.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/descriptor/FsIndex.NoClassSet.html" title="class in org.apache.uima.fit.descriptor"><span class="typeNameLink">Prev 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">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/uima/fit/descriptor/FsIndexCollection.html" target="_top">Frames</a></li> +<li><a href="FsIndexCollection.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Field | </li> +<li><a href="#annotation.type.required.element.summary">Required</a> | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#annotation.type.element.detail">Element</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndexCollection.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndexCollection.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndexKey.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndexKey.html?rev=1857643&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndexKey.html (added) +++ uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndexKey.html Tue Apr 16 11:40:19 2019 @@ -0,0 +1,327 @@ +<!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>FsIndexKey (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="FsIndexKey (Apache uimaFIT 3.0.0 User-Level API Documentation)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/FsIndexKey.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/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/LanguageCapability.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> +</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><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.field.detail">Field</a> | </li> +<li><a href="#annotation.type.element.detail">Element</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.descriptor</div> +<h2 title="Annotation Type FsIndexKey" class="title">Annotation Type FsIndexKey</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/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"> +<!-- --> +</a> +<h3>Required Element Summary</h3> +<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> +<th class="colLast" scope="col">Required Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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/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"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<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> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</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> +</ul> +</li> +</ul> +</div> +<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"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="featureName--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>featureName</h4> +<pre>public abstract <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> featureName</pre> +<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> +<!-- ============ 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="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> +</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/FsIndexKey.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/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/LanguageCapability.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> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><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.field.detail">Field</a> | </li> +<li><a href="#annotation.type.element.detail">Element</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndexKey.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/FsIndexKey.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/LanguageCapability.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/LanguageCapability.html?rev=1857643&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/LanguageCapability.html (added) +++ uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/LanguageCapability.html Tue Apr 16 11:40:19 2019 @@ -0,0 +1,269 @@ +<!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>LanguageCapability (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="LanguageCapability (Apache uimaFIT 3.0.0 User-Level API Documentation)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/LanguageCapability.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/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/MimeTypeCapability.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/LanguageCapability.html" target="_top">Frames</a></li> +<li><a href="LanguageCapability.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><a href="#annotation.type.field.summary">Field</a> | </li> +<li>Required | </li> +<li><a href="#annotation.type.optional.element.summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </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></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.uima.fit.descriptor</div> +<h2 title="Annotation Type LanguageCapability" class="title">Annotation Type LanguageCapability</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/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">LanguageCapability</span></pre> +<div class="block">Provides information on the languages supported by a component. + + <pre><code> + @LanguageCapability({ "en", "de" }) + </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="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/descriptor/LanguageCapability.html#NO_DEFAULT_VALUE">NO_DEFAULT_VALUE</a></span></code> +<div class="block">Provides the default value that tells the CapabilityFactory that no value has been provided.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.optional.element.summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<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> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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/descriptor/LanguageCapability.html#value--">value</a></span></code> +<div class="block">The languages supported by this component.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<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="https://docs.oracle.com/javase/8/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 that tells the CapabilityFactory that no value has been provided.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.element.detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="value--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>value</h4> +<pre>public abstract <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>[] value</pre> +<div class="block">The languages supported by this component.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the supported languages</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>"org.apache.uima.fit.descriptor.LanguageCapability.NO_DEFAULT_VALUE"</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/LanguageCapability.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/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/MimeTypeCapability.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/LanguageCapability.html" target="_top">Frames</a></li> +<li><a href="LanguageCapability.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#annotation.type.field.summary">Field</a> | </li> +<li>Required | </li> +<li><a href="#annotation.type.optional.element.summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </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></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/LanguageCapability.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/LanguageCapability.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/MimeTypeCapability.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/MimeTypeCapability.html?rev=1857643&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/MimeTypeCapability.html (added) +++ uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/MimeTypeCapability.html Tue Apr 16 11:40:19 2019 @@ -0,0 +1,269 @@ +<!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>MimeTypeCapability (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="MimeTypeCapability (Apache uimaFIT 3.0.0 User-Level API Documentation)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/MimeTypeCapability.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/descriptor/LanguageCapability.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/MimeTypeCapability.html" target="_top">Frames</a></li> +<li><a href="MimeTypeCapability.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><a href="#annotation.type.field.summary">Field</a> | </li> +<li>Required | </li> +<li><a href="#annotation.type.optional.element.summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </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></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.uima.fit.descriptor</div> +<h2 title="Annotation Type MimeTypeCapability" class="title">Annotation Type MimeTypeCapability</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/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">MimeTypeCapability</span></pre> +<div class="block">Provides information on the MIME types supported by a component. + + <pre><code> + @MimeTypeCapability({ "application/xml", "text/html" }) + </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="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/descriptor/MimeTypeCapability.html#NO_DEFAULT_VALUE">NO_DEFAULT_VALUE</a></span></code> +<div class="block">Provides the default value that tells the CapabilityFactory that no value has been provided.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.optional.element.summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<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> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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/descriptor/MimeTypeCapability.html#value--">value</a></span></code> +<div class="block">The MIME types supported by this component.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<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="https://docs.oracle.com/javase/8/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 that tells the CapabilityFactory that no value has been provided.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation.type.element.detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="value--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>value</h4> +<pre>public abstract <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>[] value</pre> +<div class="block">The MIME types supported by this component.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the supported MIME types</dd> +</dl> +<dl> +<dt>Default:</dt> +<dd>"org.apache.uima.fit.descriptor.MimeTypeCapability.NO_DEFAULT_VALUE"</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/MimeTypeCapability.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/descriptor/LanguageCapability.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/MimeTypeCapability.html" target="_top">Frames</a></li> +<li><a href="MimeTypeCapability.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#annotation.type.field.summary">Field</a> | </li> +<li>Required | </li> +<li><a href="#annotation.type.optional.element.summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </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></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/MimeTypeCapability.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/MimeTypeCapability.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/OperationalProperties.html URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/OperationalProperties.html?rev=1857643&view=auto ============================================================================== --- uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/OperationalProperties.html (added) +++ uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/OperationalProperties.html Tue Apr 16 11:40:19 2019 @@ -0,0 +1,370 @@ +<!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>OperationalProperties (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="OperationalProperties (Apache uimaFIT 3.0.0 User-Level API Documentation)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/OperationalProperties.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/descriptor/MimeTypeCapability.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> +</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><a href="#annotation.type.field.summary">Field</a> | </li> +<li>Required | </li> +<li><a href="#annotation.type.optional.element.summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </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></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.uima.fit.descriptor</div> +<h2 title="Annotation Type OperationalProperties" class="title">Annotation Type OperationalProperties</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/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"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<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> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<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><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><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> +</table> +</li> +</ul> +</li> +</ul> +</div> +<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"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="multipleDeploymentAllowed--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>multipleDeploymentAllowed</h4> +<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="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> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="modifiesCas--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<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="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> +</li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="outputsNewCases--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>outputsNewCases</h4> +<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 + <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="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> +</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/OperationalProperties.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/descriptor/MimeTypeCapability.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> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#annotation.type.field.summary">Field</a> | </li> +<li>Required | </li> +<li><a href="#annotation.type.optional.element.summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </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></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/OperationalProperties.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: uima/site/trunk/uima-website/docs/d/uimafit-3.0.0/api/org/apache/uima/fit/descriptor/OperationalProperties.html ------------------------------------------------------------------------------ svn:mime-type = text/html