cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
375 lines (374 loc) • 15.6 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:31 CEST 2014 -->
<title>SSTableLoader.Client (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="SSTableLoader.Client (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/SSTableLoader.Client.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/io/sstable/SSTableLoader.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/io/sstable/SSTableLoader.Client.html" target="_top">Frames</a></li>
<li><a href="SSTableLoader.Client.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: </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>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cassandra.io.sstable</div>
<h2 title="Class SSTableLoader.Client" class="title">Class SSTableLoader.Client</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.io.sstable.SSTableLoader.Client</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../org/apache/cassandra/io/sstable/SSTableLoader.html" title="class in org.apache.cassandra.io.sstable">SSTableLoader</a></dd>
</dl>
<hr>
<br>
<pre>public abstract static class <span class="strong">SSTableLoader.Client</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableLoader.Client.html#SSTableLoader.Client()">SSTableLoader.Client</a></strong>()</code> </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"> </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>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableLoader.Client.html#addRangeForEndpoint(org.apache.cassandra.dht.Range,%20java.net.InetAddress)">addRangeForEndpoint</a></strong>(<a href="../../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>> range,
java.net.InetAddress endpoint)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableLoader.Client.html#getCFMetaData(java.lang.String,%20java.lang.String)">getCFMetaData</a></strong>(java.lang.String keyspace,
java.lang.String cfName)</code>
<div class="block">Validate that <code>keyspace</code> is an existing keyspace and <code>cfName</code> one of its existing column family.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Map<java.net.InetAddress,java.util.Collection<<a href="../../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableLoader.Client.html#getEndpointToRangesMap()">getEndpointToRangesMap</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableLoader.Client.html#getPartitioner()">getPartitioner</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableLoader.Client.html#init(java.lang.String)">init</a></strong>(java.lang.String keyspace)</code>
<div class="block">Initialize the client.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableLoader.Client.html#setPartitioner(org.apache.cassandra.dht.IPartitioner)">setPartitioner</a></strong>(<a href="../../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a> partitioner)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableLoader.Client.html#setPartitioner(java.lang.String)">setPartitioner</a></strong>(java.lang.String partclass)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableLoader.Client.html#stop()">stop</a></strong>()</code>
<div class="block">Stop the client.</div>
</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SSTableLoader.Client()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SSTableLoader.Client</h4>
<pre>public SSTableLoader.Client()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public abstract void init(java.lang.String keyspace)</pre>
<div class="block">Initialize the client.
Perform any step necessary so that after the call to the this
method:
* partitioner is initialized
* getEndpointToRangesMap() returns a correct map
This method is guaranteed to be called before any other method of a
client.</div>
</li>
</ul>
<a name="stop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>public void stop()</pre>
<div class="block">Stop the client.</div>
</li>
</ul>
<a name="getCFMetaData(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCFMetaData</h4>
<pre>public abstract <a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> getCFMetaData(java.lang.String keyspace,
java.lang.String cfName)</pre>
<div class="block">Validate that <code>keyspace</code> is an existing keyspace and <code>cfName</code> one of its existing column family.</div>
</li>
</ul>
<a name="getEndpointToRangesMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEndpointToRangesMap</h4>
<pre>public java.util.Map<java.net.InetAddress,java.util.Collection<<a href="../../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>>> getEndpointToRangesMap()</pre>
</li>
</ul>
<a name="setPartitioner(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPartitioner</h4>
<pre>protected void setPartitioner(java.lang.String partclass)
throws <a href="../../../../../org/apache/cassandra/exceptions/ConfigurationException.html" title="class in org.apache.cassandra.exceptions">ConfigurationException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/cassandra/exceptions/ConfigurationException.html" title="class in org.apache.cassandra.exceptions">ConfigurationException</a></code></dd></dl>
</li>
</ul>
<a name="setPartitioner(org.apache.cassandra.dht.IPartitioner)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPartitioner</h4>
<pre>protected void setPartitioner(<a href="../../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a> partitioner)</pre>
</li>
</ul>
<a name="getPartitioner()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitioner</h4>
<pre>public <a href="../../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a> getPartitioner()</pre>
</li>
</ul>
<a name="addRangeForEndpoint(org.apache.cassandra.dht.Range, java.net.InetAddress)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addRangeForEndpoint</h4>
<pre>protected void addRangeForEndpoint(<a href="../../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>> range,
java.net.InetAddress endpoint)</pre>
</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/SSTableLoader.Client.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/io/sstable/SSTableLoader.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/io/sstable/SSTableLoader.Client.html" target="_top">Frames</a></li>
<li><a href="SSTableLoader.Client.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: </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>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p>
</body>
</html>