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>SSTableIdentityIterator (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/SSTableIdentityIterator.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/io/sstable/SSTableDeletingTask.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/io/sstable/SSTableLoader.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/io/sstable/SSTableIdentityIterator.html" target="_top">Frames</a></li> <li><a href="SSTableIdentityIterator.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><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>   <div class="header"> <div class="subTitle">org.apache.cassandra.io.sstable</div> <h2 title="Class SSTableIdentityIterator" class="title">Class SSTableIdentityIterator</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.io.sstable.SSTableIdentityIterator</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.lang.Comparable<<a href="../../../../../org/apache/cassandra/io/sstable/SSTableIdentityIterator.html" title="class in org.apache.cassandra.io.sstable">SSTableIdentityIterator</a>>, 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">SSTableIdentityIterator</span> extends java.lang.Object implements java.lang.Comparable<<a href="../../../../../org/apache/cassandra/io/sstable/SSTableIdentityIterator.html" title="class in org.apache.cassandra.io.sstable">SSTableIdentityIterator</a>>, <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">  <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>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableIdentityIterator.html#dataSize">dataSize</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/ColumnSerializer.Flag.html" title="enum in org.apache.cassandra.db">ColumnSerializer.Flag</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableIdentityIterator.html#flag">flag</a></strong></code> </td> </tr> </table> </li> </ul>  <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/io/sstable/SSTableIdentityIterator.html#SSTableIdentityIterator(org.apache.cassandra.io.sstable.SSTableReader,%20org.apache.cassandra.io.util.RandomAccessReader,%20org.apache.cassandra.db.DecoratedKey,%20long)">SSTableIdentityIterator</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/RandomAccessReader.html" title="class in org.apache.cassandra.io.util">RandomAccessReader</a> file, <a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key, long dataSize)</code> <div class="block">Used to iterate through the columns of a row.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableIdentityIterator.html#SSTableIdentityIterator(org.apache.cassandra.io.sstable.SSTableReader,%20org.apache.cassandra.io.util.RandomAccessReader,%20org.apache.cassandra.db.DecoratedKey,%20long,%20boolean)">SSTableIdentityIterator</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/RandomAccessReader.html" title="class in org.apache.cassandra.io.util">RandomAccessReader</a> file, <a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key, long dataSize, boolean checkData)</code> <div class="block">Used to iterate through the columns of a row.</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/io/sstable/SSTableIdentityIterator.html#close()">close</a></strong>()</code> <div class="block">clean up any open resources</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableIdentityIterator.html#compareTo(org.apache.cassandra.io.sstable.SSTableIdentityIterator)">compareTo</a></strong>(<a href="../../../../../org/apache/cassandra/io/sstable/SSTableIdentityIterator.html" title="class in org.apache.cassandra.io.sstable">SSTableIdentityIterator</a> o)</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/io/sstable/SSTableIdentityIterator.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/io/sstable/SSTableIdentityIterator.html#getKey()">getKey</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableIdentityIterator.html#getPath()">getPath</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/io/sstable/SSTableIdentityIterator.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/io/sstable/SSTableIdentityIterator.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/io/sstable/SSTableIdentityIterator.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="field_detail">  </a> <h3>Field Detail</h3> <a name="dataSize">  </a> <ul class="blockList"> <li class="blockList"> <h4>dataSize</h4> <pre>public final long dataSize</pre> </li> </ul> <a name="flag">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>flag</h4> <pre>public final <a href="../../../../../org/apache/cassandra/db/ColumnSerializer.Flag.html" title="enum in org.apache.cassandra.db">ColumnSerializer.Flag</a> flag</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="SSTableIdentityIterator(org.apache.cassandra.io.sstable.SSTableReader, org.apache.cassandra.io.util.RandomAccessReader, org.apache.cassandra.db.DecoratedKey, long)">  </a> <ul class="blockList"> <li class="blockList"> <h4>SSTableIdentityIterator</h4> <pre>public SSTableIdentityIterator(<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/RandomAccessReader.html" title="class in org.apache.cassandra.io.util">RandomAccessReader</a> file, <a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key, long dataSize)</pre> <div class="block">Used to iterate through the columns of a row.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sstable</code> - SSTable we are reading ffrom.</dd><dd><code>file</code> - Reading using this file.</dd><dd><code>key</code> - Key of this row.</dd><dd><code>dataSize</code> - length of row data</dd></dl> </li> </ul> <a name="SSTableIdentityIterator(org.apache.cassandra.io.sstable.SSTableReader, org.apache.cassandra.io.util.RandomAccessReader, org.apache.cassandra.db.DecoratedKey, long, boolean)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>SSTableIdentityIterator</h4> <pre>public SSTableIdentityIterator(<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/RandomAccessReader.html" title="class in org.apache.cassandra.io.util">RandomAccessReader</a> file, <a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key, long dataSize, boolean checkData)</pre> <div class="block">Used to iterate through the columns of a row.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sstable</code> - SSTable we are reading ffrom.</dd><dd><code>file</code> - Reading using this file.</dd><dd><code>key</code> - Key of this row.</dd><dd><code>dataSize</code> - length of row data</dd><dd><code>checkData</code> - if true, do its best to deserialize and check the coherence of row data</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="blockList"> <li class="blockList"> <h4>close</h4> <pre>public void close()</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> </dl> </li> </ul> <a name="getPath()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getPath</h4> <pre>public java.lang.String getPath()</pre> </li> </ul> <a name="compareTo(org.apache.cassandra.io.sstable.SSTableIdentityIterator)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>compareTo</h4> <pre>public int compareTo(<a href="../../../../../org/apache/cassandra/io/sstable/SSTableIdentityIterator.html" title="class in org.apache.cassandra.io.sstable">SSTableIdentityIterator</a> o)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../../../org/apache/cassandra/io/sstable/SSTableIdentityIterator.html" title="class in org.apache.cassandra.io.sstable">SSTableIdentityIterator</a>></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/SSTableIdentityIterator.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/io/sstable/SSTableDeletingTask.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/io/sstable/SSTableLoader.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/io/sstable/SSTableIdentityIterator.html" target="_top">Frames</a></li> <li><a href="SSTableIdentityIterator.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><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>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>