UNPKG

cassandra-server

Version:

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

438 lines (437 loc) 19 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:30 CEST 2014 --> <title>TriggerDefinition (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="TriggerDefinition (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/TriggerDefinition.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/config/SeedProviderDef.html" title="class in org.apache.cassandra.config"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/config/UTMetaData.html" title="class in org.apache.cassandra.config"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/config/TriggerDefinition.html" target="_top">Frames</a></li> <li><a href="TriggerDefinition.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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.config</div> <h2 title="Class TriggerDefinition" class="title">Class TriggerDefinition</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.config.TriggerDefinition</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">TriggerDefinition</span> extends java.lang.Object</pre> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <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">&nbsp;</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>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/TriggerDefinition.html#classOption">classOption</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/TriggerDefinition.html#name">name</a></strong></code>&nbsp;</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">&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>static <a href="../../../../org/apache/cassandra/config/TriggerDefinition.html" title="class in org.apache.cassandra.config">TriggerDefinition</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/TriggerDefinition.html#create(java.lang.String,%20java.lang.String)">create</a></strong>(java.lang.String&nbsp;name, java.lang.String&nbsp;classOption)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/TriggerDefinition.html#deleteFromSchema(org.apache.cassandra.db.Mutation,%20java.lang.String,%20long)">deleteFromSchema</a></strong>(<a href="../../../../org/apache/cassandra/db/Mutation.html" title="class in org.apache.cassandra.db">Mutation</a>&nbsp;mutation, java.lang.String&nbsp;cfName, long&nbsp;timestamp)</code> <div class="block">Drop specified trigger from the schema using given mutation.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/TriggerDefinition.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object&nbsp;o)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static java.util.List&lt;<a href="../../../../org/apache/cassandra/config/TriggerDefinition.html" title="class in org.apache.cassandra.config">TriggerDefinition</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/TriggerDefinition.html#fromSchema(org.apache.cassandra.db.Row)">fromSchema</a></strong>(<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>&nbsp;serializedTriggers)</code> <div class="block">Deserialize triggers from storage-level representation.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.util.Map&lt;java.lang.String,<a href="../../../../org/apache/cassandra/config/TriggerDefinition.html" title="class in org.apache.cassandra.config">TriggerDefinition</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/TriggerDefinition.html#fromThrift(java.util.List)">fromThrift</a></strong>(java.util.List&lt;<a href="../../../../org/apache/cassandra/thrift/TriggerDef.html" title="class in org.apache.cassandra.thrift">TriggerDef</a>&gt;&nbsp;thriftDefs)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/config/TriggerDefinition.html" title="class in org.apache.cassandra.config">TriggerDefinition</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/TriggerDefinition.html#fromThrift(org.apache.cassandra.thrift.TriggerDef)">fromThrift</a></strong>(<a href="../../../../org/apache/cassandra/thrift/TriggerDef.html" title="class in org.apache.cassandra.thrift">TriggerDef</a>&nbsp;thriftDef)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/TriggerDefinition.html#hashCode()">hashCode</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/TriggerDefinition.html#toSchema(org.apache.cassandra.db.Mutation,%20java.lang.String,%20long)">toSchema</a></strong>(<a href="../../../../org/apache/cassandra/db/Mutation.html" title="class in org.apache.cassandra.db">Mutation</a>&nbsp;mutation, java.lang.String&nbsp;cfName, long&nbsp;timestamp)</code> <div class="block">Add specified trigger to the schema using given mutation.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/TriggerDefinition.html#toString()">toString</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/thrift/TriggerDef.html" title="class in org.apache.cassandra.thrift">TriggerDef</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/TriggerDefinition.html#toThrift()">toThrift</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.util.List&lt;<a href="../../../../org/apache/cassandra/thrift/TriggerDef.html" title="class in org.apache.cassandra.thrift">TriggerDef</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/TriggerDefinition.html#toThrift(java.util.Map)">toThrift</a></strong>(java.util.Map&lt;java.lang.String,<a href="../../../../org/apache/cassandra/config/TriggerDefinition.html" title="class in org.apache.cassandra.config">TriggerDefinition</a>&gt;&nbsp;triggers)</code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class&nbsp;java.lang.Object</h3> <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field_detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="name"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>name</h4> <pre>public final&nbsp;java.lang.String name</pre> </li> </ul> <a name="classOption"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>classOption</h4> <pre>public final&nbsp;java.lang.String classOption</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="create(java.lang.String, java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>create</h4> <pre>public static&nbsp;<a href="../../../../org/apache/cassandra/config/TriggerDefinition.html" title="class in org.apache.cassandra.config">TriggerDefinition</a>&nbsp;create(java.lang.String&nbsp;name, java.lang.String&nbsp;classOption)</pre> </li> </ul> <a name="fromSchema(org.apache.cassandra.db.Row)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>fromSchema</h4> <pre>public static&nbsp;java.util.List&lt;<a href="../../../../org/apache/cassandra/config/TriggerDefinition.html" title="class in org.apache.cassandra.config">TriggerDefinition</a>&gt;&nbsp;fromSchema(<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>&nbsp;serializedTriggers)</pre> <div class="block">Deserialize triggers from storage-level representation.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>serializedTriggers</code> - storage-level partition containing the trigger definitions</dd> <dt><span class="strong">Returns:</span></dt><dd>the list of processed TriggerDefinitions</dd></dl> </li> </ul> <a name="toSchema(org.apache.cassandra.db.Mutation, java.lang.String, long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toSchema</h4> <pre>public&nbsp;void&nbsp;toSchema(<a href="../../../../org/apache/cassandra/db/Mutation.html" title="class in org.apache.cassandra.db">Mutation</a>&nbsp;mutation, java.lang.String&nbsp;cfName, long&nbsp;timestamp)</pre> <div class="block">Add specified trigger to the schema using given mutation.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>mutation</code> - The schema mutation</dd><dd><code>cfName</code> - The name of the parent ColumnFamily</dd><dd><code>timestamp</code> - The timestamp to use for the columns</dd></dl> </li> </ul> <a name="deleteFromSchema(org.apache.cassandra.db.Mutation, java.lang.String, long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>deleteFromSchema</h4> <pre>public&nbsp;void&nbsp;deleteFromSchema(<a href="../../../../org/apache/cassandra/db/Mutation.html" title="class in org.apache.cassandra.db">Mutation</a>&nbsp;mutation, java.lang.String&nbsp;cfName, long&nbsp;timestamp)</pre> <div class="block">Drop specified trigger from the schema using given mutation.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>mutation</code> - The schema mutation</dd><dd><code>cfName</code> - The name of the parent ColumnFamily</dd><dd><code>timestamp</code> - The timestamp to use for the tombstone</dd></dl> </li> </ul> <a name="fromThrift(org.apache.cassandra.thrift.TriggerDef)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>fromThrift</h4> <pre>public static&nbsp;<a href="../../../../org/apache/cassandra/config/TriggerDefinition.html" title="class in org.apache.cassandra.config">TriggerDefinition</a>&nbsp;fromThrift(<a href="../../../../org/apache/cassandra/thrift/TriggerDef.html" title="class in org.apache.cassandra.thrift">TriggerDef</a>&nbsp;thriftDef)</pre> </li> </ul> <a name="toThrift()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toThrift</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/thrift/TriggerDef.html" title="class in org.apache.cassandra.thrift">TriggerDef</a>&nbsp;toThrift()</pre> </li> </ul> <a name="fromThrift(java.util.List)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>fromThrift</h4> <pre>public static&nbsp;java.util.Map&lt;java.lang.String,<a href="../../../../org/apache/cassandra/config/TriggerDefinition.html" title="class in org.apache.cassandra.config">TriggerDefinition</a>&gt;&nbsp;fromThrift(java.util.List&lt;<a href="../../../../org/apache/cassandra/thrift/TriggerDef.html" title="class in org.apache.cassandra.thrift">TriggerDef</a>&gt;&nbsp;thriftDefs)</pre> </li> </ul> <a name="toThrift(java.util.Map)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toThrift</h4> <pre>public static&nbsp;java.util.List&lt;<a href="../../../../org/apache/cassandra/thrift/TriggerDef.html" title="class in org.apache.cassandra.thrift">TriggerDef</a>&gt;&nbsp;toThrift(java.util.Map&lt;java.lang.String,<a href="../../../../org/apache/cassandra/config/TriggerDefinition.html" title="class in org.apache.cassandra.config">TriggerDefinition</a>&gt;&nbsp;triggers)</pre> </li> </ul> <a name="equals(java.lang.Object)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>equals</h4> <pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;o)</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="hashCode()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hashCode</h4> <pre>public&nbsp;int&nbsp;hashCode()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="toString()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> <pre>public&nbsp;java.lang.String&nbsp;toString()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>toString</code>&nbsp;in class&nbsp;<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/TriggerDefinition.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/config/SeedProviderDef.html" title="class in org.apache.cassandra.config"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/config/UTMetaData.html" title="class in org.apache.cassandra.config"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/config/TriggerDefinition.html" target="_top">Frames</a></li> <li><a href="TriggerDefinition.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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>