cassandra-server

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <html lang="en"> <head>  <title>SSTableSliceIterator (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"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript>  <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/SSTableSliceIterator.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/SSTableNamesIterator.html" title="class in org.apache.cassandra.db.columniterator"><span class="strong">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/db/columniterator/SSTableSliceIterator.html" target="_top">Frames</a></li> <li><a href="SSTableSliceIterator.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </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>Field | </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>   <div class="header"> <div class="subTitle">org.apache.cassandra.db.columniterator</div> <h2 title="Class SSTableSliceIterator" class="title">Class SSTableSliceIterator</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.db.columniterator.SSTableSliceIterator</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">SSTableSliceIterator</span> extends java.lang.Object implements <a href="../../../../../org/apache/cassandra/db/columniterator/OnDiskAtomIterator.html" title="interface in org.apache.cassandra.db.columniterator">OnDiskAtomIterator</a></pre> <div class="block">A Cell Iterator over SSTable</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <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/SSTableSliceIterator.html#SSTableSliceIterator(org.apache.cassandra.io.sstable.SSTableReader,%20org.apache.cassandra.db.DecoratedKey,%20org.apache.cassandra.db.filter.ColumnSlice[],%20boolean)">SSTableSliceIterator</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, <a href="../../../../../org/apache/cassandra/db/filter/ColumnSlice.html" title="class in org.apache.cassandra.db.filter">ColumnSlice</a>[] slices, boolean reversed)</code> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../../../org/apache/cassandra/db/columniterator/SSTableSliceIterator.html#SSTableSliceIterator(org.apache.cassandra.io.sstable.SSTableReader,%20org.apache.cassandra.io.util.FileDataInput,%20org.apache.cassandra.db.DecoratedKey,%20org.apache.cassandra.db.filter.ColumnSlice[],%20boolean,%20org.apache.cassandra.db.RowIndexEntry)">SSTableSliceIterator</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, <a href="../../../../../org/apache/cassandra/db/filter/ColumnSlice.html" title="class in org.apache.cassandra.db.filter">ColumnSlice</a>[] slices, boolean reversed, <a href="../../../../../org/apache/cassandra/db/RowIndexEntry.html" title="class in org.apache.cassandra.db">RowIndexEntry</a> indexEntry)</code> <div class="block">An iterator for a slice within an SSTable</div> </td> </tr> </table> </li> </ul>  <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/SSTableSliceIterator.html#close()">close</a></strong>()</code> <div class="block">clean up any open resources</div> </td> </tr> <tr class="rowColor"> <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/SSTableSliceIterator.html#getColumnFamily()">getColumnFamily</a></strong>()</code> </td> </tr> <tr class="altColor"> <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/SSTableSliceIterator.html#getKey()">getKey</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/columniterator/SSTableSliceIterator.html#hasNext()">hasNext</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><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/SSTableSliceIterator.html#next()">next</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/columniterator/SSTableSliceIterator.html#remove()">remove</a></strong>()</code> </td> </tr> </table> <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> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="SSTableSliceIterator(org.apache.cassandra.io.sstable.SSTableReader, org.apache.cassandra.db.DecoratedKey, org.apache.cassandra.db.filter.ColumnSlice[], boolean)">  </a> <ul class="blockList"> <li class="blockList"> <h4>SSTableSliceIterator</h4> <pre>public SSTableSliceIterator(<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, <a href="../../../../../org/apache/cassandra/db/filter/ColumnSlice.html" title="class in org.apache.cassandra.db.filter">ColumnSlice</a>[] slices, boolean reversed)</pre> </li> </ul> <a name="SSTableSliceIterator(org.apache.cassandra.io.sstable.SSTableReader, org.apache.cassandra.io.util.FileDataInput, org.apache.cassandra.db.DecoratedKey, org.apache.cassandra.db.filter.ColumnSlice[], boolean, org.apache.cassandra.db.RowIndexEntry)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>SSTableSliceIterator</h4> <pre>public SSTableSliceIterator(<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, <a href="../../../../../org/apache/cassandra/db/filter/ColumnSlice.html" title="class in org.apache.cassandra.db.filter">ColumnSlice</a>[] slices, boolean reversed, <a href="../../../../../org/apache/cassandra/db/RowIndexEntry.html" title="class in org.apache.cassandra.db">RowIndexEntry</a> indexEntry)</pre> <div class="block">An iterator for a slice within an SSTable</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sstable</code> - Keyspace for the CFS we are reading from</dd><dd><code>file</code> - Optional parameter that input is read from. If null is passed, this class creates an appropriate one automatically. If this class creates, it will close the underlying file when #close() is called. If a caller passes a non-null argument, this class will NOT close the underlying file when the iterator is closed (i.e. the caller is responsible for closing the file) In all cases the caller should explicitly #close() this iterator.</dd><dd><code>key</code> - The key the requested slice resides under</dd><dd><code>slices</code> - the column slices</dd><dd><code>reversed</code> - Results are returned in reverse order iff reversed is true.</dd><dd><code>indexEntry</code> - position of the row</dd></dl> </li> </ul> </li> </ul>  <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="hasNext()">  </a> <ul class="blockList"> <li class="blockList"> <h4>hasNext</h4> <pre>public boolean hasNext()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>hasNext</code> in interface <code>java.util.Iterator<<a href="../../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a>></code></dd> </dl> </li> </ul> <a name="next()">  </a> <ul class="blockList"> <li class="blockList"> <h4>next</h4> <pre>public <a href="../../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a> next()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>next</code> in interface <code>java.util.Iterator<<a href="../../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a>></code></dd> </dl> </li> </ul> <a name="remove()">  </a> <ul class="blockList"> <li class="blockList"> <h4>remove</h4> <pre>public void remove()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>remove</code> in interface <code>java.util.Iterator<<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>   <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/SSTableSliceIterator.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/SSTableNamesIterator.html" title="class in org.apache.cassandra.db.columniterator"><span class="strong">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/db/columniterator/SSTableSliceIterator.html" target="_top">Frames</a></li> <li><a href="SSTableSliceIterator.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </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>Field | </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>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>