org.apache.paimon.io.cache

Class FileBasedRandomInputView

java.lang.Object

org.apache.paimon.data.AbstractPagedInputView

org.apache.paimon.io.cache.FileBasedRandomInputView

All Implemented Interfaces:

Closeable, DataInput, AutoCloseable, DataInputView, SeekableDataInputView

public class FileBasedRandomInputView
extends AbstractPagedInputView
implements SeekableDataInputView, Closeable

A SeekableDataInputView to read bytes from RandomAccessFile, the bytes can be cached to MemorySegments in CacheManager.

Constructor Summary

Constructors

Constructor and Description
FileBasedRandomInputView(PageFileInput input, CacheManager cacheManager)

Method Summary

Modifier and Type	Method and Description
void	close()
protected int	getLimitForSegment(MemorySegment segment) Gets the limit for reading bytes from the given memory segment.
protected MemorySegment	nextSegment(MemorySegment current) The method by which concrete subclasses realize page crossing.
void	setReadPosition(long position) Sets the read pointer to the given position.

Methods inherited from class org.apache.paimon.data.AbstractPagedInputView

advance, clear, doAdvance, getCurrentPositionInSegment, getCurrentSegment, getCurrentSegmentLimit, read, read, readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, seekInput, skipBytes, skipBytesToRead

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.paimon.io.DataInputView

read, read, skipBytesToRead

Methods inherited from interface java.io.DataInput

readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, skipBytes

Constructor Detail

FileBasedRandomInputView

public FileBasedRandomInputView(PageFileInput input,
                                CacheManager cacheManager)

Method Detail

setReadPosition

public void setReadPosition(long position)

Description copied from interface: SeekableDataInputView

Sets the read pointer to the given position.

Specified by:

setReadPosition in interface SeekableDataInputView

Parameters:

position - The new read position.

nextSegment

protected MemorySegment nextSegment(MemorySegment current)
                             throws EOFException

Description copied from class: AbstractPagedInputView

The method by which concrete subclasses realize page crossing. This method is invoked when the current page is exhausted and a new page is required to continue the reading. If no further page is available, this method must throw an EOFException.

Specified by:

nextSegment in class AbstractPagedInputView

Parameters:

current - The current page that was read to its limit. May be null, if this method is invoked for the first time.

Returns:

The next page from which the reading should continue. May not be null. If the input is exhausted, an EOFException must be thrown instead.

Throws:

EOFException - Thrown, if no further segment is available.

getLimitForSegment

protected int getLimitForSegment(MemorySegment segment)

Description copied from class: AbstractPagedInputView

Gets the limit for reading bytes from the given memory segment. This method must return the position of the byte after the last valid byte in the given memory segment. When the position returned by this method is reached, the view will attempt to switch to the next memory segment.

Specified by:

getLimitForSegment in class AbstractPagedInputView

Parameters:

segment - The segment to determine the limit for.

Returns:

The limit for the given memory segment.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException