cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
417 lines (416 loc) • 20.8 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>MultiColumnRelation (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="MultiColumnRelation (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/MultiColumnRelation.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/MeasurableForPreparedCache.html" title="interface in org.apache.cassandra.cql3"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/cql3/Operation.html" title="class 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/MultiColumnRelation.html" target="_top">Frames</a></li>
<li><a href="MultiColumnRelation.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_classes_inherited_from_class_org.apache.cassandra.cql3.Relation">Nested</a> | </li>
<li><a href="#fields_inherited_from_class_org.apache.cassandra.cql3.Relation">Field</a> | </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="Class MultiColumnRelation" class="title">Class MultiColumnRelation</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/cassandra/cql3/Relation.html" title="class in org.apache.cassandra.cql3">org.apache.cassandra.cql3.Relation</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.cql3.MultiColumnRelation</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">MultiColumnRelation</span>
extends <a href="../../../../org/apache/cassandra/cql3/Relation.html" title="class in org.apache.cassandra.cql3">Relation</a></pre>
<div class="block">A relation using the tuple notation, which typically affects multiple columns.
Examples:
- SELECT ... WHERE (a, b, c) > (1, 'a', 10)
- SELECT ... WHERE (a, b, c) IN ((1, 2, 3), (4, 5, 6))
- SELECT ... WHERE (a, b) < ?
- SELECT ... WHERE (a, b) IN ?</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.cql3.Relation">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class org.apache.cassandra.cql3.<a href="../../../../org/apache/cassandra/cql3/Relation.html" title="class in org.apache.cassandra.cql3">Relation</a></h3>
<code><a href="../../../../org/apache/cassandra/cql3/Relation.Type.html" title="enum in org.apache.cassandra.cql3">Relation.Type</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.cql3.Relation">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.cassandra.cql3.<a href="../../../../org/apache/cassandra/cql3/Relation.html" title="class in org.apache.cassandra.cql3">Relation</a></h3>
<code><a href="../../../../org/apache/cassandra/cql3/Relation.html#relationType">relationType</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>static <a href="../../../../org/apache/cassandra/cql3/MultiColumnRelation.html" title="class in org.apache.cassandra.cql3">MultiColumnRelation</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/MultiColumnRelation.html#createInRelation(java.util.List,%20java.util.List)">createInRelation</a></strong>(java.util.List<<a href="../../../../org/apache/cassandra/cql3/ColumnIdentifier.html" title="class in org.apache.cassandra.cql3">ColumnIdentifier</a>> entities,
java.util.List<? extends <a href="../../../../org/apache/cassandra/cql3/Term.MultiColumnRaw.html" title="interface in org.apache.cassandra.cql3">Term.MultiColumnRaw</a>> inValues)</code>
<div class="block">Creates a multi-column IN relation with a list of IN values or markers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/cql3/MultiColumnRelation.html" title="class in org.apache.cassandra.cql3">MultiColumnRelation</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/MultiColumnRelation.html#createNonInRelation(java.util.List,%20org.apache.cassandra.cql3.Relation.Type,%20org.apache.cassandra.cql3.Term.MultiColumnRaw)">createNonInRelation</a></strong>(java.util.List<<a href="../../../../org/apache/cassandra/cql3/ColumnIdentifier.html" title="class in org.apache.cassandra.cql3">ColumnIdentifier</a>> entities,
<a href="../../../../org/apache/cassandra/cql3/Relation.Type.html" title="enum in org.apache.cassandra.cql3">Relation.Type</a> relationType,
<a href="../../../../org/apache/cassandra/cql3/Term.MultiColumnRaw.html" title="interface in org.apache.cassandra.cql3">Term.MultiColumnRaw</a> valuesOrMarker)</code>
<div class="block">Creates a multi-column EQ, LT, LTE, GT, or GTE relation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/cql3/MultiColumnRelation.html" title="class in org.apache.cassandra.cql3">MultiColumnRelation</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/MultiColumnRelation.html#createSingleMarkerInRelation(java.util.List,%20org.apache.cassandra.cql3.Tuples.INRaw)">createSingleMarkerInRelation</a></strong>(java.util.List<<a href="../../../../org/apache/cassandra/cql3/ColumnIdentifier.html" title="class in org.apache.cassandra.cql3">ColumnIdentifier</a>> entities,
<a href="../../../../org/apache/cassandra/cql3/Tuples.INRaw.html" title="class in org.apache.cassandra.cql3">Tuples.INRaw</a> inMarker)</code>
<div class="block">Creates a multi-column IN relation with a marker for the IN values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List<<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/cql3/MultiColumnRelation.html#getEntities()">getEntities</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/cql3/Tuples.INRaw.html" title="class in org.apache.cassandra.cql3">Tuples.INRaw</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/MultiColumnRelation.html#getInMarker()">getInMarker</a></strong>()</code>
<div class="block">For IN relations, returns the single marker for the IN values if there is one, otherwise null.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List<? extends <a href="../../../../org/apache/cassandra/cql3/Term.MultiColumnRaw.html" title="interface in org.apache.cassandra.cql3">Term.MultiColumnRaw</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/MultiColumnRelation.html#getInValues()">getInValues</a></strong>()</code>
<div class="block">For IN relations, returns the list of Tuples.Literal instances or Tuples.Raw markers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/cql3/Term.MultiColumnRaw.html" title="interface in org.apache.cassandra.cql3">Term.MultiColumnRaw</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/MultiColumnRelation.html#getValue()">getValue</a></strong>()</code>
<div class="block">For non-IN relations, returns the Tuples.Literal or Tuples.Raw marker for a single tuple.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/MultiColumnRelation.html#isMultiColumn()">isMultiColumn</a></strong>()</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/cql3/MultiColumnRelation.html#toString()">toString</a></strong>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.cql3.Relation">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.cassandra.cql3.<a href="../../../../org/apache/cassandra/cql3/Relation.html" title="class in org.apache.cassandra.cql3">Relation</a></h3>
<code><a href="../../../../org/apache/cassandra/cql3/Relation.html#operator()">operator</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 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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="createNonInRelation(java.util.List, org.apache.cassandra.cql3.Relation.Type, org.apache.cassandra.cql3.Term.MultiColumnRaw)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createNonInRelation</h4>
<pre>public static <a href="../../../../org/apache/cassandra/cql3/MultiColumnRelation.html" title="class in org.apache.cassandra.cql3">MultiColumnRelation</a> createNonInRelation(java.util.List<<a href="../../../../org/apache/cassandra/cql3/ColumnIdentifier.html" title="class in org.apache.cassandra.cql3">ColumnIdentifier</a>> entities,
<a href="../../../../org/apache/cassandra/cql3/Relation.Type.html" title="enum in org.apache.cassandra.cql3">Relation.Type</a> relationType,
<a href="../../../../org/apache/cassandra/cql3/Term.MultiColumnRaw.html" title="interface in org.apache.cassandra.cql3">Term.MultiColumnRaw</a> valuesOrMarker)</pre>
<div class="block">Creates a multi-column EQ, LT, LTE, GT, or GTE relation.
For example: "SELECT ... WHERE (a, b) > (0, 1)"</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entities</code> - the columns on the LHS of the relation</dd><dd><code>relationType</code> - the relation operator</dd><dd><code>valuesOrMarker</code> - a Tuples.Literal instance or a Tuples.Raw marker</dd></dl>
</li>
</ul>
<a name="createInRelation(java.util.List, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createInRelation</h4>
<pre>public static <a href="../../../../org/apache/cassandra/cql3/MultiColumnRelation.html" title="class in org.apache.cassandra.cql3">MultiColumnRelation</a> createInRelation(java.util.List<<a href="../../../../org/apache/cassandra/cql3/ColumnIdentifier.html" title="class in org.apache.cassandra.cql3">ColumnIdentifier</a>> entities,
java.util.List<? extends <a href="../../../../org/apache/cassandra/cql3/Term.MultiColumnRaw.html" title="interface in org.apache.cassandra.cql3">Term.MultiColumnRaw</a>> inValues)</pre>
<div class="block">Creates a multi-column IN relation with a list of IN values or markers.
For example: "SELECT ... WHERE (a, b) IN ((0, 1), (2, 3))"</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entities</code> - the columns on the LHS of the relation</dd><dd><code>inValues</code> - a list of Tuples.Literal instances or a Tuples.Raw markers</dd></dl>
</li>
</ul>
<a name="createSingleMarkerInRelation(java.util.List, org.apache.cassandra.cql3.Tuples.INRaw)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSingleMarkerInRelation</h4>
<pre>public static <a href="../../../../org/apache/cassandra/cql3/MultiColumnRelation.html" title="class in org.apache.cassandra.cql3">MultiColumnRelation</a> createSingleMarkerInRelation(java.util.List<<a href="../../../../org/apache/cassandra/cql3/ColumnIdentifier.html" title="class in org.apache.cassandra.cql3">ColumnIdentifier</a>> entities,
<a href="../../../../org/apache/cassandra/cql3/Tuples.INRaw.html" title="class in org.apache.cassandra.cql3">Tuples.INRaw</a> inMarker)</pre>
<div class="block">Creates a multi-column IN relation with a marker for the IN values.
For example: "SELECT ... WHERE (a, b) IN ?"</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entities</code> - the columns on the LHS of the relation</dd><dd><code>inMarker</code> - a single IN marker</dd></dl>
</li>
</ul>
<a name="getEntities()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntities</h4>
<pre>public java.util.List<<a href="../../../../org/apache/cassandra/cql3/ColumnIdentifier.html" title="class in org.apache.cassandra.cql3">ColumnIdentifier</a>> getEntities()</pre>
</li>
</ul>
<a name="getValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public <a href="../../../../org/apache/cassandra/cql3/Term.MultiColumnRaw.html" title="interface in org.apache.cassandra.cql3">Term.MultiColumnRaw</a> getValue()</pre>
<div class="block">For non-IN relations, returns the Tuples.Literal or Tuples.Raw marker for a single tuple.</div>
</li>
</ul>
<a name="getInValues()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInValues</h4>
<pre>public java.util.List<? extends <a href="../../../../org/apache/cassandra/cql3/Term.MultiColumnRaw.html" title="interface in org.apache.cassandra.cql3">Term.MultiColumnRaw</a>> getInValues()</pre>
<div class="block">For IN relations, returns the list of Tuples.Literal instances or Tuples.Raw markers.
If a single IN marker was used, this will return null;</div>
</li>
</ul>
<a name="getInMarker()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInMarker</h4>
<pre>public <a href="../../../../org/apache/cassandra/cql3/Tuples.INRaw.html" title="class in org.apache.cassandra.cql3">Tuples.INRaw</a> getInMarker()</pre>
<div class="block">For IN relations, returns the single marker for the IN values if there is one, otherwise null.</div>
</li>
</ul>
<a name="isMultiColumn()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMultiColumn</h4>
<pre>public boolean isMultiColumn()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cassandra/cql3/Relation.html#isMultiColumn()">isMultiColumn</a></code> in class <code><a href="../../../../org/apache/cassandra/cql3/Relation.html" title="class in org.apache.cassandra.cql3">Relation</a></code></dd>
</dl>
</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/MultiColumnRelation.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/MeasurableForPreparedCache.html" title="interface in org.apache.cassandra.cql3"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/cql3/Operation.html" title="class 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/MultiColumnRelation.html" target="_top">Frames</a></li>
<li><a href="MultiColumnRelation.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_classes_inherited_from_class_org.apache.cassandra.cql3.Relation">Nested</a> | </li>
<li><a href="#fields_inherited_from_class_org.apache.cassandra.cql3.Relation">Field</a> | </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>