UNPKG

cassandra-server

Version:

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

327 lines (326 loc) 13.1 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:27 CEST 2014 --> <title>CompressionMetadata.Writer (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="CompressionMetadata.Writer (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/CompressionMetadata.Writer.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/compress/CompressionMetadata.Chunk.html" title="class in org.apache.cassandra.io.compress"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/io/compress/CompressionParameters.html" title="class in org.apache.cassandra.io.compress"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/io/compress/CompressionMetadata.Writer.html" target="_top">Frames</a></li> <li><a href="CompressionMetadata.Writer.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.io.compress</div> <h2 title="Class CompressionMetadata.Writer" class="title">Class CompressionMetadata.Writer</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.io.compress.CompressionMetadata.Writer</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/compress/CompressionMetadata.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata</a></dd> </dl> <hr> <br> <pre>public static class <span class="strong">CompressionMetadata.Writer</span> extends java.lang.Object</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>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.Writer.html#addOffset(long)">addOffset</a></strong>(long&nbsp;offset)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.Writer.html#chunkOffsetBy(int)">chunkOffsetBy</a></strong>(int&nbsp;chunkIndex)</code> <div class="block">Get a chunk offset by it's index.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.Writer.html#close(long,%20int)">close</a></strong>(long&nbsp;dataLength, int&nbsp;chunks)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.Writer.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata.Writer</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.Writer.html#open(org.apache.cassandra.io.compress.CompressionParameters,%20java.lang.String)">open</a></strong>(<a href="../../../../../org/apache/cassandra/io/compress/CompressionParameters.html" title="class in org.apache.cassandra.io.compress">CompressionParameters</a>&nbsp;parameters, java.lang.String&nbsp;path)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.Writer.html#openAfterClose(long,%20long)">openAfterClose</a></strong>(long&nbsp;dataLength, long&nbsp;compressedLength)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.Writer.html#openEarly(long,%20long)">openEarly</a></strong>(long&nbsp;dataLength, long&nbsp;compressedLength)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.Writer.html#resetAndTruncate(int)">resetAndTruncate</a></strong>(int&nbsp;chunkIndex)</code> <div class="block">Reset the writer so that the next chunk offset written will be the one of <code>chunkIndex</code>.</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&nbsp;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"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="open(org.apache.cassandra.io.compress.CompressionParameters, java.lang.String)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>open</h4> <pre>public static&nbsp;<a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.Writer.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata.Writer</a>&nbsp;open(<a href="../../../../../org/apache/cassandra/io/compress/CompressionParameters.html" title="class in org.apache.cassandra.io.compress">CompressionParameters</a>&nbsp;parameters, java.lang.String&nbsp;path)</pre> </li> </ul> <a name="addOffset(long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>addOffset</h4> <pre>public&nbsp;void&nbsp;addOffset(long&nbsp;offset)</pre> </li> </ul> <a name="openEarly(long, long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>openEarly</h4> <pre>public&nbsp;<a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata</a>&nbsp;openEarly(long&nbsp;dataLength, long&nbsp;compressedLength)</pre> </li> </ul> <a name="openAfterClose(long, long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>openAfterClose</h4> <pre>public&nbsp;<a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata</a>&nbsp;openAfterClose(long&nbsp;dataLength, long&nbsp;compressedLength)</pre> </li> </ul> <a name="chunkOffsetBy(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>chunkOffsetBy</h4> <pre>public&nbsp;long&nbsp;chunkOffsetBy(int&nbsp;chunkIndex)</pre> <div class="block">Get a chunk offset by it's index.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>chunkIndex</code> - Index of the chunk.</dd> <dt><span class="strong">Returns:</span></dt><dd>offset of the chunk in the compressed file.</dd></dl> </li> </ul> <a name="resetAndTruncate(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>resetAndTruncate</h4> <pre>public&nbsp;void&nbsp;resetAndTruncate(int&nbsp;chunkIndex)</pre> <div class="block">Reset the writer so that the next chunk offset written will be the one of <code>chunkIndex</code>.</div> </li> </ul> <a name="close(long, int)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>close</h4> <pre>public&nbsp;void&nbsp;close(long&nbsp;dataLength, int&nbsp;chunks) throws java.io.IOException</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</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/CompressionMetadata.Writer.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/compress/CompressionMetadata.Chunk.html" title="class in org.apache.cassandra.io.compress"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/io/compress/CompressionParameters.html" title="class in org.apache.cassandra.io.compress"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/io/compress/CompressionMetadata.Writer.html" target="_top">Frames</a></li> <li><a href="CompressionMetadata.Writer.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>