org.apache.jackrabbit.oak.plugins.index.lucene.directory

Interface OakIndexFile

public interface OakIndexFile

Method Summary

Modifier and Type	Method and Description
OakIndexFile	clone() Duplicates this instance to be used by a different consumer/thread.
void	close()
void	copyBytes(org.apache.lucene.store.DataInput input, long numBytes) Copy numBytes bytes from input to ourself.
void	flush() Flushes the content into storage.
String	getName()
static OakIndexFile	getOakIndexFile(String name, org.apache.jackrabbit.oak.spi.state.NodeBuilder file, String dirDetails, @NotNull BlobFactory blobFactory)
static OakIndexFile	getOakIndexFile(String name, org.apache.jackrabbit.oak.spi.state.NodeBuilder file, String dirDetails, @NotNull BlobFactory blobFactory, boolean streamingWriteEnabled)
boolean	isClosed()
long	length()
long	position()
void	readBytes(byte[] b, int offset, int len) Read len number of bytes from underlying storage and copy them into byte array b starting at offset
void	seek(long pos) Seek current location of access to pos
boolean	supportsCopyFromDataInput()
void	writeBytes(byte[] b, int offset, int len) Writes len number of bytes from byte array b starting at offset into the underlying storage

Method Detail

getOakIndexFile

static OakIndexFile getOakIndexFile(String name,
                                    org.apache.jackrabbit.oak.spi.state.NodeBuilder file,
                                    String dirDetails,
                                    @NotNull
                                    @NotNull BlobFactory blobFactory)

getOakIndexFile

static OakIndexFile getOakIndexFile(String name,
                                    org.apache.jackrabbit.oak.spi.state.NodeBuilder file,
                                    String dirDetails,
                                    @NotNull
                                    @NotNull BlobFactory blobFactory,
                                    boolean streamingWriteEnabled)

supportsCopyFromDataInput

boolean supportsCopyFromDataInput()

Returns:

if the file implementation supports copying data from DataInput directly.

getName

String getName()

Returns:

name of the index being accessed

length

long length()

Returns:

length of index file

isClosed

boolean isClosed()

close

void close()

position

long position()

Returns:

current location of access

seek

void seek(long pos)
   throws IOException

Seek current location of access to pos

Parameters:

pos -

Throws:

IOException

clone

OakIndexFile clone()

Duplicates this instance to be used by a different consumer/thread. State of the cloned instance is same as original. Once cloned, the states would change separately according to how are they accessed.

Returns:

cloned instance

readBytes

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

Read len number of bytes from underlying storage and copy them into byte array b starting at offset

Parameters:

b - byte array to copy contents read from storage

offset - index into b where the copy begins

len - numeber of bytes to be read from storage

Throws:

IOException

writeBytes

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

Writes len number of bytes from byte array b starting at offset into the underlying storage

Parameters:

b - byte array to copy contents into the storage

offset - index into b where the copy begins

len - numeber of bytes to be written to storage

Throws:

IOException

copyBytes

void copyBytes(org.apache.lucene.store.DataInput input,
               long numBytes)
        throws IOException

Copy numBytes bytes from input to ourself.

Throws:

IOException

flush

void flush()
    throws IOException

Flushes the content into storage. Before calling this method, written content only exist in memory

Throws:

IOException