Class ReadableChannelWithBlockAdvertisement

java.lang.Object

org.aksw.commons.util.closeable.AutoCloseableBase

org.aksw.commons.util.closeable.AutoCloseableWithLeakDetectionBase

org.aksw.commons.io.shared.ChannelBase

org.aksw.commons.io.input.ReadableChannelBase<byte[]>

org.aksw.commons.io.hadoop.ReadableChannelWithBlockAdvertisement

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, HasArrayOps<byte[]>, ReadableChannel<byte[]>, ReadableSource<byte[]>

public class ReadableChannelWithBlockAdvertisement
extends ReadableChannelBase<byte[]>

This variant assumes that the underlying encoded stream runs in BLOCK_MODE. Reads are expected to:

1. stop after yielding the first byte of a block (that byte is returned) and
3. these reads always return 1 (never anything greater)
4. the position indicating the block id is updated after that read.

ReadableChannelWithBlockAdvertisementBuffered also assumes that every read stops after yielding the first byte of a block, however the read length may be greater than 1.

Field Summary

Fields

Modifier and Type	Field	Description
protected long	currentPos
protected InputStream	decodedIn
protected int	endOfBlockMarker
protected boolean	hasPendingByte
protected byte	pendingByte
protected long	readCount
protected org.apache.hadoop.fs.Seekable	seekable
protected long	startPos

Fields inherited from class org.aksw.commons.util.closeable.AutoCloseableWithLeakDetectionBase

instantiationStackTrace

Fields inherited from class org.aksw.commons.util.closeable.AutoCloseableBase

closeStackTrace, enableCloseStackTrace, isClosed

Constructor Summary

Constructors

Constructor	Description
ReadableChannelWithBlockAdvertisement(InputStream decodedIn)
ReadableChannelWithBlockAdvertisement(InputStream decodedIn, int endOfBlockMarker)

Method Summary

Modifier and Type	Method	Description
boolean	adjustToNextBlock()	Discard bytes from this channel until a -2 read result is encountered.
ArrayOps<byte[]>	getArrayOps()
long	getCurrentPos()
long	getStartPos()
protected int	onBlockEnd(ByteBuffer dst, long oldPos, long newPos)
long	position()
int	read(byte[] array, int position, int length)

Methods inherited from class ChannelBase

isOpen

Methods inherited from class org.aksw.commons.util.closeable.AutoCloseableWithLeakDetectionBase

finalize, getInstantiationStackTrace

Methods inherited from class org.aksw.commons.util.closeable.AutoCloseableBase

close, closeActual, ensureOpen, throwClosedException

Methods inherited from class Object

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

Methods inherited from interface Channel

close, isOpen

Methods inherited from interface ReadableSource

readRaw

Field Details

decodedIn

protected InputStream decodedIn

seekable

protected org.apache.hadoop.fs.Seekable seekable

startPos

protected long startPos

currentPos

protected long currentPos

pendingByte

protected byte pendingByte

hasPendingByte

protected boolean hasPendingByte

endOfBlockMarker

protected int endOfBlockMarker

readCount

protected long readCount

Constructor Details

ReadableChannelWithBlockAdvertisement

public ReadableChannelWithBlockAdvertisement(InputStream decodedIn)
                                      throws IOException

Throws:

IOException

ReadableChannelWithBlockAdvertisement

public ReadableChannelWithBlockAdvertisement(InputStream decodedIn,
 int endOfBlockMarker)
                                      throws IOException

Throws:

IOException

Method Details

position

public long position()
              throws IOException

Throws:

IOException

getStartPos

public long getStartPos()

getCurrentPos

public long getCurrentPos()

read

public int read(byte[] array,
 int position,
 int length)
         throws IOException

Throws:

IOException

onBlockEnd

protected int onBlockEnd(ByteBuffer dst,
 long oldPos,
 long newPos)

getArrayOps

public ArrayOps<byte[]> getArrayOps()

adjustToNextBlock

public boolean adjustToNextBlock()
                          throws IOException

Discard bytes from this channel until a -2 read result is encountered.

Throws:

IOException