cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
366 lines (361 loc) • 19.4 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>CellName (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="CellName (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/CellName.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/CBuilder.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/CellNames.html" title="class 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/CellName.html" target="_top">Frames</a></li>
<li><a href="CellName.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>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 CellName" class="title">Interface CellName</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/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a>, <a href="../../../../../org/apache/cassandra/cache/IMeasurableMemory.html" title="interface in org.apache.cassandra.cache">IMeasurableMemory</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/cassandra/db/AbstractNativeCell.html" title="class in org.apache.cassandra.db">AbstractNativeCell</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/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">CellName</span>
extends <a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a></pre>
<div class="block">A CellName is a Composite, but for which, for the sake of CQL3, we
distinguish different parts: a CellName has first a number of clustering
components, followed by the CQL3 column name, and then possibly followed by
a collection element part.
The clustering prefix can itself be composed of multiple component. It can
also be empty if the table has no clustering keys. In general, the CQL3
column name follows. However, some type of COMPACT STORAGE layout do not
store the CQL3 column name in the cell name and so this part can be null (we
call "dense" the cells whose name don't store the CQL3 column name).
Lastly, if the cell is part of a CQL3 collection, we'll have a last
component (a UUID for lists, an element for sets and a key for maps).</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>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.cassandra.db.composites.Composite">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface org.apache.cassandra.db.composites.<a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a></h3>
<code><a href="../../../../../org/apache/cassandra/db/composites/Composite.EOC.html" title="enum in org.apache.cassandra.db.composites">Composite.EOC</a></code></li>
</ul>
</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/composites/CellName.html#clusteringSize()">clusteringSize</a></strong>()</code>
<div class="block">The number of clustering components.</div>
</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/CellName.html#collectionElement()">collectionElement</a></strong>()</code>
<div class="block">The value of the collection element, or null if the cell is not part
of a collection (i.e.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/CellName.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><a href="../../../../../org/apache/cassandra/cql3/ColumnIdentifier.html" title="class in org.apache.cassandra.cql3">ColumnIdentifier</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/CellName.html#cql3ColumnName(org.apache.cassandra.config.CFMetaData)">cql3ColumnName</a></strong>(<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> metadata)</code>
<div class="block">The name of the CQL3 column this cell represents.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/CellName.html#isCollectionCell()">isCollectionCell</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/composites/CellName.html#isSameCQL3RowAs(org.apache.cassandra.db.composites.CellNameType,%20org.apache.cassandra.db.composites.CellName)">isSameCQL3RowAs</a></strong>(<a href="../../../../../org/apache/cassandra/db/composites/CellNameType.html" title="interface in org.apache.cassandra.db.composites">CellNameType</a> type,
<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a> other)</code>
<div class="block">Whether this cell is part of the same CQL3 row as the other cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/CellName.html#unsharedHeapSizeExcludingData()">unsharedHeapSizeExcludingData</a></strong>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.db.composites.Composite">
<!-- -->
</a>
<h3>Methods inherited from interface org.apache.cassandra.db.composites.<a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a></h3>
<code><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#dataSize()">dataSize</a>, <a href="../../../../../org/apache/cassandra/db/composites/Composite.html#end()">end</a>, <a href="../../../../../org/apache/cassandra/db/composites/Composite.html#eoc()">eoc</a>, <a href="../../../../../org/apache/cassandra/db/composites/Composite.html#get(int)">get</a>, <a href="../../../../../org/apache/cassandra/db/composites/Composite.html#isEmpty()">isEmpty</a>, <a href="../../../../../org/apache/cassandra/db/composites/Composite.html#isPrefixOf(org.apache.cassandra.db.composites.CType,%20org.apache.cassandra.db.composites.Composite)">isPrefixOf</a>, <a href="../../../../../org/apache/cassandra/db/composites/Composite.html#isStatic()">isStatic</a>, <a href="../../../../../org/apache/cassandra/db/composites/Composite.html#size()">size</a>, <a href="../../../../../org/apache/cassandra/db/composites/Composite.html#slice()">slice</a>, <a href="../../../../../org/apache/cassandra/db/composites/Composite.html#start()">start</a>, <a href="../../../../../org/apache/cassandra/db/composites/Composite.html#toByteBuffer()">toByteBuffer</a>, <a href="../../../../../org/apache/cassandra/db/composites/Composite.html#withEOC(org.apache.cassandra.db.composites.Composite.EOC)">withEOC</a></code></li>
</ul>
<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="clusteringSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clusteringSize</h4>
<pre>int clusteringSize()</pre>
<div class="block">The number of clustering components.
It can be 0 if the table has no clustering columns, and it can be
equal to size() if the table is dense() (in which case cql3ColumnName()
will be null).</div>
</li>
</ul>
<a name="cql3ColumnName(org.apache.cassandra.config.CFMetaData)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cql3ColumnName</h4>
<pre><a href="../../../../../org/apache/cassandra/cql3/ColumnIdentifier.html" title="class in org.apache.cassandra.cql3">ColumnIdentifier</a> cql3ColumnName(<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> metadata)</pre>
<div class="block">The name of the CQL3 column this cell represents.
Will be null for cells of "dense" tables.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>metadata</code> - </dd></dl>
</li>
</ul>
<a name="collectionElement()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectionElement</h4>
<pre>java.nio.ByteBuffer collectionElement()</pre>
<div class="block">The value of the collection element, or null if the cell is not part
of a collection (i.e. if !isCollectionCell()).</div>
</li>
</ul>
<a name="isCollectionCell()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCollectionCell</h4>
<pre>boolean isCollectionCell()</pre>
</li>
</ul>
<a name="isSameCQL3RowAs(org.apache.cassandra.db.composites.CellNameType, org.apache.cassandra.db.composites.CellName)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSameCQL3RowAs</h4>
<pre>boolean isSameCQL3RowAs(<a href="../../../../../org/apache/cassandra/db/composites/CellNameType.html" title="interface in org.apache.cassandra.db.composites">CellNameType</a> type,
<a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a> other)</pre>
<div class="block">Whether this cell is part of the same CQL3 row as the other cell.</div>
</li>
</ul>
<a name="copy(org.apache.cassandra.config.CFMetaData, org.apache.cassandra.utils.memory.AbstractAllocator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre><a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</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>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#copy(org.apache.cassandra.config.CFMetaData,%20org.apache.cassandra.utils.memory.AbstractAllocator)">copy</a></code> in interface <code><a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a></code></dd>
</dl>
</li>
</ul>
<a name="unsharedHeapSizeExcludingData()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>unsharedHeapSizeExcludingData</h4>
<pre>long unsharedHeapSizeExcludingData()</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/CellName.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/CBuilder.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/CellNames.html" title="class 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/CellName.html" target="_top">Frames</a></li>
<li><a href="CellName.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>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>