cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
329 lines (326 loc) • 17.3 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:31 CEST 2014 -->
<title>Term (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="Term (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/Term.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/SingleColumnRelation.html" title="class in org.apache.cassandra.cql3"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/cql3/Term.MultiColumnRaw.html" title="interface in org.apache.cassandra.cql3"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/cql3/Term.html" target="_top">Frames</a></li>
<li><a href="Term.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.cql3</div>
<h2 title="Interface Term" class="title">Interface Term</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/cassandra/cql3/AbstractMarker.html" title="class in org.apache.cassandra.cql3">AbstractMarker</a>, <a href="../../../../org/apache/cassandra/cql3/Constants.Marker.html" title="class in org.apache.cassandra.cql3">Constants.Marker</a>, <a href="../../../../org/apache/cassandra/cql3/Constants.Value.html" title="class in org.apache.cassandra.cql3">Constants.Value</a>, <a href="../../../../org/apache/cassandra/cql3/functions/FunctionCall.html" title="class in org.apache.cassandra.cql3.functions">FunctionCall</a>, <a href="../../../../org/apache/cassandra/cql3/Lists.DelayedValue.html" title="class in org.apache.cassandra.cql3">Lists.DelayedValue</a>, <a href="../../../../org/apache/cassandra/cql3/Lists.Marker.html" title="class in org.apache.cassandra.cql3">Lists.Marker</a>, <a href="../../../../org/apache/cassandra/cql3/Lists.Value.html" title="class in org.apache.cassandra.cql3">Lists.Value</a>, <a href="../../../../org/apache/cassandra/cql3/Maps.DelayedValue.html" title="class in org.apache.cassandra.cql3">Maps.DelayedValue</a>, <a href="../../../../org/apache/cassandra/cql3/Maps.Marker.html" title="class in org.apache.cassandra.cql3">Maps.Marker</a>, <a href="../../../../org/apache/cassandra/cql3/Maps.Value.html" title="class in org.apache.cassandra.cql3">Maps.Value</a>, <a href="../../../../org/apache/cassandra/cql3/Sets.DelayedValue.html" title="class in org.apache.cassandra.cql3">Sets.DelayedValue</a>, <a href="../../../../org/apache/cassandra/cql3/Sets.Marker.html" title="class in org.apache.cassandra.cql3">Sets.Marker</a>, <a href="../../../../org/apache/cassandra/cql3/Sets.Value.html" title="class in org.apache.cassandra.cql3">Sets.Value</a>, <a href="../../../../org/apache/cassandra/cql3/Term.MultiItemTerminal.html" title="class in org.apache.cassandra.cql3">Term.MultiItemTerminal</a>, <a href="../../../../org/apache/cassandra/cql3/Term.NonTerminal.html" title="class in org.apache.cassandra.cql3">Term.NonTerminal</a>, <a href="../../../../org/apache/cassandra/cql3/Term.Terminal.html" title="class in org.apache.cassandra.cql3">Term.Terminal</a>, <a href="../../../../org/apache/cassandra/cql3/Tuples.DelayedValue.html" title="class in org.apache.cassandra.cql3">Tuples.DelayedValue</a>, <a href="../../../../org/apache/cassandra/cql3/Tuples.InMarker.html" title="class in org.apache.cassandra.cql3">Tuples.InMarker</a>, <a href="../../../../org/apache/cassandra/cql3/Tuples.InValue.html" title="class in org.apache.cassandra.cql3">Tuples.InValue</a>, <a href="../../../../org/apache/cassandra/cql3/Tuples.Marker.html" title="class in org.apache.cassandra.cql3">Tuples.Marker</a>, <a href="../../../../org/apache/cassandra/cql3/Tuples.Value.html" title="class in org.apache.cassandra.cql3">Tuples.Value</a>, <a href="../../../../org/apache/cassandra/cql3/UserTypes.DelayedValue.html" title="class in org.apache.cassandra.cql3">UserTypes.DelayedValue</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Term</span></pre>
<div class="block">A CQL3 term, i.e. a column value with or without bind variables.
A Term can be either terminal or non terminal. A term object is one that is typed and is obtained
from a raw term (Term.Raw) by poviding the actual receiver to which the term is supposed to be a
value of.</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 interface </code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Term.MultiColumnRaw.html" title="interface in org.apache.cassandra.cql3">Term.MultiColumnRaw</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Term.MultiItemTerminal.html" title="class in org.apache.cassandra.cql3">Term.MultiItemTerminal</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Term.NonTerminal.html" title="class in org.apache.cassandra.cql3">Term.NonTerminal</a></strong></code>
<div class="block">A non terminal term, i.e.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface </code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Term.Raw.html" title="interface in org.apache.cassandra.cql3">Term.Raw</a></strong></code>
<div class="block">A parsed, non prepared (thus untyped) term.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Term.Terminal.html" title="class in org.apache.cassandra.cql3">Term.Terminal</a></strong></code>
<div class="block">A terminal term, one that can be reduced to a byte buffer directly.</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><a href="../../../../org/apache/cassandra/cql3/Term.Terminal.html" title="class in org.apache.cassandra.cql3">Term.Terminal</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Term.html#bind(org.apache.cassandra.cql3.QueryOptions)">bind</a></strong>(<a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)</code>
<div class="block">Bind the values in this term to the values contained in <code>values</code>.</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/cql3/Term.html#bindAndGet(org.apache.cassandra.cql3.QueryOptions)">bindAndGet</a></strong>(<a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)</code>
<div class="block">A shorter for bind(values).get().</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Term.html#collectMarkerSpecification(org.apache.cassandra.cql3.VariableSpecifications)">collectMarkerSpecification</a></strong>(<a href="../../../../org/apache/cassandra/cql3/VariableSpecifications.html" title="class in org.apache.cassandra.cql3">VariableSpecifications</a> boundNames)</code>
<div class="block">Collects the column specification for the bind variables in this Term.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Term.html#containsBindMarker()">containsBindMarker</a></strong>()</code>
<div class="block">Whether or not that term contains at least one bind marker.</div>
</td>
</tr>
</table>
</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="collectMarkerSpecification(org.apache.cassandra.cql3.VariableSpecifications)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectMarkerSpecification</h4>
<pre>void collectMarkerSpecification(<a href="../../../../org/apache/cassandra/cql3/VariableSpecifications.html" title="class in org.apache.cassandra.cql3">VariableSpecifications</a> boundNames)</pre>
<div class="block">Collects the column specification for the bind variables in this Term.
This is obviously a no-op if the term is Terminal.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>boundNames</code> - the variables specification where to collect the
bind variables of this term in.</dd></dl>
</li>
</ul>
<a name="bind(org.apache.cassandra.cql3.QueryOptions)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bind</h4>
<pre><a href="../../../../org/apache/cassandra/cql3/Term.Terminal.html" title="class in org.apache.cassandra.cql3">Term.Terminal</a> bind(<a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)
throws <a href="../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></pre>
<div class="block">Bind the values in this term to the values contained in <code>values</code>.
This is obviously a no-op if the term is Terminal.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>options</code> - the values to bind markers to.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the result of binding all the variables of this NonTerminal (or
'this' if the term is terminal).</dd>
<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="bindAndGet(org.apache.cassandra.cql3.QueryOptions)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindAndGet</h4>
<pre>java.nio.ByteBuffer bindAndGet(<a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)
throws <a href="../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></pre>
<div class="block">A shorter for bind(values).get().
We expose it mainly because for constants it can avoids allocating a temporary
object between the bind and the get (note that we still want to be able
to separate bind and get for collections).</div>
<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="containsBindMarker()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>containsBindMarker</h4>
<pre>boolean containsBindMarker()</pre>
<div class="block">Whether or not that term contains at least one bind marker.
Note that this is slightly different from being or not a NonTerminal,
because calls to non pure functions will be NonTerminal (see #5616)
even if they don't have bind markers.</div>
</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/Term.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/SingleColumnRelation.html" title="class in org.apache.cassandra.cql3"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/cql3/Term.MultiColumnRaw.html" title="interface in org.apache.cassandra.cql3"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/cql3/Term.html" target="_top">Frames</a></li>
<li><a href="Term.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>