UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

378 lines (377 loc) 17.7 kB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:30 CEST 2014 --> <title>SimpleComposite (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="SimpleComposite (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/SimpleComposite.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/CType.Serializer.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/SimpleCType.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/SimpleComposite.html" target="_top">Frames</a></li> <li><a href="SimpleComposite.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:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</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="Class SimpleComposite" class="title">Class SimpleComposite</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html" title="class in org.apache.cassandra.db.composites">org.apache.cassandra.db.composites.AbstractComposite</a></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.db.composites.SimpleComposite</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="../../../../../org/apache/cassandra/cache/IMeasurableMemory.html" title="interface in org.apache.cassandra.cache">IMeasurableMemory</a>, <a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a></dd> </dl> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../../../org/apache/cassandra/db/composites/SimpleDenseCellName.html" title="class in org.apache.cassandra.db.composites">SimpleDenseCellName</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">SimpleComposite</span> extends <a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html" title="class in org.apache.cassandra.db.composites">AbstractComposite</a></pre> <div class="block">A "simple" (not-truly-composite) Composite.</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&nbsp;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> <!-- =========== FIELD SUMMARY =========== --> <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">&nbsp;</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>protected java.nio.ByteBuffer</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/SimpleComposite.html#element">element</a></strong></code>&nbsp;</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">&nbsp;</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/SimpleComposite.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>&nbsp;cfm, <a href="../../../../../org/apache/cassandra/utils/memory/AbstractAllocator.html" title="class in org.apache.cassandra.utils.memory">AbstractAllocator</a>&nbsp;allocator)</code>&nbsp;</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/SimpleComposite.html#get(int)">get</a></strong>(int&nbsp;i)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/SimpleComposite.html#size()">size</a></strong>()</code>&nbsp;</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/SimpleComposite.html#toByteBuffer()">toByteBuffer</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/composites/SimpleComposite.html#unsharedHeapSize()">unsharedHeapSize</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <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/SimpleComposite.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>&nbsp;newEoc)</code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.db.composites.AbstractComposite"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.db.composites.<a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html" title="class in org.apache.cassandra.db.composites">AbstractComposite</a></h3> <code><a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html#dataSize()">dataSize</a>, <a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html#end()">end</a>, <a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html#eoc()">eoc</a>, <a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html#equals(java.lang.Object)">equals</a>, <a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html#hashCode()">hashCode</a>, <a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html#isEmpty()">isEmpty</a>, <a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html#isPrefixOf(org.apache.cassandra.db.composites.CType,%20org.apache.cassandra.db.composites.Composite)">isPrefixOf</a>, <a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html#isStatic()">isStatic</a>, <a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html#slice()">slice</a>, <a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html#start()">start</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class&nbsp;java.lang.Object</h3> <code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field_detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="element"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>element</h4> <pre>protected final&nbsp;java.nio.ByteBuffer element</pre> </li> </ul> </li> </ul> <!-- ============ 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>public&nbsp;int&nbsp;size()</pre> </li> </ul> <a name="get(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>get</h4> <pre>public&nbsp;java.nio.ByteBuffer&nbsp;get(int&nbsp;i)</pre> </li> </ul> <a name="withEOC(org.apache.cassandra.db.composites.Composite.EOC)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>withEOC</h4> <pre>public&nbsp;<a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a>&nbsp;withEOC(<a href="../../../../../org/apache/cassandra/db/composites/Composite.EOC.html" title="enum in org.apache.cassandra.db.composites">Composite.EOC</a>&nbsp;newEoc)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#withEOC(org.apache.cassandra.db.composites.Composite.EOC)">withEOC</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a></code></dd> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html#withEOC(org.apache.cassandra.db.composites.Composite.EOC)">withEOC</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html" title="class in org.apache.cassandra.db.composites">AbstractComposite</a></code></dd> </dl> </li> </ul> <a name="toByteBuffer()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toByteBuffer</h4> <pre>public&nbsp;java.nio.ByteBuffer&nbsp;toByteBuffer()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/composites/Composite.html#toByteBuffer()">toByteBuffer</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a></code></dd> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html#toByteBuffer()">toByteBuffer</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cassandra/db/composites/AbstractComposite.html" title="class in org.apache.cassandra.db.composites">AbstractComposite</a></code></dd> </dl> </li> </ul> <a name="unsharedHeapSize()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>unsharedHeapSize</h4> <pre>public&nbsp;long&nbsp;unsharedHeapSize()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>the amount of on-heap memory retained by the object that might be reclaimed if the object were reclaimed, i.e. it should try to exclude globally cached data where possible, or counting portions of arrays that are referenced by the object but used by other objects only (e.g. slabbed byte-buffers), etc.</dd></dl> </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>public&nbsp;<a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a>&nbsp;copy(<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a>&nbsp;cfm, <a href="../../../../../org/apache/cassandra/utils/memory/AbstractAllocator.html" title="class in org.apache.cassandra.utils.memory">AbstractAllocator</a>&nbsp;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/SimpleComposite.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/CType.Serializer.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/SimpleCType.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/SimpleComposite.html" target="_top">Frames</a></li> <li><a href="SimpleComposite.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:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</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 &copy; 2014 The Apache Software Foundation</small></p> </body> </html>