cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
416 lines (413 loc) • 20 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>Composite (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="Composite (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/Composite.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/composites/CellNameType.Deserializer.html" title="interface in org.apache.cassandra.db.composites"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/db/composites/Composite.EOC.html" title="enum in org.apache.cassandra.db.composites"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/db/composites/Composite.html" target="_top">Frames</a></li>
<li><a href="Composite.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><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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.composites</div>
<h2 title="Interface Composite" class="title">Interface Composite</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/cassandra/cache/IMeasurableMemory.html" title="interface in org.apache.cassandra.cache">IMeasurableMemory</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html" title="class in org.apache.cassandra.db.composites">AbstractComposite</a>, <a href="../../../../../org/apache/cassandra/db/AbstractNativeCell.html" title="class in org.apache.cassandra.db">AbstractNativeCell</a>, <a href="../../../../../org/apache/cassandra/db/composites/BoundedComposite.html" title="class in org.apache.cassandra.db.composites">BoundedComposite</a>, <a href="../../../../../org/apache/cassandra/db/composites/CompoundComposite.html" title="class in org.apache.cassandra.db.composites">CompoundComposite</a>, <a href="../../../../../org/apache/cassandra/db/composites/CompoundDenseCellName.html" title="class in org.apache.cassandra.db.composites">CompoundDenseCellName</a>, <a href="../../../../../org/apache/cassandra/db/composites/CompoundSparseCellName.html" title="class in org.apache.cassandra.db.composites">CompoundSparseCellName</a>, <a href="../../../../../org/apache/cassandra/db/composites/CompoundSparseCellName.WithCollection.html" title="class in org.apache.cassandra.db.composites">CompoundSparseCellName.WithCollection</a>, <a href="../../../../../org/apache/cassandra/db/NativeCell.html" title="class in org.apache.cassandra.db">NativeCell</a>, <a href="../../../../../org/apache/cassandra/db/NativeCounterCell.html" title="class in org.apache.cassandra.db">NativeCounterCell</a>, <a href="../../../../../org/apache/cassandra/db/NativeDeletedCell.html" title="class in org.apache.cassandra.db">NativeDeletedCell</a>, <a href="../../../../../org/apache/cassandra/db/NativeExpiringCell.html" title="class in org.apache.cassandra.db">NativeExpiringCell</a>, <a href="../../../../../org/apache/cassandra/db/composites/SimpleComposite.html" title="class in org.apache.cassandra.db.composites">SimpleComposite</a>, <a href="../../../../../org/apache/cassandra/db/composites/SimpleDenseCellName.html" title="class in org.apache.cassandra.db.composites">SimpleDenseCellName</a>, <a href="../../../../../org/apache/cassandra/db/composites/SimpleSparseCellName.html" title="class in org.apache.cassandra.db.composites">SimpleSparseCellName</a>, <a href="../../../../../org/apache/cassandra/db/composites/SimpleSparseInternedCellName.html" title="class in org.apache.cassandra.db.composites">SimpleSparseInternedCellName</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Composite</span>
extends <a href="../../../../../org/apache/cassandra/cache/IMeasurableMemory.html" title="interface in org.apache.cassandra.cache">IMeasurableMemory</a></pre>
<div class="block">A composite value.
This can be though as a list of ByteBuffer, except that this also include an
'end-of-component' flag, that allow precise selection of composite ranges.
We also make a difference between "true" composites and the "simple" ones. The
non-truly composite will have a size() == 1 but differs from true composites with
size() == 1 in the way they are stored. Most code shouldn't have to care about the
difference.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/Composite.EOC.html" title="enum in org.apache.cassandra.db.composites">Composite.EOC</a></strong></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><a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#copy(org.apache.cassandra.config.CFMetaData,%20org.apache.cassandra.utils.memory.AbstractAllocator)">copy</a></strong>(<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> cfm,
<a href="../../../../../org/apache/cassandra/utils/memory/AbstractAllocator.html" title="class in org.apache.cassandra.utils.memory">AbstractAllocator</a> allocator)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#dataSize()">dataSize</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#end()">end</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/composites/Composite.EOC.html" title="enum in org.apache.cassandra.db.composites">Composite.EOC</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#eoc()">eoc</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.nio.ByteBuffer</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#get(int)">get</a></strong>(int i)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#isEmpty()">isEmpty</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#isPrefixOf(org.apache.cassandra.db.composites.CType,%20org.apache.cassandra.db.composites.Composite)">isPrefixOf</a></strong>(<a href="../../../../../org/apache/cassandra/db/composites/CType.html" title="interface in org.apache.cassandra.db.composites">CType</a> type,
<a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a> other)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#isStatic()">isStatic</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/composites/Composite.html#size()">size</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/filter/ColumnSlice.html" title="class in org.apache.cassandra.db.filter">ColumnSlice</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#slice()">slice</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#start()">start</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.nio.ByteBuffer</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#toByteBuffer()">toByteBuffer</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#withEOC(org.apache.cassandra.db.composites.Composite.EOC)">withEOC</a></strong>(<a href="../../../../../org/apache/cassandra/db/composites/Composite.EOC.html" title="enum in org.apache.cassandra.db.composites">Composite.EOC</a> eoc)</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.cache.IMeasurableMemory">
<!-- -->
</a>
<h3>Methods inherited from interface org.apache.cassandra.cache.<a href="../../../../../org/apache/cassandra/cache/IMeasurableMemory.html" title="interface in org.apache.cassandra.cache">IMeasurableMemory</a></h3>
<code><a href="../../../../../org/apache/cassandra/cache/IMeasurableMemory.html#unsharedHeapSize()">unsharedHeapSize</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>int size()</pre>
</li>
</ul>
<a name="isEmpty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre>boolean isEmpty()</pre>
</li>
</ul>
<a name="get(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>java.nio.ByteBuffer get(int i)</pre>
</li>
</ul>
<a name="eoc()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>eoc</h4>
<pre><a href="../../../../../org/apache/cassandra/db/composites/Composite.EOC.html" title="enum in org.apache.cassandra.db.composites">Composite.EOC</a> eoc()</pre>
</li>
</ul>
<a name="withEOC(org.apache.cassandra.db.composites.Composite.EOC)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withEOC</h4>
<pre><a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a> withEOC(<a href="../../../../../org/apache/cassandra/db/composites/Composite.EOC.html" title="enum in org.apache.cassandra.db.composites">Composite.EOC</a> eoc)</pre>
</li>
</ul>
<a name="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre><a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a> start()</pre>
</li>
</ul>
<a name="end()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>end</h4>
<pre><a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a> end()</pre>
</li>
</ul>
<a name="slice()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>slice</h4>
<pre><a href="../../../../../org/apache/cassandra/db/filter/ColumnSlice.html" title="class in org.apache.cassandra.db.filter">ColumnSlice</a> slice()</pre>
</li>
</ul>
<a name="isStatic()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStatic</h4>
<pre>boolean isStatic()</pre>
</li>
</ul>
<a name="isPrefixOf(org.apache.cassandra.db.composites.CType, org.apache.cassandra.db.composites.Composite)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPrefixOf</h4>
<pre>boolean isPrefixOf(<a href="../../../../../org/apache/cassandra/db/composites/CType.html" title="interface in org.apache.cassandra.db.composites">CType</a> type,
<a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a> other)</pre>
</li>
</ul>
<a name="toByteBuffer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toByteBuffer</h4>
<pre>java.nio.ByteBuffer toByteBuffer()</pre>
</li>
</ul>
<a name="dataSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dataSize</h4>
<pre>int dataSize()</pre>
</li>
</ul>
<a name="copy(org.apache.cassandra.config.CFMetaData, org.apache.cassandra.utils.memory.AbstractAllocator)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>copy</h4>
<pre><a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a> copy(<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> cfm,
<a href="../../../../../org/apache/cassandra/utils/memory/AbstractAllocator.html" title="class in org.apache.cassandra.utils.memory">AbstractAllocator</a> allocator)</pre>
</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/Composite.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/composites/CellNameType.Deserializer.html" title="interface in org.apache.cassandra.db.composites"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/db/composites/Composite.EOC.html" title="enum in org.apache.cassandra.db.composites"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/db/composites/Composite.html" target="_top">Frames</a></li>
<li><a href="Composite.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><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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>