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>CompressedRandomAccessReader (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/CompressedRandomAccessReader.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>Prev Class</li> <li><a href="../../../../../org/apache/cassandra/io/compress/CompressedSequentialWriter.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/CompressedRandomAccessReader.html" target="_top">Frames</a></li> <li><a href="CompressedRandomAccessReader.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_classes_inherited_from_class_org.apache.cassandra.io.util.RandomAccessReader">Nested</a> | </li> <li><a href="#fields_inherited_from_class_org.apache.cassandra.io.util.RandomAccessReader">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>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>   <div class="header"> <div class="subTitle">org.apache.cassandra.io.compress</div> <h2 title="Class CompressedRandomAccessReader" class="title">Class CompressedRandomAccessReader</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>java.io.RandomAccessFile</li> <li> <ul class="inheritance"> <li><a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html" title="class in org.apache.cassandra.io.util">org.apache.cassandra.io.util.RandomAccessReader</a></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.io.compress.CompressedRandomAccessReader</li> </ul> </li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.io.Closeable, java.io.DataInput, java.io.DataOutput, java.lang.AutoCloseable, <a href="../../../../../org/apache/cassandra/io/util/FileDataInput.html" title="interface in org.apache.cassandra.io.util">FileDataInput</a></dd> </dl> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../../../org/apache/cassandra/io/compress/CompressedThrottledReader.html" title="class in org.apache.cassandra.io.compress">CompressedThrottledReader</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">CompressedRandomAccessReader</span> extends <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html" title="class in org.apache.cassandra.io.util">RandomAccessReader</a></pre> <div class="block">CRAR extends RAR to transparently uncompress blocks from the file into RAR.buffer. Most of the RAR "read bytes from the buffer, rebuffering when necessary" machinery works unchanged after that.</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> <ul class="blockList"> <li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.cassandra.io.util.RandomAccessReader">  </a> <h3>Nested classes/interfaces inherited from class org.apache.cassandra.io.util.<a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html" title="class in org.apache.cassandra.io.util">RandomAccessReader</a></h3> <code><a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.BufferedRandomAccessFileMark.html" title="class in org.apache.cassandra.io.util">RandomAccessReader.BufferedRandomAccessFileMark</a></code></li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="field_summary">  </a> <h3>Field Summary</h3> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.io.util.RandomAccessReader">  </a> <h3>Fields inherited from class org.apache.cassandra.io.util.<a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html" title="class in org.apache.cassandra.io.util">RandomAccessReader</a></h3> <code><a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#buffer">buffer</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#bufferOffset">bufferOffset</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#CACHE_FLUSH_INTERVAL_IN_BYTES">CACHE_FLUSH_INTERVAL_IN_BYTES</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#channel">channel</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#current">current</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#DEFAULT_BUFFER_SIZE">DEFAULT_BUFFER_SIZE</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#markedPointer">markedPointer</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#owner">owner</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#validBufferBytes">validBufferBytes</a></code></li> </ul> </li> </ul>  <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="colFirst" scope="col">Modifier</th> <th class="colLast" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected </code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressedRandomAccessReader.html#CompressedRandomAccessReader(java.lang.String,%20org.apache.cassandra.io.compress.CompressionMetadata,%20org.apache.cassandra.io.util.PoolingSegmentedFile)">CompressedRandomAccessReader</a></strong>(java.lang.String dataFilePath, <a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata</a> metadata, <a href="../../../../../org/apache/cassandra/io/util/PoolingSegmentedFile.html" title="class in org.apache.cassandra.io.util">PoolingSegmentedFile</a> owner)</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>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressedRandomAccessReader.html#getTotalBufferSize()">getTotalBufferSize</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/CompressedRandomAccessReader.html#length()">length</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/io/compress/CompressedRandomAccessReader.html" title="class in org.apache.cassandra.io.compress">CompressedRandomAccessReader</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressedRandomAccessReader.html#open(java.lang.String,%20org.apache.cassandra.io.compress.CompressionMetadata)">open</a></strong>(java.lang.String dataFilePath, <a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata</a> metadata)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/io/compress/CompressedRandomAccessReader.html" title="class in org.apache.cassandra.io.compress">CompressedRandomAccessReader</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/compress/CompressedRandomAccessReader.html#open(java.lang.String,%20org.apache.cassandra.io.compress.CompressionMetadata,%20org.apache.cassandra.io.util.CompressedPoolingSegmentedFile)">open</a></strong>(java.lang.String path, <a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata</a> metadata, <a href="../../../../../org/apache/cassandra/io/util/CompressedPoolingSegmentedFile.html" title="class in org.apache.cassandra.io.util">CompressedPoolingSegmentedFile</a> owner)</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/compress/CompressedRandomAccessReader.html#reBuffer()">reBuffer</a></strong>()</code> <div class="block">Read data from file starting from current currentOffset to populate buffer.</div> </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/CompressedRandomAccessReader.html#toString()">toString</a></strong>()</code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.io.util.RandomAccessReader">  </a> <h3>Methods inherited from class org.apache.cassandra.io.util.<a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html" title="class in org.apache.cassandra.io.util">RandomAccessReader</a></h3> <code><a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#bufferCursor()">bufferCursor</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#bytesPastMark()">bytesPastMark</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#bytesPastMark(org.apache.cassandra.io.util.FileMark)">bytesPastMark</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#bytesRemaining()">bytesRemaining</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#close()">close</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#deallocate()">deallocate</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#getFilePointer()">getFilePointer</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#getPath()">getPath</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#getPosition()">getPosition</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#isEOF()">isEOF</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#mark()">mark</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#open(java.io.File)">open</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#open(java.io.File,%20org.apache.cassandra.io.util.PoolingSegmentedFile)">open</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#read()">read</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#read(byte[])">read</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#read(byte[],%20int,%20int)">read</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#readBytes(int)">readBytes</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#reset()">reset</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#reset(org.apache.cassandra.io.util.FileMark)">reset</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#resetBuffer()">resetBuffer</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#seek(long)">seek</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#write(byte[])">write</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#write(byte[],%20int,%20int)">write</a>, <a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#write(int)">write</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.io.RandomAccessFile">  </a> <h3>Methods inherited from class java.io.RandomAccessFile</h3> <code>getChannel, getFD, readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, setLength, skipBytes, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeDouble, writeFloat, writeInt, writeLong, writeShort, writeUTF</code></li> </ul> <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, wait, wait, wait</code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.io.DataInput">  </a> <h3>Methods inherited from interface java.io.DataInput</h3> <code>readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, skipBytes</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="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="CompressedRandomAccessReader(java.lang.String, org.apache.cassandra.io.compress.CompressionMetadata, org.apache.cassandra.io.util.PoolingSegmentedFile)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>CompressedRandomAccessReader</h4> <pre>protected CompressedRandomAccessReader(java.lang.String dataFilePath, <a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata</a> metadata, <a href="../../../../../org/apache/cassandra/io/util/PoolingSegmentedFile.html" title="class in org.apache.cassandra.io.util">PoolingSegmentedFile</a> owner) throws java.io.FileNotFoundException</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.io.FileNotFoundException</code></dd></dl> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="open(java.lang.String, org.apache.cassandra.io.compress.CompressionMetadata, org.apache.cassandra.io.util.CompressedPoolingSegmentedFile)">  </a> <ul class="blockList"> <li class="blockList"> <h4>open</h4> <pre>public static <a href="../../../../../org/apache/cassandra/io/compress/CompressedRandomAccessReader.html" title="class in org.apache.cassandra.io.compress">CompressedRandomAccessReader</a> open(java.lang.String path, <a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata</a> metadata, <a href="../../../../../org/apache/cassandra/io/util/CompressedPoolingSegmentedFile.html" title="class in org.apache.cassandra.io.util">CompressedPoolingSegmentedFile</a> owner)</pre> </li> </ul> <a name="open(java.lang.String, org.apache.cassandra.io.compress.CompressionMetadata)">  </a> <ul class="blockList"> <li class="blockList"> <h4>open</h4> <pre>public static <a href="../../../../../org/apache/cassandra/io/compress/CompressedRandomAccessReader.html" title="class in org.apache.cassandra.io.compress">CompressedRandomAccessReader</a> open(java.lang.String dataFilePath, <a href="../../../../../org/apache/cassandra/io/compress/CompressionMetadata.html" title="class in org.apache.cassandra.io.compress">CompressionMetadata</a> metadata)</pre> </li> </ul> <a name="reBuffer()">  </a> <ul class="blockList"> <li class="blockList"> <h4>reBuffer</h4> <pre>protected void reBuffer()</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#reBuffer()">RandomAccessReader</a></code></strong></div> <div class="block">Read data from file starting from current currentOffset to populate buffer.</div> <dl> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#reBuffer()">reBuffer</a></code> in class <code><a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html" title="class in org.apache.cassandra.io.util">RandomAccessReader</a></code></dd> </dl> </li> </ul> <a name="getTotalBufferSize()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getTotalBufferSize</h4> <pre>public int getTotalBufferSize()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#getTotalBufferSize()">getTotalBufferSize</a></code> in class <code><a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html" title="class in org.apache.cassandra.io.util">RandomAccessReader</a></code></dd> </dl> </li> </ul> <a name="length()">  </a> <ul class="blockList"> <li class="blockList"> <h4>length</h4> <pre>public long length()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#length()">length</a></code> in class <code><a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html" title="class in org.apache.cassandra.io.util">RandomAccessReader</a></code></dd> </dl> </li> </ul> <a name="toString()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> <pre>public java.lang.String toString()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html#toString()">toString</a></code> in class <code><a href="../../../../../org/apache/cassandra/io/util/RandomAccessReader.html" title="class in org.apache.cassandra.io.util">RandomAccessReader</a></code></dd> </dl> </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/CompressedRandomAccessReader.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>Prev Class</li> <li><a href="../../../../../org/apache/cassandra/io/compress/CompressedSequentialWriter.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/CompressedRandomAccessReader.html" target="_top">Frames</a></li> <li><a href="CompressedRandomAccessReader.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_classes_inherited_from_class_org.apache.cassandra.io.util.RandomAccessReader">Nested</a> | </li> <li><a href="#fields_inherited_from_class_org.apache.cassandra.io.util.RandomAccessReader">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>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>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>