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

Class OakDirectory

java.lang.Object

Directory

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

public class OakDirectory
extends Directory

Implementation of the Lucene Directory (a flat list of files) based on an Oak NodeBuilder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OakDirectory.BlobFactory
static class	OakDirectory.BlobStoreBlobFactory
static class	OakDirectory.NodeBuilderBlobFactory

Constructor Summary

Constructors

Constructor and Description
OakDirectory(NodeBuilder builder, IndexDefinition definition, boolean readOnly)
OakDirectory(NodeBuilder builder, String dataNodeName, IndexDefinition definition, boolean readOnly)
OakDirectory(NodeBuilder builder, String dataNodeName, IndexDefinition definition, boolean readOnly, GarbageCollectableBlobStore blobStore)
OakDirectory(NodeBuilder builder, String dataNodeName, IndexDefinition definition, boolean readOnly, OakDirectory.BlobFactory blobFactory)

Method Summary

Modifier and Type	Method and Description
void	clearLock(String name)
void	close()
void	copy(OakDirectory dest, String name) Copies the file with the given name to the dest directory.
IndexOutput	createOutput(String name, IOContext context)
void	deleteFile(String name)
boolean	fileExists(String name)
long	fileLength(String name)
LockFactory	getLockFactory()
boolean	isDirty()
String[]	listAll()
Lock	makeLock(String name)
IndexInput	openInput(String name, IOContext context)
void	setLockFactory(LockFactory lockFactory)
void	sync(Collection<String> names)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OakDirectory

public OakDirectory(NodeBuilder builder,
                    IndexDefinition definition,
                    boolean readOnly)

OakDirectory

public OakDirectory(NodeBuilder builder,
                    String dataNodeName,
                    IndexDefinition definition,
                    boolean readOnly)

OakDirectory

public OakDirectory(NodeBuilder builder,
                    String dataNodeName,
                    IndexDefinition definition,
                    boolean readOnly,
                    GarbageCollectableBlobStore blobStore)

OakDirectory

public OakDirectory(NodeBuilder builder,
                    String dataNodeName,
                    IndexDefinition definition,
                    boolean readOnly,
                    OakDirectory.BlobFactory blobFactory)

Method Detail

listAll

public String[] listAll()
                 throws IOException

Throws:

IOException

fileExists

public boolean fileExists(String name)
                   throws IOException

Throws:

IOException

deleteFile

public void deleteFile(String name)
                throws IOException

Throws:

IOException

fileLength

public long fileLength(String name)
                throws IOException

Throws:

IOException

createOutput

public IndexOutput createOutput(String name,
                                IOContext context)
                         throws IOException

Throws:

IOException

openInput

public IndexInput openInput(String name,
                            IOContext context)
                     throws IOException

Throws:

IOException

makeLock

public Lock makeLock(String name)

clearLock

public void clearLock(String name)
               throws IOException

Throws:

IOException

sync

public void sync(Collection<String> names)
          throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Throws:

IOException

setLockFactory

public void setLockFactory(LockFactory lockFactory)
                    throws IOException

Throws:

IOException

getLockFactory

public LockFactory getLockFactory()

toString

public String toString()

copy

public void copy(OakDirectory dest,
                 String name)
          throws IOException

Copies the file with the given name to the dest directory. The file is copied 'by reference'. That is, the file in the destination directory will reference the same blob values as the source file.

This method is a no-op if the file does not exist in this directory.

Parameters:

dest - the destination directory.

name - the name of the file to copy.

Throws:

IOException - if an error occurs while copying the file.

IllegalArgumentException - if the destination directory does not use the same OakDirectory.BlobFactory as this directory.

isDirty

public boolean isDirty()