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>Term (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/Term.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/StatementType.html" title="enum in org.apache.cassandra.cql"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cql/UpdateStatement.html" title="class in org.apache.cassandra.cql"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/cql/Term.html" target="_top">Frames</a></li> <li><a href="Term.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 Term" class="title">Class Term</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.cql.Term</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">Term</span> extends java.lang.Object</pre> <div class="block">A term parsed from a CQL statement.</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="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/cql/Term.html#Term()">Term</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code> </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/Term.html#Term(long,%20org.apache.cassandra.cql.TermType)">Term</a></strong>(long value, org.apache.cassandra.cql.TermType type)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code> </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/Term.html#Term(java.lang.String,%20int)">Term</a></strong>(java.lang.String text, int type)</code> <div class="block">Create new Term instance from a string, and an integer that corresponds with the token ID from CQLParser.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code> </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/Term.html#Term(java.lang.String,%20int,%20int)">Term</a></strong>(java.lang.String text, int type, int index)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code> </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/Term.html#Term(java.lang.String,%20org.apache.cassandra.cql.TermType)">Term</a></strong>(java.lang.String text, org.apache.cassandra.cql.TermType type)</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>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/Term.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.nio.ByteBuffer</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/Term.html#getByteBuffer()">getByteBuffer</a></strong>()</code> <div class="block">Returns the typed value, serialized to a ByteBuffer.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.nio.ByteBuffer</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/Term.html#getByteBuffer(org.apache.cassandra.db.marshal.AbstractType,%20java.util.List)">getByteBuffer</a></strong>(<a href="../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a><?> validator, java.util.List<java.nio.ByteBuffer> variables)</code> <div class="block">Returns the typed value, serialized to a ByteBuffer according to a comparator/validator.</div> </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/Term.html#getText()">getText</a></strong>()</code> <div class="block">Returns the text parsed to create this term.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>org.apache.cassandra.cql.TermType</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/Term.html#getType()">getType</a></strong>()</code> <div class="block">Obtain the term's type.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/Term.html#hashCode()">hashCode</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/Term.html#isBindMarker()">isBindMarker</a></strong>()</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/Term.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, finalize, getClass, 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="Term(java.lang.String, org.apache.cassandra.cql.TermType)">  </a> <ul class="blockList"> <li class="blockList"> <h4>Term</h4> <pre>public Term(java.lang.String text, org.apache.cassandra.cql.TermType type)</pre> </li> </ul> <a name="Term(java.lang.String, int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>Term</h4> <pre>public Term(java.lang.String text, int type)</pre> <div class="block">Create new Term instance from a string, and an integer that corresponds with the token ID from CQLParser.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>text</code> - the text representation of the term.</dd><dd><code>type</code> - the term's type as an integer token ID.</dd></dl> </li> </ul> <a name="Term(long, org.apache.cassandra.cql.TermType)">  </a> <ul class="blockList"> <li class="blockList"> <h4>Term</h4> <pre>public Term(long value, org.apache.cassandra.cql.TermType type)</pre> </li> </ul> <a name="Term()">  </a> <ul class="blockList"> <li class="blockList"> <h4>Term</h4> <pre>protected Term()</pre> </li> </ul> <a name="Term(java.lang.String, int, int)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>Term</h4> <pre>public Term(java.lang.String text, int type, int index)</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="getText()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getText</h4> <pre>public java.lang.String getText()</pre> <div class="block">Returns the text parsed to create this term.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>the string term acquired from a CQL statement.</dd></dl> </li> </ul> <a name="getByteBuffer(org.apache.cassandra.db.marshal.AbstractType, java.util.List)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getByteBuffer</h4> <pre>public java.nio.ByteBuffer getByteBuffer(<a href="../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a><?> validator, java.util.List<java.nio.ByteBuffer> variables) throws <a href="../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></pre> <div class="block">Returns the typed value, serialized to a ByteBuffer according to a comparator/validator.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>a ByteBuffer of the value.</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> - if unable to coerce the string to its type.</dd></dl> </li> </ul> <a name="getByteBuffer()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getByteBuffer</h4> <pre>public java.nio.ByteBuffer getByteBuffer() throws <a href="../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></pre> <div class="block">Returns the typed value, serialized to a ByteBuffer.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>a ByteBuffer of the value.</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> - if unable to coerce the string to its type.</dd></dl> </li> </ul> <a name="getType()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getType</h4> <pre>public org.apache.cassandra.cql.TermType getType()</pre> <div class="block">Obtain the term's type.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>the type</dd></dl> </li> </ul> <a name="toString()">  </a> <ul class="blockList"> <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> <a name="isBindMarker()">  </a> <ul class="blockList"> <li class="blockList"> <h4>isBindMarker</h4> <pre>public boolean isBindMarker()</pre> </li> </ul> <a name="hashCode()">  </a> <ul class="blockList"> <li class="blockList"> <h4>hashCode</h4> <pre>public int hashCode()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="equals(java.lang.Object)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>equals</h4> <pre>public boolean equals(java.lang.Object obj)</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>equals</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/Term.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/StatementType.html" title="enum in org.apache.cassandra.cql"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cql/UpdateStatement.html" title="class in org.apache.cassandra.cql"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/cql/Term.html" target="_top">Frames</a></li> <li><a href="Term.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>