cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
502 lines (500 loc) • 19.6 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:32 CEST 2014 -->
<title>SelectExpression (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="SelectExpression (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/SelectExpression.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/cql/Relation.html" title="class in org.apache.cassandra.cql"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/cql/SelectStatement.html" title="class in org.apache.cassandra.cql"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/cql/SelectExpression.html" target="_top">Frames</a></li>
<li><a href="SelectExpression.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.cql</div>
<h2 title="Class SelectExpression" class="title">Class SelectExpression</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.cql.SelectExpression</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">SelectExpression</span>
extends java.lang.Object</pre>
<div class="block">Select expressions are analogous to the projection in a SQL query. They
determine which columns will appear in the result set. SelectExpression
instances encapsulate a parsed expression from a <code>SELECT</code>
statement.
See: doc/cql/CQL.html#SpecifyingColumns</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== 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"> </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>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/SelectExpression.html#MAX_COLUMNS_DEFAULT">MAX_COLUMNS_DEFAULT</a></strong></code> </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"> </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/cql/SelectExpression.html#SelectExpression(org.apache.cassandra.cql.Term,%20int,%20boolean,%20boolean)">SelectExpression</a></strong>(<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a> first,
int count,
boolean reverse,
boolean firstSet)</code>
<div class="block">Create a new SelectExpression for a list of columns.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/cql/SelectExpression.html#SelectExpression(org.apache.cassandra.cql.Term,%20org.apache.cassandra.cql.Term,%20int,%20boolean,%20boolean,%20boolean)">SelectExpression</a></strong>(<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a> start,
<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a> finish,
int count,
boolean reverse,
boolean wildcard,
boolean firstSet)</code>
<div class="block">Create a new SelectExpression for a range (slice) of columns.</div>
</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/cql/SelectExpression.html#and(org.apache.cassandra.cql.Term)">and</a></strong>(<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a> addTerm)</code>
<div class="block">Add an additional column name to a SelectExpression.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/SelectExpression.html#getColumns()">getColumns</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/cql/SelectExpression.html#getColumnsLimit()">getColumnsLimit</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/SelectExpression.html#getFinish()">getFinish</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/SelectExpression.html#getStart()">getStart</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/cql/SelectExpression.html#hasFirstSet()">hasFirstSet</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/cql/SelectExpression.html#isColumnList()">isColumnList</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/cql/SelectExpression.html#isColumnRange()">isColumnRange</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/cql/SelectExpression.html#isColumnsReversed()">isColumnsReversed</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/cql/SelectExpression.html#isWildcard()">isWildcard</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/SelectExpression.html#setColumnsLimit(int)">setColumnsLimit</a></strong>(int limit)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/SelectExpression.html#setColumnsReversed(boolean)">setColumnsReversed</a></strong>(boolean reversed)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/SelectExpression.html#toString()">toString</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, 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="MAX_COLUMNS_DEFAULT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MAX_COLUMNS_DEFAULT</h4>
<pre>public static final int MAX_COLUMNS_DEFAULT</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.cql.SelectExpression.MAX_COLUMNS_DEFAULT">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SelectExpression(org.apache.cassandra.cql.Term, org.apache.cassandra.cql.Term, int, boolean, boolean, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SelectExpression</h4>
<pre>public SelectExpression(<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a> start,
<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a> finish,
int count,
boolean reverse,
boolean wildcard,
boolean firstSet)</pre>
<div class="block">Create a new SelectExpression for a range (slice) of columns.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - the starting column name</dd><dd><code>finish</code> - the finishing column name</dd><dd><code>count</code> - the number of columns to limit the results to</dd><dd><code>reverse</code> - true to reverse column order</dd><dd><code>wildcard</code> - determines weather this statement is wildcard</dd><dd><code>firstSet</code> - determines weather "FIRST" keyword was set</dd></dl>
</li>
</ul>
<a name="SelectExpression(org.apache.cassandra.cql.Term, int, boolean, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SelectExpression</h4>
<pre>public SelectExpression(<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a> first,
int count,
boolean reverse,
boolean firstSet)</pre>
<div class="block">Create a new SelectExpression for a list of columns.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>first</code> - the first (possibly only) column name to select on.</dd><dd><code>count</code> - the number of columns to limit the results on</dd><dd><code>reverse</code> - true to reverse column order</dd><dd><code>firstSet</code> - determines weather "FIRST" keyword was set</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="and(org.apache.cassandra.cql.Term)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>and</h4>
<pre>public void and(<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a> addTerm)</pre>
<div class="block">Add an additional column name to a SelectExpression.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>addTerm</code> - </dd></dl>
</li>
</ul>
<a name="isColumnRange()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isColumnRange</h4>
<pre>public boolean isColumnRange()</pre>
</li>
</ul>
<a name="isColumnList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isColumnList</h4>
<pre>public boolean isColumnList()</pre>
</li>
</ul>
<a name="getColumnsLimit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnsLimit</h4>
<pre>public int getColumnsLimit()</pre>
</li>
</ul>
<a name="isColumnsReversed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isColumnsReversed</h4>
<pre>public boolean isColumnsReversed()</pre>
</li>
</ul>
<a name="setColumnsReversed(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColumnsReversed</h4>
<pre>public void setColumnsReversed(boolean reversed)</pre>
</li>
</ul>
<a name="setColumnsLimit(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColumnsLimit</h4>
<pre>public void setColumnsLimit(int limit)</pre>
</li>
</ul>
<a name="hasFirstSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasFirstSet</h4>
<pre>public boolean hasFirstSet()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>weather expression includes "FIRST" keyword</dd></dl>
</li>
</ul>
<a name="getStart()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStart</h4>
<pre>public <a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a> getStart()</pre>
</li>
</ul>
<a name="getFinish()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFinish</h4>
<pre>public <a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a> getFinish()</pre>
</li>
</ul>
<a name="getColumns()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumns</h4>
<pre>public java.util.List<<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a>> getColumns()</pre>
</li>
</ul>
<a name="isWildcard()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWildcard</h4>
<pre>public boolean isWildcard()</pre>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</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/SelectExpression.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/cql/Relation.html" title="class in org.apache.cassandra.cql"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/cql/SelectStatement.html" title="class in org.apache.cassandra.cql"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/cql/SelectExpression.html" target="_top">Frames</a></li>
<li><a href="SelectExpression.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>