UNPKG

cassandra-server

Version:

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

380 lines (379 loc) 17.2 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>Constants.Literal (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="Constants.Literal (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/Constants.Literal.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/Constants.Deleter.html" title="class in org.apache.cassandra.cql3"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cql3/Constants.Marker.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/Constants.Literal.html" target="_top">Frames</a></li> <li><a href="Constants.Literal.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</div> <h2 title="Class Constants.Literal" class="title">Class Constants.Literal</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.cql3.Constants.Literal</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="../../../../org/apache/cassandra/cql3/AssignementTestable.html" title="interface in org.apache.cassandra.cql3">AssignementTestable</a>, <a href="../../../../org/apache/cassandra/cql3/Term.Raw.html" title="interface in org.apache.cassandra.cql3">Term.Raw</a></dd> </dl> <dl> <dt>Enclosing class:</dt> <dd><a href="../../../../org/apache/cassandra/cql3/Constants.html" title="class in org.apache.cassandra.cql3">Constants</a></dd> </dl> <hr> <br> <pre>public static class <span class="strong">Constants.Literal</span> extends java.lang.Object implements <a href="../../../../org/apache/cassandra/cql3/Term.Raw.html" title="interface in org.apache.cassandra.cql3">Term.Raw</a></pre> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ========== 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/cql3/Constants.Literal.html" title="class in org.apache.cassandra.cql3">Constants.Literal</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html#bool(java.lang.String)">bool</a></strong>(java.lang.String&nbsp;text)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html" title="class in org.apache.cassandra.cql3">Constants.Literal</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html#floatingPoint(java.lang.String)">floatingPoint</a></strong>(java.lang.String&nbsp;text)</code>&nbsp;</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/Constants.Literal.html#getRawText()">getRawText</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html" title="class in org.apache.cassandra.cql3">Constants.Literal</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html#hex(java.lang.String)">hex</a></strong>(java.lang.String&nbsp;text)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html" title="class in org.apache.cassandra.cql3">Constants.Literal</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html#integer(java.lang.String)">integer</a></strong>(java.lang.String&nbsp;text)</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/Constants.Literal.html#isAssignableTo(java.lang.String,%20org.apache.cassandra.cql3.ColumnSpecification)">isAssignableTo</a></strong>(java.lang.String&nbsp;keyspace, <a href="../../../../org/apache/cassandra/cql3/ColumnSpecification.html" title="class in org.apache.cassandra.cql3">ColumnSpecification</a>&nbsp;receiver)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/cql3/Constants.Value.html" title="class in org.apache.cassandra.cql3">Constants.Value</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html#prepare(java.lang.String,%20org.apache.cassandra.cql3.ColumnSpecification)">prepare</a></strong>(java.lang.String&nbsp;keyspace, <a href="../../../../org/apache/cassandra/cql3/ColumnSpecification.html" title="class in org.apache.cassandra.cql3">ColumnSpecification</a>&nbsp;receiver)</code> <div class="block">This method validates this RawTerm is valid for provided column specification and "prepare" this RawTerm, returning the resulting prepared Term.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html" title="class in org.apache.cassandra.cql3">Constants.Literal</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html#string(java.lang.String)">string</a></strong>(java.lang.String&nbsp;text)</code>&nbsp;</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/Constants.Literal.html#toString()">toString</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html" title="class in org.apache.cassandra.cql3">Constants.Literal</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html#uuid(java.lang.String)">uuid</a></strong>(java.lang.String&nbsp;text)</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, 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="string(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>string</h4> <pre>public static&nbsp;<a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html" title="class in org.apache.cassandra.cql3">Constants.Literal</a>&nbsp;string(java.lang.String&nbsp;text)</pre> </li> </ul> <a name="integer(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>integer</h4> <pre>public static&nbsp;<a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html" title="class in org.apache.cassandra.cql3">Constants.Literal</a>&nbsp;integer(java.lang.String&nbsp;text)</pre> </li> </ul> <a name="floatingPoint(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>floatingPoint</h4> <pre>public static&nbsp;<a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html" title="class in org.apache.cassandra.cql3">Constants.Literal</a>&nbsp;floatingPoint(java.lang.String&nbsp;text)</pre> </li> </ul> <a name="uuid(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>uuid</h4> <pre>public static&nbsp;<a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html" title="class in org.apache.cassandra.cql3">Constants.Literal</a>&nbsp;uuid(java.lang.String&nbsp;text)</pre> </li> </ul> <a name="bool(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>bool</h4> <pre>public static&nbsp;<a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html" title="class in org.apache.cassandra.cql3">Constants.Literal</a>&nbsp;bool(java.lang.String&nbsp;text)</pre> </li> </ul> <a name="hex(java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hex</h4> <pre>public static&nbsp;<a href="../../../../org/apache/cassandra/cql3/Constants.Literal.html" title="class in org.apache.cassandra.cql3">Constants.Literal</a>&nbsp;hex(java.lang.String&nbsp;text)</pre> </li> </ul> <a name="prepare(java.lang.String, org.apache.cassandra.cql3.ColumnSpecification)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>prepare</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/cql3/Constants.Value.html" title="class in org.apache.cassandra.cql3">Constants.Value</a>&nbsp;prepare(java.lang.String&nbsp;keyspace, <a href="../../../../org/apache/cassandra/cql3/ColumnSpecification.html" title="class in org.apache.cassandra.cql3">ColumnSpecification</a>&nbsp;receiver) throws <a href="../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></pre> <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/cassandra/cql3/Term.Raw.html#prepare(java.lang.String,%20org.apache.cassandra.cql3.ColumnSpecification)">Term.Raw</a></code></strong></div> <div class="block">This method validates this RawTerm is valid for provided column specification and "prepare" this RawTerm, returning the resulting prepared Term.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/cql3/Term.Raw.html#prepare(java.lang.String,%20org.apache.cassandra.cql3.ColumnSpecification)">prepare</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/cql3/Term.Raw.html" title="interface in org.apache.cassandra.cql3">Term.Raw</a></code></dd> <dd><code>receiver</code> - the "column" this RawTerm is supposed to be a value of. Note that the ColumnSpecification may not correspond to a real column in the case this RawTerm describe a list index or a map key, etc...</dd> <dt><span class="strong">Returns:</span></dt><dd>the prepared term.</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="getRawText()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getRawText</h4> <pre>public&nbsp;java.lang.String&nbsp;getRawText()</pre> </li> </ul> <a name="isAssignableTo(java.lang.String, org.apache.cassandra.cql3.ColumnSpecification)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isAssignableTo</h4> <pre>public&nbsp;boolean&nbsp;isAssignableTo(java.lang.String&nbsp;keyspace, <a href="../../../../org/apache/cassandra/cql3/ColumnSpecification.html" title="class in org.apache.cassandra.cql3">ColumnSpecification</a>&nbsp;receiver)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/cql3/AssignementTestable.html#isAssignableTo(java.lang.String,%20org.apache.cassandra.cql3.ColumnSpecification)">isAssignableTo</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/cql3/AssignementTestable.html" title="interface in org.apache.cassandra.cql3">AssignementTestable</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>whether this object can be assigned to the provided receiver</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/Constants.Literal.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/Constants.Deleter.html" title="class in org.apache.cassandra.cql3"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cql3/Constants.Marker.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/Constants.Literal.html" target="_top">Frames</a></li> <li><a href="Constants.Literal.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>