cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
433 lines (432 loc) • 21.2 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:30 CEST 2014 -->
<title>SSTableNamesIterator (apache-cassandra API)</title>
<meta name="date" content="2014-09-07">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SSTableNamesIterator (apache-cassandra API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/SSTableNamesIterator.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/cassandra/db/columniterator/OnDiskAtomIterator.html" title="interface in org.apache.cassandra.db.columniterator"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/db/columniterator/SSTableSliceIterator.html" title="class in org.apache.cassandra.db.columniterator"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/db/columniterator/SSTableNamesIterator.html" target="_top">Frames</a></li>
<li><a href="SSTableNamesIterator.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>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </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.cassandra.db.columniterator</div>
<h2 title="Class SSTableNamesIterator" class="title">Class SSTableNamesIterator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.google.common.collect.UnmodifiableIterator<T></li>
<li>
<ul class="inheritance">
<li>com.google.common.collect.AbstractIterator<<a href="../../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a>></li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.db.columniterator.SSTableNamesIterator</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.lang.AutoCloseable, java.util.Iterator<<a href="../../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a>>, <a href="../../../../../org/apache/cassandra/db/columniterator/OnDiskAtomIterator.html" title="interface in org.apache.cassandra.db.columniterator">OnDiskAtomIterator</a>, <a href="../../../../../org/apache/cassandra/utils/CloseableIterator.html" title="interface in org.apache.cassandra.utils">CloseableIterator</a><<a href="../../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a>></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">SSTableNamesIterator</span>
extends com.google.common.collect.AbstractIterator<<a href="../../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a>>
implements <a href="../../../../../org/apache/cassandra/db/columniterator/OnDiskAtomIterator.html" title="interface in org.apache.cassandra.db.columniterator">OnDiskAtomIterator</a></pre>
</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>
<table class="overviewSummary" 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">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.SortedSet<<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/columniterator/SSTableNamesIterator.html#columns">columns</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/columniterator/SSTableNamesIterator.html#key">key</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/cassandra/db/columniterator/SSTableNamesIterator.html#SSTableNamesIterator(org.apache.cassandra.io.sstable.SSTableReader,%20org.apache.cassandra.db.DecoratedKey,%20java.util.SortedSet)">SSTableNamesIterator</a></strong>(<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a> sstable,
<a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key,
java.util.SortedSet<<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a>> columns)</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/cassandra/db/columniterator/SSTableNamesIterator.html#SSTableNamesIterator(org.apache.cassandra.io.sstable.SSTableReader,%20org.apache.cassandra.io.util.FileDataInput,%20org.apache.cassandra.db.DecoratedKey,%20java.util.SortedSet,%20org.apache.cassandra.db.RowIndexEntry)">SSTableNamesIterator</a></strong>(<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a> sstable,
<a href="../../../../../org/apache/cassandra/io/util/FileDataInput.html" title="interface in org.apache.cassandra.io.util">FileDataInput</a> file,
<a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key,
java.util.SortedSet<<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a>> columns,
<a href="../../../../../org/apache/cassandra/db/RowIndexEntry.html" title="class in org.apache.cassandra.db">RowIndexEntry</a> indexEntry)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/columniterator/SSTableNamesIterator.html#close()">close</a></strong>()</code>
<div class="block">clean up any open resources</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/columniterator/SSTableNamesIterator.html#computeNext()">computeNext</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/columniterator/SSTableNamesIterator.html#getColumnFamily()">getColumnFamily</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/columniterator/SSTableNamesIterator.html#getKey()">getKey</a></strong>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.google.common.collect.AbstractIterator">
<!-- -->
</a>
<h3>Methods inherited from class com.google.common.collect.AbstractIterator</h3>
<code>endOfData, hasNext, next, peek</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.google.common.collect.UnmodifiableIterator">
<!-- -->
</a>
<h3>Methods inherited from class com.google.common.collect.UnmodifiableIterator</h3>
<code>remove</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.util.Iterator">
<!-- -->
</a>
<h3>Methods inherited from interface java.util.Iterator</h3>
<code>hasNext, next, remove</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="columns">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>columns</h4>
<pre>public final java.util.SortedSet<<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a>> columns</pre>
</li>
</ul>
<a name="key">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>key</h4>
<pre>public final <a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SSTableNamesIterator(org.apache.cassandra.io.sstable.SSTableReader, org.apache.cassandra.db.DecoratedKey, java.util.SortedSet)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SSTableNamesIterator</h4>
<pre>public SSTableNamesIterator(<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a> sstable,
<a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key,
java.util.SortedSet<<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a>> columns)</pre>
</li>
</ul>
<a name="SSTableNamesIterator(org.apache.cassandra.io.sstable.SSTableReader, org.apache.cassandra.io.util.FileDataInput, org.apache.cassandra.db.DecoratedKey, java.util.SortedSet, org.apache.cassandra.db.RowIndexEntry)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SSTableNamesIterator</h4>
<pre>public SSTableNamesIterator(<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a> sstable,
<a href="../../../../../org/apache/cassandra/io/util/FileDataInput.html" title="interface in org.apache.cassandra.io.util">FileDataInput</a> file,
<a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key,
java.util.SortedSet<<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a>> columns,
<a href="../../../../../org/apache/cassandra/db/RowIndexEntry.html" title="class in org.apache.cassandra.db">RowIndexEntry</a> indexEntry)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKey</h4>
<pre>public <a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> getKey()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cassandra/db/columniterator/OnDiskAtomIterator.html#getKey()">getKey</a></code> in interface <code><a href="../../../../../org/apache/cassandra/db/columniterator/OnDiskAtomIterator.html" title="interface in org.apache.cassandra.db.columniterator">OnDiskAtomIterator</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the current row key</dd></dl>
</li>
</ul>
<a name="getColumnFamily()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnFamily</h4>
<pre>public <a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> getColumnFamily()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cassandra/db/columniterator/OnDiskAtomIterator.html#getColumnFamily()">getColumnFamily</a></code> in interface <code><a href="../../../../../org/apache/cassandra/db/columniterator/OnDiskAtomIterator.html" title="interface in org.apache.cassandra.db.columniterator">OnDiskAtomIterator</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>A ColumnFamily holding metadata for the row being iterated.
Do not modify this CF. Whether it is empty or not is implementation-dependent.</dd></dl>
</li>
</ul>
<a name="computeNext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeNext</h4>
<pre>protected <a href="../../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a> computeNext()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>computeNext</code> in class <code>com.google.common.collect.AbstractIterator<<a href="../../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a>></code></dd>
</dl>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public void close()
throws java.io.IOException</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/cassandra/db/columniterator/OnDiskAtomIterator.html#close()">OnDiskAtomIterator</a></code></strong></div>
<div class="block">clean up any open resources</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>close</code> in interface <code>java.io.Closeable</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cassandra/db/columniterator/OnDiskAtomIterator.html#close()">close</a></code> in interface <code><a href="../../../../../org/apache/cassandra/db/columniterator/OnDiskAtomIterator.html" title="interface in org.apache.cassandra.db.columniterator">OnDiskAtomIterator</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/SSTableNamesIterator.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/cassandra/db/columniterator/OnDiskAtomIterator.html" title="interface in org.apache.cassandra.db.columniterator"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/db/columniterator/SSTableSliceIterator.html" title="class in org.apache.cassandra.db.columniterator"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/db/columniterator/SSTableNamesIterator.html" target="_top">Frames</a></li>
<li><a href="SSTableNamesIterator.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>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </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 © 2014 The Apache Software Foundation</small></p>
</body>
</html>