org.apache.lucene.store

Class SimpleFSDirectory.SimpleFSIndexInput

java.lang.Object

org.apache.lucene.store.DataInput

org.apache.lucene.store.IndexInput

org.apache.lucene.store.BufferedIndexInput

org.apache.lucene.store.SimpleFSDirectory.SimpleFSIndexInput

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable

Enclosing class:

SimpleFSDirectory

protected static class SimpleFSDirectory.SimpleFSIndexInput
extends BufferedIndexInput

Reads bytes with RandomAccessFile.seek(long) followed by RandomAccessFile.read(byte[], int, int).

Field Summary

Fields

Modifier and Type	Field and Description
protected long	end end offset (start+length)
protected RandomAccessFile	file the file channel we will read from
protected long	off start offset: non-zero in the slice case

Fields inherited from class org.apache.lucene.store.BufferedIndexInput

buffer, BUFFER_SIZE, MERGE_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
SimpleFSDirectory.SimpleFSIndexInput(String resourceDesc, RandomAccessFile file, IOContext context)
SimpleFSDirectory.SimpleFSIndexInput(String resourceDesc, RandomAccessFile file, long off, long length, int bufferSize)

Method Summary

Methods

Modifier and Type	Method and Description
SimpleFSDirectory.SimpleFSIndexInput	clone() Returns a clone of this stream.
void	close() Closes the stream to further operations.
long	length() The number of bytes in the file.
protected void	readInternal(byte[] b, int offset, int len) IndexInput methods
protected void	seekInternal(long position) Expert: implements seek.

Methods inherited from class org.apache.lucene.store.BufferedIndexInput

bufferSize, flushBuffer, getBufferSize, getFilePointer, newBuffer, readByte, readBytes, readBytes, readInt, readLong, readShort, readVInt, readVLong, seek, setBufferSize

Methods inherited from class org.apache.lucene.store.IndexInput

toString

Methods inherited from class org.apache.lucene.store.DataInput

readString, readStringSet, readStringStringMap, skipBytes

Methods inherited from class java.lang.Object

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

Field Detail

file

protected final RandomAccessFile file

the file channel we will read from

off

protected final long off

start offset: non-zero in the slice case

end

protected final long end

end offset (start+length)

Constructor Detail

SimpleFSDirectory.SimpleFSIndexInput

public SimpleFSDirectory.SimpleFSIndexInput(String resourceDesc,
                                    RandomAccessFile file,
                                    IOContext context)
                                     throws IOException

Throws:

IOException

SimpleFSDirectory.SimpleFSIndexInput

public SimpleFSDirectory.SimpleFSIndexInput(String resourceDesc,
                                    RandomAccessFile file,
                                    long off,
                                    long length,
                                    int bufferSize)

Method Detail

close

public void close()
           throws IOException

Description copied from class: IndexInput

Closes the stream to further operations.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class IndexInput

Throws:

IOException

clone

public SimpleFSDirectory.SimpleFSIndexInput clone()

Description copied from class: IndexInput

Returns a clone of this stream.

Clones of a stream access the same data, and are positioned at the same point as the stream they were cloned from.

Expert: Subclasses must ensure that clones may be positioned at different points in the input from each other and from the stream they were cloned from.

Warning: Lucene never closes cloned IndexInputs, it will only do this on the original one. The original instance must take care that cloned instances throw AlreadyClosedException when the original one is closed.

Overrides:

clone in class BufferedIndexInput

length

public final long length()

Description copied from class: IndexInput

The number of bytes in the file.

Specified by:

length in class IndexInput

readInternal

protected void readInternal(byte[] b,
                int offset,
                int len)
                     throws IOException

IndexInput methods

Specified by:

readInternal in class BufferedIndexInput

Parameters:

b - the array to read bytes into

offset - the offset in the array to start storing bytes

len - the number of bytes to read

Throws:

IOException

seekInternal

protected void seekInternal(long position)

Description copied from class: BufferedIndexInput

Expert: implements seek. Sets current position in this file, where the next BufferedIndexInput.readInternal(byte[],int,int) will occur.

Specified by:

seekInternal in class BufferedIndexInput

See Also:

BufferedIndexInput.readInternal(byte[],int,int)