UNPKG

cassandra-server

Version:

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

347 lines (346 loc) 19.5 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>Restriction.Slice (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="Restriction.Slice (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/Restriction.Slice.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/Restriction.IN.html" title="interface in org.apache.cassandra.cql3.statements"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/cql3/statements/RevokeStatement.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/Restriction.Slice.html" target="_top">Frames</a></li> <li><a href="Restriction.Slice.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>Nested&nbsp;|&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li>Constr&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>Constr&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="Interface Restriction.Slice" class="title">Interface Restriction.Slice</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Superinterfaces:</dt> <dd><a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.html" title="interface in org.apache.cassandra.cql3.statements">Restriction</a></dd> </dl> <dl> <dt>All Known Implementing Classes:</dt> <dd><a href="../../../../../org/apache/cassandra/cql3/statements/MultiColumnRestriction.Slice.html" title="class in org.apache.cassandra.cql3.statements">MultiColumnRestriction.Slice</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/SingleColumnRestriction.Slice.html" title="class in org.apache.cassandra.cql3.statements">SingleColumnRestriction.Slice</a></dd> </dl> <dl> <dt>Enclosing interface:</dt> <dd><a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.html" title="interface in org.apache.cassandra.cql3.statements">Restriction</a></dd> </dl> <hr> <br> <pre>public static interface <span class="strong">Restriction.Slice</span> extends <a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.html" title="interface in org.apache.cassandra.cql3.statements">Restriction</a></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> <ul class="blockList"> <li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.cassandra.cql3.statements.Restriction"> <!-- --> </a> <h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.cassandra.cql3.statements.<a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.html" title="interface in org.apache.cassandra.cql3.statements">Restriction</a></h3> <code><a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.EQ.html" title="interface in org.apache.cassandra.cql3.statements">Restriction.EQ</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.IN.html" title="interface in org.apache.cassandra.cql3.statements">Restriction.IN</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.Slice.html" title="interface in org.apache.cassandra.cql3.statements">Restriction.Slice</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">&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>java.nio.ByteBuffer</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.Slice.html#bound(org.apache.cassandra.cql3.statements.Bound,%20org.apache.cassandra.cql3.QueryOptions)">bound</a></strong>(<a href="../../../../../org/apache/cassandra/cql3/statements/Bound.html" title="enum in org.apache.cassandra.cql3.statements">Bound</a>&nbsp;b, <a href="../../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a>&nbsp;options)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/IndexExpression.Operator.html" title="enum in org.apache.cassandra.db">IndexExpression.Operator</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.Slice.html#getIndexOperator(org.apache.cassandra.cql3.statements.Bound)">getIndexOperator</a></strong>(<a href="../../../../../org/apache/cassandra/cql3/statements/Bound.html" title="enum in org.apache.cassandra.cql3.statements">Bound</a>&nbsp;b)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/cql3/Relation.Type.html" title="enum in org.apache.cassandra.cql3">Relation.Type</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.Slice.html#getRelation(org.apache.cassandra.cql3.statements.Bound,%20org.apache.cassandra.cql3.statements.Bound)">getRelation</a></strong>(<a href="../../../../../org/apache/cassandra/cql3/statements/Bound.html" title="enum in org.apache.cassandra.cql3.statements">Bound</a>&nbsp;eocBound, <a href="../../../../../org/apache/cassandra/cql3/statements/Bound.html" title="enum in org.apache.cassandra.cql3.statements">Bound</a>&nbsp;inclusiveBound)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.Slice.html#hasBound(org.apache.cassandra.cql3.statements.Bound)">hasBound</a></strong>(<a href="../../../../../org/apache/cassandra/cql3/statements/Bound.html" title="enum in org.apache.cassandra.cql3.statements">Bound</a>&nbsp;b)</code> <div class="block">Returns true if the start or end bound (depending on the argument) is set, false otherwise</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.Slice.html#isInclusive(org.apache.cassandra.cql3.statements.Bound)">isInclusive</a></strong>(<a href="../../../../../org/apache/cassandra/cql3/statements/Bound.html" title="enum in org.apache.cassandra.cql3.statements">Bound</a>&nbsp;b)</code> <div class="block">Returns true if the start or end bound (depending on the argument) is inclusive, false otherwise</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.Slice.html#setBound(org.apache.cassandra.cql3.ColumnIdentifier,%20org.apache.cassandra.cql3.Relation.Type,%20org.apache.cassandra.cql3.Term)">setBound</a></strong>(<a href="../../../../../org/apache/cassandra/cql3/ColumnIdentifier.html" title="class in org.apache.cassandra.cql3">ColumnIdentifier</a>&nbsp;name, <a href="../../../../../org/apache/cassandra/cql3/Relation.Type.html" title="enum in org.apache.cassandra.cql3">Relation.Type</a>&nbsp;type, <a href="../../../../../org/apache/cassandra/cql3/Term.html" title="interface in org.apache.cassandra.cql3">Term</a>&nbsp;t)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List&lt;java.nio.ByteBuffer&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.Slice.html#values(org.apache.cassandra.cql3.QueryOptions)">values</a></strong>(<a href="../../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a>&nbsp;options)</code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.cql3.statements.Restriction"> <!-- --> </a> <h3>Methods inherited from interface&nbsp;org.apache.cassandra.cql3.statements.<a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.html" title="interface in org.apache.cassandra.cql3.statements">Restriction</a></h3> <code><a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.html#isContains()">isContains</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.html#isEQ()">isEQ</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.html#isIN()">isIN</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.html#isMultiColumn()">isMultiColumn</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.html#isOnToken()">isOnToken</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.html#isSlice()">isSlice</a></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="values(org.apache.cassandra.cql3.QueryOptions)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>values</h4> <pre>java.util.List&lt;java.nio.ByteBuffer&gt;&nbsp;values(<a href="../../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a>&nbsp;options) throws <a href="../../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.html#values(org.apache.cassandra.cql3.QueryOptions)">values</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/cassandra/cql3/statements/Restriction.html" title="interface in org.apache.cassandra.cql3.statements">Restriction</a></code></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="hasBound(org.apache.cassandra.cql3.statements.Bound)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hasBound</h4> <pre>boolean&nbsp;hasBound(<a href="../../../../../org/apache/cassandra/cql3/statements/Bound.html" title="enum in org.apache.cassandra.cql3.statements">Bound</a>&nbsp;b)</pre> <div class="block">Returns true if the start or end bound (depending on the argument) is set, false otherwise</div> </li> </ul> <a name="bound(org.apache.cassandra.cql3.statements.Bound, org.apache.cassandra.cql3.QueryOptions)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>bound</h4> <pre>java.nio.ByteBuffer&nbsp;bound(<a href="../../../../../org/apache/cassandra/cql3/statements/Bound.html" title="enum in org.apache.cassandra.cql3.statements">Bound</a>&nbsp;b, <a href="../../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a>&nbsp;options) 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="isInclusive(org.apache.cassandra.cql3.statements.Bound)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isInclusive</h4> <pre>boolean&nbsp;isInclusive(<a href="../../../../../org/apache/cassandra/cql3/statements/Bound.html" title="enum in org.apache.cassandra.cql3.statements">Bound</a>&nbsp;b)</pre> <div class="block">Returns true if the start or end bound (depending on the argument) is inclusive, false otherwise</div> </li> </ul> <a name="getRelation(org.apache.cassandra.cql3.statements.Bound, org.apache.cassandra.cql3.statements.Bound)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getRelation</h4> <pre><a href="../../../../../org/apache/cassandra/cql3/Relation.Type.html" title="enum in org.apache.cassandra.cql3">Relation.Type</a>&nbsp;getRelation(<a href="../../../../../org/apache/cassandra/cql3/statements/Bound.html" title="enum in org.apache.cassandra.cql3.statements">Bound</a>&nbsp;eocBound, <a href="../../../../../org/apache/cassandra/cql3/statements/Bound.html" title="enum in org.apache.cassandra.cql3.statements">Bound</a>&nbsp;inclusiveBound)</pre> </li> </ul> <a name="getIndexOperator(org.apache.cassandra.cql3.statements.Bound)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getIndexOperator</h4> <pre><a href="../../../../../org/apache/cassandra/db/IndexExpression.Operator.html" title="enum in org.apache.cassandra.db">IndexExpression.Operator</a>&nbsp;getIndexOperator(<a href="../../../../../org/apache/cassandra/cql3/statements/Bound.html" title="enum in org.apache.cassandra.cql3.statements">Bound</a>&nbsp;b)</pre> </li> </ul> <a name="setBound(org.apache.cassandra.cql3.ColumnIdentifier, org.apache.cassandra.cql3.Relation.Type, org.apache.cassandra.cql3.Term)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>setBound</h4> <pre>void&nbsp;setBound(<a href="../../../../../org/apache/cassandra/cql3/ColumnIdentifier.html" title="class in org.apache.cassandra.cql3">ColumnIdentifier</a>&nbsp;name, <a href="../../../../../org/apache/cassandra/cql3/Relation.Type.html" title="enum in org.apache.cassandra.cql3">Relation.Type</a>&nbsp;type, <a href="../../../../../org/apache/cassandra/cql3/Term.html" title="interface in org.apache.cassandra.cql3">Term</a>&nbsp;t) 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> </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/Restriction.Slice.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/Restriction.IN.html" title="interface in org.apache.cassandra.cql3.statements"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/cql3/statements/RevokeStatement.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/Restriction.Slice.html" target="_top">Frames</a></li> <li><a href="Restriction.Slice.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>Nested&nbsp;|&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li>Constr&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>Constr&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>