Google Git
Sign in
apache / uima-site / 7afcbb84fa9a14b63f60be9eff49aa9579ad4dca / . / docs / d / uimaj-3.2.0 / apidocs / org / apache / uima / cas / impl / FSIndexComparatorImpl.html
blob: 3812d1eb1e90a5009ab785d4961fb9e5e10fdc50 [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>FSIndexComparatorImpl (Apache UIMA Java SDK 3.2.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="FSIndexComparatorImpl (Apache UIMA Java SDK 3.2.0 User-Level API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/FSIndexComparatorImpl.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/uima/cas/impl/FsIndex_snapshot.html" title="class in org.apache.uima.cas.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/uima/cas/impl/FSIndexRepositoryImpl.html" title="class in org.apache.uima.cas.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/uima/cas/impl/FSIndexComparatorImpl.html" target="_top">Frames</a></li>
<li><a href="FSIndexComparatorImpl.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.uima.cas.impl</div>
<h2 title="Class FSIndexComparatorImpl" class="title">Class FSIndexComparatorImpl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.uima.cas.impl.FSIndexComparatorImpl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a>&gt;, <a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">FSIndexComparatorImpl</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a></pre>
<div class="block">Specifies the comparison to be used for an index, in terms of
- the keys and the typeorder, in an order
- the standard/reverse ordering</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.uima.cas.admin.FSIndexComparator">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.uima.cas.admin.<a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a></h3>
<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#FEATURE_KEY">FEATURE_KEY</a>, <a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#REVERSE_STANDARD_COMPARE">REVERSE_STANDARD_COMPARE</a>, <a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#STANDARD_COMPARE">STANDARD_COMPARE</a>, <a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#TYPE_ORDER_KEY">TYPE_ORDER_KEY</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html#FSIndexComparatorImpl--">FSIndexComparatorImpl</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html#addKey-org.apache.uima.cas.Feature-int-">addKey</a></span>(<a href="../../../../../org/apache/uima/cas/Feature.html" title="interface in org.apache.uima.cas">Feature</a>&nbsp;feat,
int&nbsp;compareKey)</code>
<div class="block">Add a new key.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html#addKey-org.apache.uima.cas.admin.LinearTypeOrder-int-">addKey</a></span>(<a href="../../../../../org/apache/uima/cas/admin/LinearTypeOrder.html" title="interface in org.apache.uima.cas.admin">LinearTypeOrder</a>&nbsp;typeOrder,
int&nbsp;compareKey)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html#compareTo-org.apache.uima.cas.admin.FSIndexComparator-">compareTo</a></span>(<a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a>&nbsp;o)</code>
<div class="block">Compares two FSIndexComparator instances.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html" title="class in org.apache.uima.cas.impl">FSIndexComparatorImpl</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html#copy--">copy</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;o)</code>
<div class="block">Equals including the type of the comparator</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html#getKeyComparator-int-">getKeyComparator</a></span>(int&nbsp;key)</code>
<div class="block">Get the comparator for this key.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/uima/cas/impl/FeatureImpl.html" title="class in org.apache.uima.cas.impl">FeatureImpl</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html#getKeyFeature-int-">getKeyFeature</a></span>(int&nbsp;key)</code>
<div class="block">Get the feature for this key.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html#getKeyType-int-">getKeyType</a></span>(int&nbsp;key)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/uima/cas/admin/LinearTypeOrder.html" title="interface in org.apache.uima.cas.admin">LinearTypeOrder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html#getKeyTypeOrder-int-">getKeyTypeOrder</a></span>(int&nbsp;key)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html#getNumberOfKeys--">getNumberOfKeys</a></span>()</code>
<div class="block">Return the number of keys.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/uima/cas/Type.html" title="interface in org.apache.uima.cas">Type</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html#getType--">getType</a></span>()</code>
<div class="block">Get the type of this comparator.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html#isValid--">isValid</a></span>()</code>
<div class="block">Validate that this comparator is valid with respect to the type system.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html#setType-org.apache.uima.cas.Type-">setType</a></span>(<a href="../../../../../org/apache/uima/cas/Type.html" title="interface in org.apache.uima.cas">Type</a>&nbsp;type)</code>
<div class="block">Set the type of this comparator.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FSIndexComparatorImpl--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FSIndexComparatorImpl</h4>
<pre>public&nbsp;FSIndexComparatorImpl()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setType-org.apache.uima.cas.Type-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setType</h4>
<pre>public&nbsp;void&nbsp;setType(<a href="../../../../../org/apache/uima/cas/Type.html" title="interface in org.apache.uima.cas">Type</a>&nbsp;type)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#setType-org.apache.uima.cas.Type-">FSIndexComparator</a></code></span></div>
<div class="block">Set the type of this comparator. Note that you can use this method more than once, in case you
need to generate indexes that are identical except for the type.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#setType-org.apache.uima.cas.Type-">setType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - The type of the index.</dd>
</dl>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/uima/cas/Type.html" title="interface in org.apache.uima.cas">Type</a>&nbsp;getType()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#getType--">FSIndexComparator</a></code></span></div>
<div class="block">Get the type of this comparator.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#getType--">getType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The type of the comparator.</dd>
</dl>
</li>
</ul>
<a name="addKey-org.apache.uima.cas.Feature-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addKey</h4>
<pre>public&nbsp;int&nbsp;addKey(<a href="../../../../../org/apache/uima/cas/Feature.html" title="interface in org.apache.uima.cas">Feature</a>&nbsp;feat,
int&nbsp;compareKey)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#addKey-org.apache.uima.cas.Feature-int-">FSIndexComparator</a></code></span></div>
<div class="block">Add a new key.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#addKey-org.apache.uima.cas.Feature-int-">addKey</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>feat</code> - The key feature.</dd>
<dd><code>compareKey</code> - The way to compare the key values.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of the key.</dd>
</dl>
</li>
</ul>
<a name="addKey-org.apache.uima.cas.admin.LinearTypeOrder-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addKey</h4>
<pre>public&nbsp;int&nbsp;addKey(<a href="../../../../../org/apache/uima/cas/admin/LinearTypeOrder.html" title="interface in org.apache.uima.cas.admin">LinearTypeOrder</a>&nbsp;typeOrder,
int&nbsp;compareKey)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#addKey-org.apache.uima.cas.admin.LinearTypeOrder-int-">addKey</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>typeOrder</code> - the type order</dd>
<dd><code>compareKey</code> - the direction</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of the key</dd>
</dl>
</li>
</ul>
<a name="getKeyType-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeyType</h4>
<pre>public&nbsp;int&nbsp;getKeyType(int&nbsp;key)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#getKeyType-int-">getKeyType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a></code></dd>
</dl>
</li>
</ul>
<a name="getNumberOfKeys--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOfKeys</h4>
<pre>public&nbsp;int&nbsp;getNumberOfKeys()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#getNumberOfKeys--">FSIndexComparator</a></code></span></div>
<div class="block">Return the number of keys.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#getNumberOfKeys--">getNumberOfKeys</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of keys.</dd>
</dl>
</li>
</ul>
<a name="getKeyFeature-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeyFeature</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/uima/cas/impl/FeatureImpl.html" title="class in org.apache.uima.cas.impl">FeatureImpl</a>&nbsp;getKeyFeature(int&nbsp;key)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#getKeyFeature-int-">FSIndexComparator</a></code></span></div>
<div class="block">Get the feature for this key.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#getKeyFeature-int-">getKeyFeature</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The number of the key.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The corresponding feature, if it exists; <code>null</code>, else.</dd>
</dl>
</li>
</ul>
<a name="getKeyTypeOrder-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeyTypeOrder</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/uima/cas/admin/LinearTypeOrder.html" title="interface in org.apache.uima.cas.admin">LinearTypeOrder</a>&nbsp;getKeyTypeOrder(int&nbsp;key)</pre>
</li>
</ul>
<a name="getKeyComparator-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeyComparator</h4>
<pre>public&nbsp;int&nbsp;getKeyComparator(int&nbsp;key)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#getKeyComparator-int-">FSIndexComparator</a></code></span></div>
<div class="block">Get the comparator for this key.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#getKeyComparator-int-">getKeyComparator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The number of the key.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The corresponding comparator, if it exists; <code>-1</code>, else.</dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;o)</pre>
<div class="block">Equals including the type of the comparator</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#equals-java.lang.Object-">equals</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="isValid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre>public&nbsp;boolean&nbsp;isValid()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#isValid--">FSIndexComparator</a></code></span></div>
<div class="block">Validate that this comparator is valid with respect to the type system. Note that all types and
features used to define this comparator must come from the same type system. Note that this
method only returns true or false. It doesn't tell you what's actually wrong. Maybe we need to
change that?</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html#isValid--">isValid</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> iff all key features are appropriate for the type of this
comparator.</dd>
</dl>
</li>
</ul>
<a name="copy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/uima/cas/impl/FSIndexComparatorImpl.html" title="class in org.apache.uima.cas.impl">FSIndexComparatorImpl</a>&nbsp;copy()</pre>
</li>
</ul>
<a name="compareTo-org.apache.uima.cas.admin.FSIndexComparator-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>compareTo</h4>
<pre>public&nbsp;int&nbsp;compareTo(<a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a>&nbsp;o)</pre>
<div class="block">Compares two FSIndexComparator instances.
The code to compare two FSs is in the compare method of FsIndex_singletype.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true#compareTo-T-" title="class or interface in java.lang">compareTo</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../../../org/apache/uima/cas/admin/FSIndexComparator.html" title="interface in org.apache.uima.cas.admin">FSIndexComparator</a>&gt;</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true#compareTo-T-" title="class or interface in java.lang"><code>Comparable.compareTo(Object)</code></a></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/FSIndexComparatorImpl.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/uima/cas/impl/FsIndex_snapshot.html" title="class in org.apache.uima.cas.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/uima/cas/impl/FSIndexRepositoryImpl.html" title="class in org.apache.uima.cas.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/uima/cas/impl/FSIndexComparatorImpl.html" target="_top">Frames</a></li>
<li><a href="FSIndexComparatorImpl.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>