UNPKG

cassandra-server

Version:

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

398 lines (397 loc) 19.4 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:31 CEST 2014 --> <title>Selection (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="Selection (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/Selection.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/cql3/statements/Selectable.WritetimeOrTTL.html" title="class in org.apache.cassandra.cql3.statements"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/cql3/statements/Selection.ResultSetBuilder.html" title="class in org.apache.cassandra.cql3.statements"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/cql3/statements/Selection.html" target="_top">Frames</a></li> <li><a href="Selection.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><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&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.cql3.statements</div> <h2 title="Class Selection" class="title">Class Selection</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.cql3.statements.Selection</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public abstract class <span class="strong">Selection</span> extends java.lang.Object</pre> </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">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Class and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>class&nbsp;</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Selection.ResultSetBuilder.html" title="class in org.apache.cassandra.cql3.statements">Selection.ResultSetBuilder</a></strong></code>&nbsp;</td> </tr> </table> </li> </ul> <!-- ======== 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">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier</th> <th class="colLast" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected </code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html#Selection(java.util.Collection,%20java.util.List,%20boolean,%20boolean)">Selection</a></strong>(java.util.Collection&lt;<a href="../../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a>&gt;&nbsp;columns, java.util.List&lt;<a href="../../../../../org/apache/cassandra/cql3/ColumnSpecification.html" title="class in org.apache.cassandra.cql3">ColumnSpecification</a>&gt;&nbsp;metadata, boolean&nbsp;collectTimestamps, boolean&nbsp;collectTTLs)</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>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html#addColumnForOrdering(org.apache.cassandra.config.ColumnDefinition)">addColumnForOrdering</a></strong>(<a href="../../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a>&nbsp;c)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html" title="class in org.apache.cassandra.cql3.statements">Selection</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html#forColumns(java.util.Collection)">forColumns</a></strong>(java.util.Collection&lt;<a href="../../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a>&gt;&nbsp;columns)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html" title="class in org.apache.cassandra.cql3.statements">Selection</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html#fromSelectors(org.apache.cassandra.config.CFMetaData,%20java.util.List)">fromSelectors</a></strong>(<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a>&nbsp;cfm, java.util.List&lt;<a href="../../../../../org/apache/cassandra/cql3/statements/RawSelector.html" title="class in org.apache.cassandra.cql3.statements">RawSelector</a>&gt;&nbsp;rawSelectors)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Collection&lt;<a href="../../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html#getColumns()">getColumns</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/cql3/ResultSet.Metadata.html" title="class in org.apache.cassandra.cql3">ResultSet.Metadata</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html#getResultMetadata()">getResultMetadata</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected abstract java.util.List&lt;java.nio.ByteBuffer&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html#handleRow(org.apache.cassandra.cql3.statements.Selection.ResultSetBuilder)">handleRow</a></strong>(<a href="../../../../../org/apache/cassandra/cql3/statements/Selection.ResultSetBuilder.html" title="class in org.apache.cassandra.cql3.statements">Selection.ResultSetBuilder</a>&nbsp;rs)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html#isWildcard()">isWildcard</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/cql3/statements/Selection.ResultSetBuilder.html" title="class in org.apache.cassandra.cql3.statements">Selection.ResultSetBuilder</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html#resultSetBuilder(long)">resultSetBuilder</a></strong>(long&nbsp;now)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html" title="class in org.apache.cassandra.cql3.statements">Selection</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html#wildcard(org.apache.cassandra.config.CFMetaData)">wildcard</a></strong>(<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a>&nbsp;cfm)</code>&nbsp;</td> </tr> </table> <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, 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="Selection(java.util.Collection, java.util.List, boolean, boolean)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Selection</h4> <pre>protected&nbsp;Selection(java.util.Collection&lt;<a href="../../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a>&gt;&nbsp;columns, java.util.List&lt;<a href="../../../../../org/apache/cassandra/cql3/ColumnSpecification.html" title="class in org.apache.cassandra.cql3">ColumnSpecification</a>&gt;&nbsp;metadata, boolean&nbsp;collectTimestamps, boolean&nbsp;collectTTLs)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="isWildcard()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isWildcard</h4> <pre>public&nbsp;boolean&nbsp;isWildcard()</pre> </li> </ul> <a name="getResultMetadata()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getResultMetadata</h4> <pre>public&nbsp;<a href="../../../../../org/apache/cassandra/cql3/ResultSet.Metadata.html" title="class in org.apache.cassandra.cql3">ResultSet.Metadata</a>&nbsp;getResultMetadata()</pre> </li> </ul> <a name="wildcard(org.apache.cassandra.config.CFMetaData)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>wildcard</h4> <pre>public static&nbsp;<a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html" title="class in org.apache.cassandra.cql3.statements">Selection</a>&nbsp;wildcard(<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a>&nbsp;cfm)</pre> </li> </ul> <a name="forColumns(java.util.Collection)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>forColumns</h4> <pre>public static&nbsp;<a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html" title="class in org.apache.cassandra.cql3.statements">Selection</a>&nbsp;forColumns(java.util.Collection&lt;<a href="../../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a>&gt;&nbsp;columns)</pre> </li> </ul> <a name="addColumnForOrdering(org.apache.cassandra.config.ColumnDefinition)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>addColumnForOrdering</h4> <pre>public&nbsp;int&nbsp;addColumnForOrdering(<a href="../../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a>&nbsp;c)</pre> </li> </ul> <a name="fromSelectors(org.apache.cassandra.config.CFMetaData, java.util.List)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>fromSelectors</h4> <pre>public static&nbsp;<a href="../../../../../org/apache/cassandra/cql3/statements/Selection.html" title="class in org.apache.cassandra.cql3.statements">Selection</a>&nbsp;fromSelectors(<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a>&nbsp;cfm, java.util.List&lt;<a href="../../../../../org/apache/cassandra/cql3/statements/RawSelector.html" title="class in org.apache.cassandra.cql3.statements">RawSelector</a>&gt;&nbsp;rawSelectors) throws <a href="../../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></code></dd></dl> </li> </ul> <a name="handleRow(org.apache.cassandra.cql3.statements.Selection.ResultSetBuilder)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>handleRow</h4> <pre>protected abstract&nbsp;java.util.List&lt;java.nio.ByteBuffer&gt;&nbsp;handleRow(<a href="../../../../../org/apache/cassandra/cql3/statements/Selection.ResultSetBuilder.html" title="class in org.apache.cassandra.cql3.statements">Selection.ResultSetBuilder</a>&nbsp;rs) throws <a href="../../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></code></dd></dl> </li> </ul> <a name="getColumns()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getColumns</h4> <pre>public&nbsp;java.util.Collection&lt;<a href="../../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a>&gt;&nbsp;getColumns()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>the list of CQL3 columns value this SelectionClause needs.</dd></dl> </li> </ul> <a name="resultSetBuilder(long)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>resultSetBuilder</h4> <pre>public&nbsp;<a href="../../../../../org/apache/cassandra/cql3/statements/Selection.ResultSetBuilder.html" title="class in org.apache.cassandra.cql3.statements">Selection.ResultSetBuilder</a>&nbsp;resultSetBuilder(long&nbsp;now)</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/Selection.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/cql3/statements/Selectable.WritetimeOrTTL.html" title="class in org.apache.cassandra.cql3.statements"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/cql3/statements/Selection.ResultSetBuilder.html" title="class in org.apache.cassandra.cql3.statements"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/cql3/statements/Selection.html" target="_top">Frames</a></li> <li><a href="Selection.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><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&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>