cassandra-server

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <html lang="en"> <head>  <title>WhereClause (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"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript>  <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/WhereClause.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/UpdateStatement.html" title="class in org.apache.cassandra.cql"><span class="strong">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/cql/WhereClause.html" target="_top">Frames</a></li> <li><a href="WhereClause.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </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>Field | </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>   <div class="header"> <div class="subTitle">org.apache.cassandra.cql</div> <h2 title="Class WhereClause" class="title">Class WhereClause</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.cql.WhereClause</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">WhereClause</span> extends java.lang.Object</pre> <div class="block">WhereClauses encapsulate all of the predicates of a SELECT query.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <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/WhereClause.html#WhereClause()">WhereClause</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/cql/WhereClause.html#WhereClause(org.apache.cassandra.cql.Relation)">WhereClause</a></strong>(<a href="../../../../org/apache/cassandra/cql/Relation.html" title="class in org.apache.cassandra.cql">Relation</a> firstRelation)</code> <div class="block">Create a new WhereClause with the first parsed relation.</div> </td> </tr> </table> </li> </ul>  <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/WhereClause.html#and(org.apache.cassandra.cql.Relation)">and</a></strong>(<a href="../../../../org/apache/cassandra/cql/Relation.html" title="class in org.apache.cassandra.cql">Relation</a> relation)</code> <div class="block">Add an additional relation to this WHERE clause.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/WhereClause.html#andKeyEquals(org.apache.cassandra.cql.Term)">andKeyEquals</a></strong>(<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a> key)</code> <div class="block">The same as KEY = <key> to avoid using Relation object</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/WhereClause.html#extractKeysFromColumns(org.apache.cassandra.config.CFMetaData)">extractKeysFromColumns</a></strong>(<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> cfm)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/cassandra/cql/Relation.html" title="class in org.apache.cassandra.cql">Relation</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/WhereClause.html#getClauseRelations()">getClauseRelations</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/cassandra/cql/Relation.html" title="class in org.apache.cassandra.cql">Relation</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/WhereClause.html#getColumnRelations()">getColumnRelations</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/WhereClause.html#getFinishKey()">getFinishKey</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/cql/WhereClause.html#getKeyAlias()">getKeyAlias</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Set<<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/WhereClause.html#getKeys()">getKeys</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/WhereClause.html#getStartKey()">getStartKey</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/WhereClause.html#includeFinishKey()">includeFinishKey</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/WhereClause.html#includeStartKey()">includeStartKey</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/WhereClause.html#isKeyRange()">isKeyRange</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/WhereClause.html#isMultiKey()">isMultiKey</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/WhereClause.html#setKeyAlias(java.lang.String)">setKeyAlias</a></strong>(java.lang.String alias)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/WhereClause.html#setMultiKey(boolean)">setMultiKey</a></strong>(boolean multiKey)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/WhereClause.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">  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="WhereClause(org.apache.cassandra.cql.Relation)">  </a> <ul class="blockList"> <li class="blockList"> <h4>WhereClause</h4> <pre>public WhereClause(<a href="../../../../org/apache/cassandra/cql/Relation.html" title="class in org.apache.cassandra.cql">Relation</a> firstRelation)</pre> <div class="block">Create a new WhereClause with the first parsed relation.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>firstRelation</code> - key or column relation</dd></dl> </li> </ul> <a name="WhereClause()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>WhereClause</h4> <pre>public WhereClause()</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="and(org.apache.cassandra.cql.Relation)">  </a> <ul class="blockList"> <li class="blockList"> <h4>and</h4> <pre>public void and(<a href="../../../../org/apache/cassandra/cql/Relation.html" title="class in org.apache.cassandra.cql">Relation</a> relation)</pre> <div class="block">Add an additional relation to this WHERE clause.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>relation</code> - the relation to add.</dd></dl> </li> </ul> <a name="andKeyEquals(org.apache.cassandra.cql.Term)">  </a> <ul class="blockList"> <li class="blockList"> <h4>andKeyEquals</h4> <pre>public void andKeyEquals(<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a> key)</pre> <div class="block">The same as KEY = <key> to avoid using Relation object</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - key to include into clause</dd></dl> </li> </ul> <a name="getColumnRelations()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getColumnRelations</h4> <pre>public java.util.List<<a href="../../../../org/apache/cassandra/cql/Relation.html" title="class in org.apache.cassandra.cql">Relation</a>> getColumnRelations()</pre> </li> </ul> <a name="isKeyRange()">  </a> <ul class="blockList"> <li class="blockList"> <h4>isKeyRange</h4> <pre>public boolean isKeyRange()</pre> </li> </ul> <a name="getStartKey()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getStartKey</h4> <pre>public <a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a> getStartKey()</pre> </li> </ul> <a name="getFinishKey()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getFinishKey</h4> <pre>public <a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a> getFinishKey()</pre> </li> </ul> <a name="getKeys()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getKeys</h4> <pre>public java.util.Set<<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a>> getKeys()</pre> </li> </ul> <a name="includeStartKey()">  </a> <ul class="blockList"> <li class="blockList"> <h4>includeStartKey</h4> <pre>public boolean includeStartKey()</pre> </li> </ul> <a name="includeFinishKey()">  </a> <ul class="blockList"> <li class="blockList"> <h4>includeFinishKey</h4> <pre>public boolean includeFinishKey()</pre> </li> </ul> <a name="setKeyAlias(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>setKeyAlias</h4> <pre>public void setKeyAlias(java.lang.String alias)</pre> </li> </ul> <a name="isMultiKey()">  </a> <ul class="blockList"> <li class="blockList"> <h4>isMultiKey</h4> <pre>public boolean isMultiKey()</pre> </li> </ul> <a name="setMultiKey(boolean)">  </a> <ul class="blockList"> <li class="blockList"> <h4>setMultiKey</h4> <pre>public void setMultiKey(boolean multiKey)</pre> </li> </ul> <a name="getKeyAlias()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getKeyAlias</h4> <pre>public java.lang.String getKeyAlias()</pre> </li> </ul> <a name="extractKeysFromColumns(org.apache.cassandra.config.CFMetaData)">  </a> <ul class="blockList"> <li class="blockList"> <h4>extractKeysFromColumns</h4> <pre>public void extractKeysFromColumns(<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> cfm)</pre> </li> </ul> <a name="getClauseRelations()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getClauseRelations</h4> <pre>public java.util.List<<a href="../../../../org/apache/cassandra/cql/Relation.html" title="class in org.apache.cassandra.cql">Relation</a>> getClauseRelations()</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>   <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/WhereClause.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/UpdateStatement.html" title="class in org.apache.cassandra.cql"><span class="strong">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/cql/WhereClause.html" target="_top">Frames</a></li> <li><a href="WhereClause.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </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>Field | </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>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>