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>Operation (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/Operation.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/MultiColumnRelation.html" title="class in org.apache.cassandra.cql3"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cql3/Operation.Addition.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/Operation.html" target="_top">Frames</a></li> <li><a href="Operation.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><a href="#nested_class_summary">Nested</a> | </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>   <div class="header"> <div class="subTitle">org.apache.cassandra.cql3</div> <h2 title="Class Operation" class="title">Class Operation</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.cql3.Operation</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../../org/apache/cassandra/cql3/Constants.Adder.html" title="class in org.apache.cassandra.cql3">Constants.Adder</a>, <a href="../../../../org/apache/cassandra/cql3/Constants.Deleter.html" title="class in org.apache.cassandra.cql3">Constants.Deleter</a>, <a href="../../../../org/apache/cassandra/cql3/Constants.Setter.html" title="class in org.apache.cassandra.cql3">Constants.Setter</a>, <a href="../../../../org/apache/cassandra/cql3/Constants.Substracter.html" title="class in org.apache.cassandra.cql3">Constants.Substracter</a>, <a href="../../../../org/apache/cassandra/cql3/Lists.Appender.html" title="class in org.apache.cassandra.cql3">Lists.Appender</a>, <a href="../../../../org/apache/cassandra/cql3/Lists.Discarder.html" title="class in org.apache.cassandra.cql3">Lists.Discarder</a>, <a href="../../../../org/apache/cassandra/cql3/Lists.DiscarderByIndex.html" title="class in org.apache.cassandra.cql3">Lists.DiscarderByIndex</a>, <a href="../../../../org/apache/cassandra/cql3/Lists.Prepender.html" title="class in org.apache.cassandra.cql3">Lists.Prepender</a>, <a href="../../../../org/apache/cassandra/cql3/Lists.Setter.html" title="class in org.apache.cassandra.cql3">Lists.Setter</a>, <a href="../../../../org/apache/cassandra/cql3/Lists.SetterByIndex.html" title="class in org.apache.cassandra.cql3">Lists.SetterByIndex</a>, <a href="../../../../org/apache/cassandra/cql3/Maps.DiscarderByKey.html" title="class in org.apache.cassandra.cql3">Maps.DiscarderByKey</a>, <a href="../../../../org/apache/cassandra/cql3/Maps.Putter.html" title="class in org.apache.cassandra.cql3">Maps.Putter</a>, <a href="../../../../org/apache/cassandra/cql3/Maps.Setter.html" title="class in org.apache.cassandra.cql3">Maps.Setter</a>, <a href="../../../../org/apache/cassandra/cql3/Maps.SetterByKey.html" title="class in org.apache.cassandra.cql3">Maps.SetterByKey</a>, <a href="../../../../org/apache/cassandra/cql3/Sets.Adder.html" title="class in org.apache.cassandra.cql3">Sets.Adder</a>, <a href="../../../../org/apache/cassandra/cql3/Sets.Discarder.html" title="class in org.apache.cassandra.cql3">Sets.Discarder</a>, <a href="../../../../org/apache/cassandra/cql3/Sets.Setter.html" title="class in org.apache.cassandra.cql3">Sets.Setter</a></dd> </dl> <hr> <br> <pre>public abstract class <span class="strong">Operation</span> extends java.lang.Object</pre> <div class="block">An UPDATE or DELETE operation. For UPDATE this includes: - setting a constant - counter operations - collections operations and for DELETE: - deleting a column - deleting an element of collection column Fine grained operation are obtained from their raw counterpart (Operation.Raw, which correspond to a parsed, non-checked operation) by provided the receiver for the operation.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <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">Class and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static class </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Operation.Addition.html" title="class in org.apache.cassandra.cql3">Operation.Addition</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/Operation.ColumnDeletion.html" title="class in org.apache.cassandra.cql3">Operation.ColumnDeletion</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/Operation.ElementDeletion.html" title="class in org.apache.cassandra.cql3">Operation.ElementDeletion</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/Operation.Prepend.html" title="class in org.apache.cassandra.cql3">Operation.Prepend</a></strong></code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static interface </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Operation.RawDeletion.html" title="interface in org.apache.cassandra.cql3">Operation.RawDeletion</a></strong></code> <div class="block">A parsed raw DELETE operation.</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/Operation.RawUpdate.html" title="interface in org.apache.cassandra.cql3">Operation.RawUpdate</a></strong></code> <div class="block">A parsed raw UPDATE operation.</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/Operation.SetElement.html" title="class in org.apache.cassandra.cql3">Operation.SetElement</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/Operation.SetValue.html" title="class in org.apache.cassandra.cql3">Operation.SetValue</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/Operation.Substraction.html" title="class in org.apache.cassandra.cql3">Operation.Substraction</a></strong></code> </td> </tr> </table> </li> </ul>  <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><a href="../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Operation.html#column">column</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected <a href="../../../../org/apache/cassandra/cql3/Term.html" title="interface in org.apache.cassandra.cql3">Term</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Operation.html#t">t</a></strong></code> </td> </tr> </table> </li> </ul>  <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="colFirst" scope="col">Modifier</th> <th class="colLast" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Operation.html#Operation(org.apache.cassandra.config.ColumnDefinition,%20org.apache.cassandra.cql3.Term)">Operation</a></strong>(<a href="../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a> column, <a href="../../../../org/apache/cassandra/cql3/Term.html" title="interface in org.apache.cassandra.cql3">Term</a> t)</code> </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/cql3/Operation.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 of this operation.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Operation.html#execute(java.nio.ByteBuffer,%20org.apache.cassandra.db.ColumnFamily,%20org.apache.cassandra.db.composites.Composite,%20org.apache.cassandra.cql3.UpdateParameters)">execute</a></strong>(java.nio.ByteBuffer rowKey, <a href="../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf, <a href="../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a> prefix, <a href="../../../../org/apache/cassandra/cql3/UpdateParameters.html" title="class in org.apache.cassandra.cql3">UpdateParameters</a> params)</code> <div class="block">Execute the operation.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Operation.html#requiresRead()">requiresRead</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, toString, 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="field_detail">  </a> <h3>Field Detail</h3> <a name="column">  </a> <ul class="blockList"> <li class="blockList"> <h4>column</h4> <pre>public final <a href="../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a> column</pre> </li> </ul> <a name="t">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>t</h4> <pre>protected final <a href="../../../../org/apache/cassandra/cql3/Term.html" title="interface in org.apache.cassandra.cql3">Term</a> t</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="Operation(org.apache.cassandra.config.ColumnDefinition, org.apache.cassandra.cql3.Term)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>Operation</h4> <pre>protected Operation(<a href="../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a> column, <a href="../../../../org/apache/cassandra/cql3/Term.html" title="interface in org.apache.cassandra.cql3">Term</a> t)</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="requiresRead()">  </a> <ul class="blockList"> <li class="blockList"> <h4>requiresRead</h4> <pre>public boolean requiresRead()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>whether the operation requires a read of the previous value to be executed (only lists setterByIdx, discard and discardByIdx requires that).</dd></dl> </li> </ul> <a name="collectMarkerSpecification(org.apache.cassandra.cql3.VariableSpecifications)">  </a> <ul class="blockList"> <li class="blockList"> <h4>collectMarkerSpecification</h4> <pre>public 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 of this operation.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>boundNames</code> - the list of column specification where to collect the bind variables of this term in.</dd></dl> </li> </ul> <a name="execute(java.nio.ByteBuffer, org.apache.cassandra.db.ColumnFamily, org.apache.cassandra.db.composites.Composite, org.apache.cassandra.cql3.UpdateParameters)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>execute</h4> <pre>public abstract void execute(java.nio.ByteBuffer rowKey, <a href="../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf, <a href="../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a> prefix, <a href="../../../../org/apache/cassandra/cql3/UpdateParameters.html" title="class in org.apache.cassandra.cql3">UpdateParameters</a> params) throws <a href="../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></pre> <div class="block">Execute the operation.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>rowKey</code> - row key for the update.</dd><dd><code>cf</code> - the column family to which to add the updates generated by this operation.</dd><dd><code>prefix</code> - the prefix that identify the CQL3 row this operation applies to.</dd><dd><code>params</code> - parameters of the update.</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> </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/Operation.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/MultiColumnRelation.html" title="class in org.apache.cassandra.cql3"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cql3/Operation.Addition.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/Operation.html" target="_top">Frames</a></li> <li><a href="Operation.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><a href="#nested_class_summary">Nested</a> | </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>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>