cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
559 lines (558 loc) • 23 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>Component (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="Component (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/Component.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/ColumnStats.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/Component.Type.html" title="enum 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/Component.html" target="_top">Frames</a></li>
<li><a href="Component.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><a href="#nested_class_summary">Nested</a> | </li>
<li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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 Component" class="title">Class Component</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.io.sstable.Component</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">Component</span>
extends java.lang.Object</pre>
<div class="block">SSTables are made up of multiple components in separate files. Components are
identified by a type and an id, but required unique components (such as the Data
and Index files) may have implicit ids assigned to them.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.Type.html" title="enum in org.apache.cassandra.io.sstable">Component.Type</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- =========== 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"> </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>static <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#COMPRESSION_INFO">COMPRESSION_INFO</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#CRC">CRC</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#DATA">DATA</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#DIGEST">DIGEST</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#FILTER">FILTER</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#hashCode">hashCode</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#name">name</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#PRIMARY_INDEX">PRIMARY_INDEX</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static char</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#separator">separator</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#STATS">STATS</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#SUMMARY">SUMMARY</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#TOC">TOC</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/io/sstable/Component.Type.html" title="enum in org.apache.cassandra.io.sstable">Component.Type</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#type">type</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/Component.html#Component(org.apache.cassandra.io.sstable.Component.Type)">Component</a></strong>(<a href="../../../../../org/apache/cassandra/io/sstable/Component.Type.html" title="enum in org.apache.cassandra.io.sstable">Component.Type</a> type)</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#Component(org.apache.cassandra.io.sstable.Component.Type,%20java.lang.String)">Component</a></strong>(<a href="../../../../../org/apache/cassandra/io/sstable/Component.Type.html" title="enum in org.apache.cassandra.io.sstable">Component.Type</a> type,
java.lang.String name)</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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object o)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/utils/Pair.html" title="class in org.apache.cassandra.utils">Pair</a><<a href="../../../../../org/apache/cassandra/io/sstable/Descriptor.html" title="class in org.apache.cassandra.io.sstable">Descriptor</a>,<a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#fromFilename(java.io.File,%20java.lang.String)">fromFilename</a></strong>(java.io.File directory,
java.lang.String name)</code>
<div class="block">Filename of the form "<ksname>/<cfname>-[tmp-][<version>-]<gen>-<component>",</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.html#hashCode()">hashCode</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/io/sstable/Component.html#name()">name</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/Component.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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="separator">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>separator</h4>
<pre>public static final char separator</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.cassandra.io.sstable.Component.separator">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="DATA">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DATA</h4>
<pre>public static final <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a> DATA</pre>
</li>
</ul>
<a name="PRIMARY_INDEX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PRIMARY_INDEX</h4>
<pre>public static final <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a> PRIMARY_INDEX</pre>
</li>
</ul>
<a name="FILTER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FILTER</h4>
<pre>public static final <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a> FILTER</pre>
</li>
</ul>
<a name="COMPRESSION_INFO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COMPRESSION_INFO</h4>
<pre>public static final <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a> COMPRESSION_INFO</pre>
</li>
</ul>
<a name="STATS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATS</h4>
<pre>public static final <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a> STATS</pre>
</li>
</ul>
<a name="DIGEST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DIGEST</h4>
<pre>public static final <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a> DIGEST</pre>
</li>
</ul>
<a name="CRC">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CRC</h4>
<pre>public static final <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a> CRC</pre>
</li>
</ul>
<a name="SUMMARY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SUMMARY</h4>
<pre>public static final <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a> SUMMARY</pre>
</li>
</ul>
<a name="TOC">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TOC</h4>
<pre>public static final <a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a> TOC</pre>
</li>
</ul>
<a name="type">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public final <a href="../../../../../org/apache/cassandra/io/sstable/Component.Type.html" title="enum in org.apache.cassandra.io.sstable">Component.Type</a> type</pre>
</li>
</ul>
<a name="name">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public final java.lang.String name</pre>
</li>
</ul>
<a name="hashCode">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre>public final int hashCode</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Component(org.apache.cassandra.io.sstable.Component.Type)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Component</h4>
<pre>public Component(<a href="../../../../../org/apache/cassandra/io/sstable/Component.Type.html" title="enum in org.apache.cassandra.io.sstable">Component.Type</a> type)</pre>
</li>
</ul>
<a name="Component(org.apache.cassandra.io.sstable.Component.Type, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Component</h4>
<pre>public Component(<a href="../../../../../org/apache/cassandra/io/sstable/Component.Type.html" title="enum in org.apache.cassandra.io.sstable">Component.Type</a> type,
java.lang.String name)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="name()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public java.lang.String name()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>The unique (within an sstable) name for this component.</dd></dl>
</li>
</ul>
<a name="fromFilename(java.io.File, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromFilename</h4>
<pre>public static <a href="../../../../../org/apache/cassandra/utils/Pair.html" title="class in org.apache.cassandra.utils">Pair</a><<a href="../../../../../org/apache/cassandra/io/sstable/Descriptor.html" title="class in org.apache.cassandra.io.sstable">Descriptor</a>,<a href="../../../../../org/apache/cassandra/io/sstable/Component.html" title="class in org.apache.cassandra.io.sstable">Component</a>> fromFilename(java.io.File directory,
java.lang.String name)</pre>
<div class="block">Filename of the form "<ksname>/<cfname>-[tmp-][<version>-]<gen>-<component>",</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A Descriptor for the SSTable, and a Component for this particular file.
TODO move descriptor into Component field</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="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object o)</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockListLast">
<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>
</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/Component.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/ColumnStats.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/Component.Type.html" title="enum 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/Component.html" target="_top">Frames</a></li>
<li><a href="Component.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><a href="#nested_class_summary">Nested</a> | </li>
<li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>