Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Tree: 5895934145
Fetching contributors…

Cannot retrieve contributors at this time

1002 lines (270 sloc) 11.213 kB
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Marshal</title>
<script src="http://shjs.sourceforge.net/sh_main.min.js"> </script>
<script src="http://shjs.sourceforge.net/lang/sh_javascript.min.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/node-dark.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Marshal</h1>
<section>
<header>
<h2>
Marshal
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Marshal"><span class="type-signature"></span>new Marshal</h4>
</dt>
<dd>
<p class="description">
Creates a Serialization/Deserialization object for a column family
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
String
</td>
<td class="description last">The type to create the marshaller for (eg. 'BytesType' or 'org.apache...CompositeType(BytesType,UTF8Type))</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>index.js, line 201</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="TYPES"><span class="type-signature">&lt;private, static> </span>TYPES<span class="type-signature"></span></h4>
</dt>
<dd>
<p class="description">
Supported types for marshalling
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>index.js, line 17</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="deserialize"><span class="type-signature"></span>deserialize</h4>
</dt>
<dd>
<p class="description">
Deserializes data for the type specified
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value(s)</code></td>
<td class="type">
Object
</td>
<td class="description last">The value, or values if type is Composite, to deserialize</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>index.js, line 223</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="serialize"><span class="type-signature"></span>serialize</h4>
</dt>
<dd>
<p class="description">
Serializes data for the type specified
</p>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value(s)</code></td>
<td class="type">
Object
</td>
<td class="description last">The value, or values if type is Composite, to serialize</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>index.js, line 216</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="compositeDeserializer"><span class="type-signature">&lt;private, static> </span>compositeDeserializer</h4>
</dt>
<dd>
<p class="description">
Creates a deserializer for composite types
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>index.js, line 141</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="compositeSerializer"><span class="type-signature">&lt;private, static> </span>compositeSerializer</h4>
</dt>
<dd>
<p class="description">
Creates a serializer for composite types
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>index.js, line 101</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getCompositeTypes"><span class="type-signature">&lt;private, static> </span>getCompositeTypes</h4>
</dt>
<dd>
<p class="description">
Returns an array of types for composite columns
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>index.js, line 63</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getDeserializer"><span class="type-signature">&lt;private, static> </span>getDeserializer</h4>
</dt>
<dd>
<p class="description">
Gets the deserializer(s) for a specific type
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>index.js, line 181</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getInnerType"><span class="type-signature">&lt;private, static> </span>getInnerType</h4>
</dt>
<dd>
<p class="description">
Returns the type string inside of the parentheses
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>index.js, line 53</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getSerializer"><span class="type-signature">&lt;private, static> </span>getSerializer</h4>
</dt>
<dd>
<p class="description">
Gets the serializer(s) for a specific type
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>index.js, line 163</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getType"><span class="type-signature">&lt;private, static> </span>getType</h4>
</dt>
<dd>
<p class="description">
Given a string like org.apache.cassandra.db.marshal.UTF8Type
return a string of UTF8Type
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>index.js, line 43</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
TypeName
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="NOOP"><span class="type-signature">&lt;private, static> </span>NOOP</h4>
</dt>
<dd>
<p class="description">
No-Operation
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>index.js, line 10</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="parseTypeString"><span class="type-signature">&lt;private, static> </span>parseTypeString</h4>
</dt>
<dd>
<p class="description">
Parses the type string and decides what types to return
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>index.js, line 84</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h3>Classes</h3><ul><li><a href="Column.html">Column</a></li><li><a href="ColumnFamily.html">ColumnFamily</a></li><li><a href="Connection.html">Connection</a></li><li><a href="Deserializers.html">Deserializers</a></li><li><a href="Helenus.html">Helenus</a></li><li><a href="Keyspace.html">Keyspace</a></li><li><a href="Marshal.html">Marshal</a></li><li><a href="Pool.html">Pool</a></li><li><a href="Row.html">Row</a></li><li><a href="Serializers.html">Serializers</a></li><li><a href="TimeUUID.html">TimeUUID</a></li><li><a href="UUID.html">UUID</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Fri Apr 20 2012 11:58:20 GMT-0400 (EDT)
</footer>
<script> sh_highlightDocument(); </script>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.