cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
360 lines (357 loc) • 14.2 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:27 CEST 2014 -->
<title>AtomDeserializer (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="AtomDeserializer (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/AtomDeserializer.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/ArrayBackedSortedColumns.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/db/AtomicBTreeColumns.html" title="class in org.apache.cassandra.db"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/db/AtomDeserializer.html" target="_top">Frames</a></li>
<li><a href="AtomDeserializer.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>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>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cassandra.db</div>
<h2 title="Class AtomDeserializer" class="title">Class AtomDeserializer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.db.AtomDeserializer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">AtomDeserializer</span>
extends java.lang.Object</pre>
<div class="block">Helper class to deserialize OnDiskAtom efficiently.
More precisely, this class is used by the low-level readers
(IndexedSliceReader and SSTableNamesIterator) to ensure we don't
do more work than necessary (i.e. we don't allocate/deserialize
objects for things we don't care about).</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/AtomDeserializer.html#AtomDeserializer(org.apache.cassandra.db.composites.CellNameType,%20java.io.DataInput,%20org.apache.cassandra.db.ColumnSerializer.Flag,%20int,%20org.apache.cassandra.io.sstable.Descriptor.Version)">AtomDeserializer</a></strong>(<a href="../../../../org/apache/cassandra/db/composites/CellNameType.html" title="interface in org.apache.cassandra.db.composites">CellNameType</a> type,
java.io.DataInput in,
<a href="../../../../org/apache/cassandra/db/ColumnSerializer.Flag.html" title="enum in org.apache.cassandra.db">ColumnSerializer.Flag</a> flag,
int expireBefore,
<a href="../../../../org/apache/cassandra/io/sstable/Descriptor.Version.html" title="class in org.apache.cassandra.io.sstable">Descriptor.Version</a> version)</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>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AtomDeserializer.html#compareNextTo(org.apache.cassandra.db.composites.Composite)">compareNextTo</a></strong>(<a href="../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a> composite)</code>
<div class="block">Compare the provided composite to the next atom to read on disk.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AtomDeserializer.html#hasNext()">hasNext</a></strong>()</code>
<div class="block">Whether or not there is more atom to read.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AtomDeserializer.html#hasUnprocessed()">hasUnprocessed</a></strong>()</code>
<div class="block">Whether or not some atom has been read but not processed (neither readNext() nor
skipNext() has been called for that atom) yet.</div>
</td>
</tr>
<tr class="rowColor">
<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/AtomDeserializer.html#readNext()">readNext</a></strong>()</code>
<div class="block">Returns the next atom.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AtomDeserializer.html#skipNext()">skipNext</a></strong>()</code>
<div class="block">Skips the next atom.</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 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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AtomDeserializer(org.apache.cassandra.db.composites.CellNameType, java.io.DataInput, org.apache.cassandra.db.ColumnSerializer.Flag, int, org.apache.cassandra.io.sstable.Descriptor.Version)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AtomDeserializer</h4>
<pre>public AtomDeserializer(<a href="../../../../org/apache/cassandra/db/composites/CellNameType.html" title="interface in org.apache.cassandra.db.composites">CellNameType</a> type,
java.io.DataInput in,
<a href="../../../../org/apache/cassandra/db/ColumnSerializer.Flag.html" title="enum in org.apache.cassandra.db">ColumnSerializer.Flag</a> flag,
int expireBefore,
<a href="../../../../org/apache/cassandra/io/sstable/Descriptor.Version.html" title="class in org.apache.cassandra.io.sstable">Descriptor.Version</a> version)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="hasNext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasNext</h4>
<pre>public boolean hasNext()
throws java.io.IOException</pre>
<div class="block">Whether or not there is more atom to read.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="hasUnprocessed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasUnprocessed</h4>
<pre>public boolean hasUnprocessed()
throws java.io.IOException</pre>
<div class="block">Whether or not some atom has been read but not processed (neither readNext() nor
skipNext() has been called for that atom) yet.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="compareNextTo(org.apache.cassandra.db.composites.Composite)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareNextTo</h4>
<pre>public int compareNextTo(<a href="../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a> composite)
throws java.io.IOException</pre>
<div class="block">Compare the provided composite to the next atom to read on disk.
This will not read/deserialize the whole atom but only what is necessary for the
comparison. Whenever we know what to do with this atom (read it or skip it),
readNext or skipNext should be called.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="readNext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readNext</h4>
<pre>public <a href="../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a> readNext()
throws java.io.IOException</pre>
<div class="block">Returns the next atom.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="skipNext()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>skipNext</h4>
<pre>public void skipNext()
throws java.io.IOException</pre>
<div class="block">Skips the next atom.</div>
<dl><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/AtomDeserializer.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/ArrayBackedSortedColumns.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/db/AtomicBTreeColumns.html" title="class in org.apache.cassandra.db"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/db/AtomDeserializer.html" target="_top">Frames</a></li>
<li><a href="AtomDeserializer.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>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>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p>
</body>
</html>