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>CompressionMetadata (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/CompressionMetadata.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/CompressedThrottledReader.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/CompressionMetadata.Chunk.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.html" target="_top">Frames</a></li> <li><a href="CompressionMetadata.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><a href="#nested_class_summary">Nested</a> | </li> <li><a href="#field_summary">Field</a> | </li> <li>Constr | </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>Constr | </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.io.compress</div> <h2 title="Class CompressionMetadata" class="title">Class CompressionMetadata</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.io.compress.CompressionMetadata</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">CompressionMetadata</span> extends java.lang.Object</pre> <div class="block">Holds metadata about compressed file</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <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/compress/CompressionMetadata.Chunk.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata.Chunk</a></strong></code> <div class="block">Holds offset and length of the file chunk</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static class </code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.Writer.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata.Writer</a></strong></code> </td> </tr> </table> </li> </ul>  <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>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html#compressedFileLength">compressedFileLength</a></strong></code> </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.html#dataLength">dataLength</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/io/compress/CompressionMetadata.html#hasPostCompressionAdlerChecksums">hasPostCompressionAdlerChecksums</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/compress/CompressionMetadata.html#indexFilePath">indexFilePath</a></strong></code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/io/compress/CompressionParameters.html" title="class in org.apache.cassandra.io.compress">CompressionParameters</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html#parameters">parameters</a></strong></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><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.Chunk.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata.Chunk</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html#chunkFor(long)">chunkFor</a></strong>(long position)</code> <div class="block">Get a chunk of compressed data (offset, length) corresponding to given position</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html#chunkLength()">chunkLength</a></strong>()</code> </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.html#close()">close</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/io/compress/ICompressor.html" title="interface in org.apache.cassandra.io.compress">ICompressor</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html#compressor()">compressor</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <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.html#create(java.lang.String)">create</a></strong>(java.lang.String dataFilePath)</code> <div class="block">Create metadata about given compressed file including uncompressed data length, chunk size and list of the chunk offsets of the compressed data.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.Chunk.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata.Chunk</a>[]</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html#getChunksForSections(java.util.Collection)">getChunksForSections</a></strong>(java.util.Collection<<a href="../../../../../org/apache/cassandra/utils/Pair.html" title="class in org.apache.cassandra.utils">Pair</a><java.lang.Long,java.lang.Long>> sections)</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, 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">  <ul class="blockList"> <li class="blockList"><a name="field_detail">  </a> <h3>Field Detail</h3> <a name="dataLength">  </a> <ul class="blockList"> <li class="blockList"> <h4>dataLength</h4> <pre>public final long dataLength</pre> </li> </ul> <a name="compressedFileLength">  </a> <ul class="blockList"> <li class="blockList"> <h4>compressedFileLength</h4> <pre>public final long compressedFileLength</pre> </li> </ul> <a name="hasPostCompressionAdlerChecksums">  </a> <ul class="blockList"> <li class="blockList"> <h4>hasPostCompressionAdlerChecksums</h4> <pre>public final boolean hasPostCompressionAdlerChecksums</pre> </li> </ul> <a name="indexFilePath">  </a> <ul class="blockList"> <li class="blockList"> <h4>indexFilePath</h4> <pre>public final java.lang.String indexFilePath</pre> </li> </ul> <a name="parameters">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>parameters</h4> <pre>public final <a href="../../../../../org/apache/cassandra/io/compress/CompressionParameters.html" title="class in org.apache.cassandra.io.compress">CompressionParameters</a> parameters</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="create(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>create</h4> <pre>public static <a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata</a> create(java.lang.String dataFilePath)</pre> <div class="block">Create metadata about given compressed file including uncompressed data length, chunk size and list of the chunk offsets of the compressed data. This is an expensive operation! Don't create more than one for each sstable.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>dataFilePath</code> - Path to the compressed file</dd> <dt><span class="strong">Returns:</span></dt><dd>metadata about given compressed file.</dd></dl> </li> </ul> <a name="compressor()">  </a> <ul class="blockList"> <li class="blockList"> <h4>compressor</h4> <pre>public <a href="../../../../../org/apache/cassandra/io/compress/ICompressor.html" title="interface in org.apache.cassandra.io.compress">ICompressor</a> compressor()</pre> </li> </ul> <a name="chunkLength()">  </a> <ul class="blockList"> <li class="blockList"> <h4>chunkLength</h4> <pre>public int chunkLength()</pre> </li> </ul> <a name="chunkFor(long)">  </a> <ul class="blockList"> <li class="blockList"> <h4>chunkFor</h4> <pre>public <a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.Chunk.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata.Chunk</a> chunkFor(long position)</pre> <div class="block">Get a chunk of compressed data (offset, length) corresponding to given position</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>position</code> - Position in the file.</dd> <dt><span class="strong">Returns:</span></dt><dd>pair of chunk offset and length.</dd></dl> </li> </ul> <a name="getChunksForSections(java.util.Collection)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getChunksForSections</h4> <pre>public <a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.Chunk.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata.Chunk</a>[] getChunksForSections(java.util.Collection<<a href="../../../../../org/apache/cassandra/utils/Pair.html" title="class in org.apache.cassandra.utils">Pair</a><java.lang.Long,java.lang.Long>> sections)</pre> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sections</code> - Collection of sections in uncompressed file</dd> <dt><span class="strong">Returns:</span></dt><dd>Array of chunks which corresponds to given sections of uncompressed file, sorted by chunk offset</dd></dl> </li> </ul> <a name="close()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>close</h4> <pre>public void close()</pre> </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/CompressionMetadata.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/CompressedThrottledReader.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/CompressionMetadata.Chunk.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.html" target="_top">Frames</a></li> <li><a href="CompressionMetadata.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><a href="#nested_class_summary">Nested</a> | </li> <li><a href="#field_summary">Field</a> | </li> <li>Constr | </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>Constr | </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>