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, Cloneable

Direct Known Subclasses:

NIOFSDirectory.NIOFSIndexInput

Enclosing class:

SimpleFSDirectory

protected static class SimpleFSDirectory.SimpleFSIndexInput
extends BufferedIndexInput

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SimpleFSDirectory.SimpleFSIndexInput.Descriptor

Field Summary

Fields

Modifier and Type	Field and Description
protected int	chunkSize
protected long	end
protected SimpleFSDirectory.SimpleFSIndexInput.Descriptor	file
protected long	off

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, File path, IOContext context, int chunkSize)
SimpleFSDirectory.SimpleFSIndexInput(String resourceDesc, SimpleFSDirectory.SimpleFSIndexInput.Descriptor file, long off, long length, int bufferSize, int chunkSize)

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.
void	copyBytes(IndexOutput out, long numBytes) Copies numBytes bytes to the given IndexOutput.
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

Methods inherited from class java.lang.Object

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

Field Detail

file

protected final SimpleFSDirectory.SimpleFSIndexInput.Descriptor file

chunkSize

protected final int chunkSize

off

protected final long off

end

protected final long end

Constructor Detail

SimpleFSDirectory.SimpleFSIndexInput

public SimpleFSDirectory.SimpleFSIndexInput(String resourceDesc,
                                    File path,
                                    IOContext context,
                                    int chunkSize)
                                     throws IOException

Throws:

IOException

SimpleFSDirectory.SimpleFSIndexInput

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

Method Detail

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

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 class IndexInput

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)

length

public long length()

Description copied from class: IndexInput

The number of bytes in the file.

Specified by:

length in class IndexInput

clone

public SimpleFSDirectory.SimpleFSIndexInput clone()

Description copied from class: DataInput

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.

Overrides:

clone in class BufferedIndexInput

copyBytes

public void copyBytes(IndexOutput out,
             long numBytes)
               throws IOException

Description copied from class: IndexInput

Copies numBytes bytes to the given IndexOutput.

NOTE: this method uses an intermediate buffer to copy the bytes. Consider overriding it in your implementation, if you can make a better, optimized copy.

NOTE ensure that there are enough bytes in the input to copy to output. Otherwise, different exceptions may be thrown, depending on the implementation.

Overrides:

copyBytes in class BufferedIndexInput

Throws:

IOException