org.terrier.compression.bit

Class MemorySBOS

java.lang.Object

org.terrier.compression.bit.BitOutputStream

org.terrier.compression.bit.BitByteOutputStream

org.terrier.compression.bit.MemorySBOS

All Implemented Interfaces:

Closeable, AutoCloseable, BitOut

public class MemorySBOS
extends BitByteOutputStream

This class extends the BitByteOutputStream, so it provides the compression writing functions, but uses a MemoryOutputStream as an underlying OutputStream, so it is needed to be flushed to disk separately. It uses BitByteOutputStream and not BitOutputStream because the MemoryOutputStream class has already its own buffer (to keep everything in memory), and extra buffering is inadequate.

Author:

Roi Blanco

Field Summary

Fields

Modifier and Type	Field and Description
protected MemoryOutputStream	mos The underlying MemoryOutputStream

Fields inherited from class org.terrier.compression.bit.BitByteOutputStream

byteToWrite

Fields inherited from class org.terrier.compression.bit.BitOutputStream

bitOffset, buffer, bufferPointer, bufferSize, byteOffset, DEFAULT_SIZE, dos, logger

Constructor Summary

Constructors

Constructor and Description
MemorySBOS() Constructor for the class.

Method Summary

Methods

Modifier and Type	Method and Description
MemoryOutputStream	getMOS()
int	getSize() Return the amount of memory bytes consumed by the underlying buffer
String	toString() Writes the underlying MemoryOutputStream in String format.

Methods inherited from class org.terrier.compression.bit.BitByteOutputStream

close, getBitOffset, getByteOffset, getByteToWrite, pad, writeInt, writeUnary

Methods inherited from class org.terrier.compression.bit.BitOutputStream

append, append, flush, padAndFlush, writeBinary, writeDelta, writeGamma, writeGolomb, writeInterpolativeCode, writeMinimalBinary, writeSkewedGolomb

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

mos

protected MemoryOutputStream mos

The underlying MemoryOutputStream

Constructor Detail

MemorySBOS

public MemorySBOS()
           throws IOException

Constructor for the class. Instanciates the BitByteOutputStream and MemoryOutputStream classes.

Throws:

IOException - if an I/O error occurs.

Method Detail

toString

public String toString()

Writes the underlying MemoryOutputStream in String format.

Overrides:

toString in class Object

getMOS

public MemoryOutputStream getMOS()

Returns:

The underlying MemoryOutputStream.

getSize

public int getSize()

Return the amount of memory bytes consumed by the underlying buffer