Google Git
Sign in
apache / uima-site / 46633befe258795c3c128d0f784233a7905b0ec4 / . / docs / d / uimaj-current / apidocs / org / apache / uima / search / IndexBuildItem.html
blob: 4bbf57706683e17c27607664d2046fbc5dee7f9e [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IndexBuildItem (Apache UIMA Java SDK 3.0.2 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="IndexBuildItem (Apache UIMA Java SDK 3.0.2 User-Level API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IndexBuildItem.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/search/Filter.html" title="interface in org.apache.uima.search"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/uima/search/IndexBuildSpecification.html" title="interface in org.apache.uima.search"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/uima/search/IndexBuildItem.html" target="_top">Frames</a></li>
<li><a href="IndexBuildItem.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.uima.search</div>
<h2 title="Interface IndexBuildItem" class="title">Interface IndexBuildItem</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../org/apache/uima/util/XMLizable.html" title="interface in org.apache.uima.util">XMLizable</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IndexBuildItem</span>
extends <a href="../../../../org/apache/uima/util/XMLizable.html" title="interface in org.apache.uima.util">XMLizable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">An individual item within a <a href="../../../../org/apache/uima/search/IndexBuildSpecification.html" title="interface in org.apache.uima.search"><code>IndexBuildSpecification</code></a>. Specifies the <a href="../../../../org/apache/uima/search/IndexBuildItem.html#getName--"><code>getName()</code></a>
name of a CAS type, a <a href="../../../../org/apache/uima/search/IndexBuildItem.html#getIndexRule--"><code>index rule</code></a>, and an optional
<a href="../../../../org/apache/uima/search/IndexBuildItem.html#getFilter--"><code>filter</code></a>.
<p>
This object implements the <a href="../../../../org/apache/uima/util/XMLizable.html" title="interface in org.apache.uima.util"><code>XMLizable</code></a> interface and can be parsed from an XML
representation.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/uima/search/Filter.html" title="interface in org.apache.uima.search">Filter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/search/IndexBuildItem.html#getFilter--">getFilter</a></span>()</code>
<div class="block">Gets the <code>Filter</code> that identifies which instances of the named CAS type are
governed by the index rule for this item.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/uima/search/IndexRule.html" title="interface in org.apache.uima.search">IndexRule</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/search/IndexBuildItem.html#getIndexRule--">getIndexRule</a></span>()</code>
<div class="block">Gets the <code>IndexRule</code> that defines how annotations matching this build item should
be indexed.</div>
</td>
</tr>
<tr id="i2" 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/search/IndexBuildItem.html#getName--">getName</a></span>()</code>
<div class="block">Gets the name of the CAS type for which this item defines the indexing behavior.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/search/IndexBuildItem.html#setFilter-org.apache.uima.search.Filter-">setFilter</a></span>(<a href="../../../../org/apache/uima/search/Filter.html" title="interface in org.apache.uima.search">Filter</a>&nbsp;aFilter)</code>
<div class="block">Sets the <code>Filter</code> that identifies which instances of the named CAS type are
governed by the index rule for this item.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/search/IndexBuildItem.html#setIndexRule-org.apache.uima.search.IndexRule-">setIndexRule</a></span>(<a href="../../../../org/apache/uima/search/IndexRule.html" title="interface in org.apache.uima.search">IndexRule</a>&nbsp;aRule)</code>
<div class="block">Sets the <code>IndexRule</code> that defines how annotations matching this build item should
be indexed.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/search/IndexBuildItem.html#setName-java.lang.String-">setName</a></span>(<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>&nbsp;aName)</code>
<div class="block">Sets the name of the CAS type for which this item defines the indexing behavior.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.uima.util.XMLizable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.uima.util.<a href="../../../../org/apache/uima/util/XMLizable.html" title="interface in org.apache.uima.util">XMLizable</a></h3>
<code><a href="../../../../org/apache/uima/util/XMLizable.html#buildFromXMLElement-org.w3c.dom.Element-org.apache.uima.util.XMLParser-">buildFromXMLElement</a>, <a href="../../../../org/apache/uima/util/XMLizable.html#buildFromXMLElement-org.w3c.dom.Element-org.apache.uima.util.XMLParser-org.apache.uima.util.XMLParser.ParsingOptions-">buildFromXMLElement</a>, <a href="../../../../org/apache/uima/util/XMLizable.html#toXML-org.xml.sax.ContentHandler-">toXML</a>, <a href="../../../../org/apache/uima/util/XMLizable.html#toXML-org.xml.sax.ContentHandler-boolean-">toXML</a>, <a href="../../../../org/apache/uima/util/XMLizable.html#toXML-java.io.OutputStream-">toXML</a>, <a href="../../../../org/apache/uima/util/XMLizable.html#toXML-java.io.Writer-">toXML</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre><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>&nbsp;getName()</pre>
<div class="block">Gets the name of the CAS type for which this item defines the indexing behavior.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the CAS type name for this build item</dd>
</dl>
</li>
</ul>
<a name="setName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>void&nbsp;setName(<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>&nbsp;aName)</pre>
<div class="block">Sets the name of the CAS type for which this item defines the indexing behavior.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>aName</code> - the CAS type name for this build item</dd>
</dl>
</li>
</ul>
<a name="getIndexRule--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndexRule</h4>
<pre><a href="../../../../org/apache/uima/search/IndexRule.html" title="interface in org.apache.uima.search">IndexRule</a>&nbsp;getIndexRule()</pre>
<div class="block">Gets the <code>IndexRule</code> that defines how annotations matching this build item should
be indexed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the indexing rule for this build item</dd>
</dl>
</li>
</ul>
<a name="setIndexRule-org.apache.uima.search.IndexRule-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIndexRule</h4>
<pre>void&nbsp;setIndexRule(<a href="../../../../org/apache/uima/search/IndexRule.html" title="interface in org.apache.uima.search">IndexRule</a>&nbsp;aRule)</pre>
<div class="block">Sets the <code>IndexRule</code> that defines how annotations matching this build item should
be indexed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>aRule</code> - the indexing rule for this build item</dd>
</dl>
</li>
</ul>
<a name="getFilter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilter</h4>
<pre><a href="../../../../org/apache/uima/search/Filter.html" title="interface in org.apache.uima.search">Filter</a>&nbsp;getFilter()</pre>
<div class="block">Gets the <code>Filter</code> that identifies which instances of the named CAS type are
governed by the index rule for this item. Filters are optional; if none is specified then this
rule applies to all instances of the named CAS type.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Filter for this build item, null if none</dd>
</dl>
</li>
</ul>
<a name="setFilter-org.apache.uima.search.Filter-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setFilter</h4>
<pre>void&nbsp;setFilter(<a href="../../../../org/apache/uima/search/Filter.html" title="interface in org.apache.uima.search">Filter</a>&nbsp;aFilter)</pre>
<div class="block">Sets the <code>Filter</code> that identifies which instances of the named CAS type are
governed by the index rule for this item. Filters are optional; if none is specified then this
rule applies to all instances of the named CAS type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>aFilter</code> - the Filter for this build item, null if none</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/IndexBuildItem.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/search/Filter.html" title="interface in org.apache.uima.search"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/uima/search/IndexBuildSpecification.html" title="interface in org.apache.uima.search"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/uima/search/IndexBuildItem.html" target="_top">Frames</a></li>
<li><a href="IndexBuildItem.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>