cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
373 lines (372 loc) • 15.8 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:28 CEST 2014 -->
<title>ColumnIndex.Builder (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="ColumnIndex.Builder (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/ColumnIndex.Builder.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/ColumnIndex.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/db/ColumnSerializer.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/ColumnIndex.Builder.html" target="_top">Frames</a></li>
<li><a href="ColumnIndex.Builder.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 ColumnIndex.Builder" class="title">Class ColumnIndex.Builder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.db.ColumnIndex.Builder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../org/apache/cassandra/db/ColumnIndex.html" title="class in org.apache.cassandra.db">ColumnIndex</a></dd>
</dl>
<hr>
<br>
<pre>public static class <span class="strong">ColumnIndex.Builder</span>
extends java.lang.Object</pre>
<div class="block">Help to create an index for a column family based on size of columns,
and write said columns to disk.</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/ColumnIndex.Builder.html#ColumnIndex.Builder(org.apache.cassandra.db.ColumnFamily,%20java.nio.ByteBuffer,%20org.apache.cassandra.io.util.DataOutputPlus)">ColumnIndex.Builder</a></strong>(<a href="../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf,
java.nio.ByteBuffer key,
<a href="../../../../org/apache/cassandra/io/util/DataOutputPlus.html" title="interface in org.apache.cassandra.io.util">DataOutputPlus</a> output)</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/ColumnIndex.Builder.html#add(org.apache.cassandra.db.OnDiskAtom)">add</a></strong>(<a href="../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a> column)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/ColumnIndex.html" title="class in org.apache.cassandra.db">ColumnIndex</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/ColumnIndex.Builder.html#build()">build</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/ColumnIndex.html" title="class in org.apache.cassandra.db">ColumnIndex</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/ColumnIndex.Builder.html#build(org.apache.cassandra.db.ColumnFamily)">build</a></strong>(<a href="../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf)</code>
<div class="block">Serializes the index into in-memory structure with all required components
such as Bloom Filter, index block size, IndexInfo list</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/ColumnIndex.html" title="class in org.apache.cassandra.db">ColumnIndex</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/ColumnIndex.Builder.html#buildForCompaction(java.util.Iterator)">buildForCompaction</a></strong>(java.util.Iterator<<a href="../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a>> columns)</code>
<div class="block">The important distinction wrt build() is that we may be building for a row that ends up
being compacted away entirely, i.e., the input consists only of expired tombstones (or
columns shadowed by expired tombstone).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/ColumnIndex.Builder.html#maybeWriteEmptyRowHeader()">maybeWriteEmptyRowHeader</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/RangeTombstone.Tracker.html" title="class in org.apache.cassandra.db">RangeTombstone.Tracker</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/ColumnIndex.Builder.html#tombstoneTracker()">tombstoneTracker</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/ColumnIndex.Builder.html#writtenAtomCount()">writtenAtomCount</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ColumnIndex.Builder(org.apache.cassandra.db.ColumnFamily, java.nio.ByteBuffer, org.apache.cassandra.io.util.DataOutputPlus)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ColumnIndex.Builder</h4>
<pre>public ColumnIndex.Builder(<a href="../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf,
java.nio.ByteBuffer key,
<a href="../../../../org/apache/cassandra/io/util/DataOutputPlus.html" title="interface in org.apache.cassandra.io.util">DataOutputPlus</a> output)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="tombstoneTracker()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tombstoneTracker</h4>
<pre>public <a href="../../../../org/apache/cassandra/db/RangeTombstone.Tracker.html" title="class in org.apache.cassandra.db">RangeTombstone.Tracker</a> tombstoneTracker()</pre>
</li>
</ul>
<a name="writtenAtomCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writtenAtomCount</h4>
<pre>public int writtenAtomCount()</pre>
</li>
</ul>
<a name="build(org.apache.cassandra.db.ColumnFamily)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public <a href="../../../../org/apache/cassandra/db/ColumnIndex.html" title="class in org.apache.cassandra.db">ColumnIndex</a> build(<a href="../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf)
throws java.io.IOException</pre>
<div class="block">Serializes the index into in-memory structure with all required components
such as Bloom Filter, index block size, IndexInfo list</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cf</code> - Column family to create index for</dd>
<dt><span class="strong">Returns:</span></dt><dd>information about index - it's Bloom Filter, block size and IndexInfo list</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="buildForCompaction(java.util.Iterator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildForCompaction</h4>
<pre>public <a href="../../../../org/apache/cassandra/db/ColumnIndex.html" title="class in org.apache.cassandra.db">ColumnIndex</a> buildForCompaction(java.util.Iterator<<a href="../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a>> columns)
throws java.io.IOException</pre>
<div class="block">The important distinction wrt build() is that we may be building for a row that ends up
being compacted away entirely, i.e., the input consists only of expired tombstones (or
columns shadowed by expired tombstone). Thus, it is the caller's responsibility
to decide whether to write the header for an empty row.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="add(org.apache.cassandra.db.OnDiskAtom)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public void add(<a href="../../../../org/apache/cassandra/db/OnDiskAtom.html" title="interface in org.apache.cassandra.db">OnDiskAtom</a> column)
throws java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="build()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public <a href="../../../../org/apache/cassandra/db/ColumnIndex.html" title="class in org.apache.cassandra.db">ColumnIndex</a> build()</pre>
</li>
</ul>
<a name="maybeWriteEmptyRowHeader()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>maybeWriteEmptyRowHeader</h4>
<pre>public void maybeWriteEmptyRowHeader()
throws java.io.IOException</pre>
<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/ColumnIndex.Builder.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/ColumnIndex.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/db/ColumnSerializer.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/ColumnIndex.Builder.html" target="_top">Frames</a></li>
<li><a href="ColumnIndex.Builder.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>