Package com.googlecode.luceneappengine

Class GaeDirectory

java.lang.Object

org.apache.lucene.store.Directory

org.apache.lucene.store.BaseDirectory

com.googlecode.luceneappengine.GaeDirectory

All Implemented Interfaces:

Closeable, AutoCloseable

public class GaeDirectory
extends BaseDirectory

Lucene Directory working in google app engine (GAE) environment. Using this Directory you can create multiple indexes, each one identified by a name specified in constructor GaeDirectory(LaeContext, String), for details read constructor documentation. In order to open an index writer is highly recommended the usage of configuration provided by GaeLuceneUtil.getIndexWriterConfig(org.apache.lucene.analysis.Analyzer).

 
 GaeDirectory directory = new GaeDirectory();
 IndexWriterConfig config = GaeLuceneUtil.getIndexWriterConfig(Version.LATEST, analyzer);
 IndexWriter writer = new IndexWriter(directory, config);
 
 

If your application throws NoClassDefFoundError while using GaeDirectory in order to make it work, into your GAE web application, the modified RamUsageEstimator (link to source) in a package named org.apache.lucene.util.

Author:

Fabio Grucci (github: UltimaPhoenix, bitbucket: Dark_Phoenix, googlecode: fabio.grucci)

See Also:

• GaeLuceneUtil
• RamUsageEstimator

Field Summary

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

isOpen, lockFactory

Constructor Summary

Constructors

Constructor	Description
GaeDirectory(LaeContext laeContext)	Create a GaeDirectory with default name "defaultIndex".
GaeDirectory(LaeContext laeContext, LuceneIndex luceneIndex)	Create a GaeDirectory for existing index.
GaeDirectory(LaeContext laeContext, String indexName)	Create a GaeDirectory with specified name, the name specified must be a legal DocumentId name.

Method Summary

Modifier and Type	Method	Description
void	close()
IndexOutput	createOutput(String name, IOContext context)
IndexOutput	createTempOutput(String prefix, String suffix, IOContext context)
void	delete()	Delete this directory.
void	deleteFile(String name)
long	fileLength(String name)
static List<LuceneIndex>	getAvailableIndexes(LaeContext context)	Returns every available indexes created into your GAE application.
Set<String>	getPendingDeletions()
String[]	listAll()
protected Segment	newSegment(String name)	Create a new file in the index.
IndexInput	openInput(String name, IOContext context)
void	rename(String source, String dest)
void	sync(Collection<String> names)
void	syncMetaData()

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

ensureOpen, obtainLock, toString

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

copyFrom, getTempFileName, openChecksumInput

Methods inherited from class java.lang.Object

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

Constructor Details

GaeDirectory

public GaeDirectory(LaeContext laeContext)

Create a GaeDirectory with default name "defaultIndex". Same as GaeDirectory(LaeContext, String) with "defaultIndex".

Parameters:

laeContext - the laecontext

GaeDirectory

public GaeDirectory(LaeContext laeContext,
 String indexName)

Create a GaeDirectory with specified name, the name specified must be a legal DocumentId name.

Parameters:

laeContext - The lae context

indexName - The name of the index

GaeDirectory

public GaeDirectory(LaeContext laeContext,
 LuceneIndex luceneIndex)

Create a GaeDirectory for existing index.

Parameters:

laeContext - The laecontext

luceneIndex - The existing index

Method Details

getAvailableIndexes

public static List<LuceneIndex> getAvailableIndexes(LaeContext context)

Returns every available indexes created into your GAE application. With LuceneIndex you can build GaeDirectory using constructor GaeDirectory(LaeContext, LuceneIndex).

Parameters:

context - The lae context

Returns:

A list of available indexes

delete

public void delete()
            throws IOException

Delete this directory.

Throws:

IOException - If an error occurs

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Directory

Throws:

IOException

getPendingDeletions

public Set<String> getPendingDeletions()

Specified by:

getPendingDeletions in class Directory

openInput

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

Specified by:

openInput in class Directory

Throws:

IOException

createOutput

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

Specified by:

createOutput in class Directory

Throws:

IOException

createTempOutput

public IndexOutput createTempOutput(String prefix,
 String suffix,
 IOContext context)
                             throws IOException

Specified by:

createTempOutput in class Directory

Throws:

IOException

deleteFile

public void deleteFile(String name)

Specified by:

deleteFile in class Directory

rename

public void rename(String source,
 String dest)
            throws IOException

Specified by:

rename in class Directory

Throws:

IOException

fileLength

public long fileLength(String name)
                throws IOException

Specified by:

fileLength in class Directory

Throws:

IOException

listAll

public String[] listAll()

Specified by:

listAll in class Directory

newSegment

protected Segment newSegment(String name)
                      throws ExecutionException,
InterruptedException

Create a new file in the index.

Parameters:

name - The name of the segment/file

Returns:

the instance of the Segment

Throws:

ExecutionException - If an error occurs

InterruptedException - If the thread is interrupted

sync

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

Specified by:

sync in class Directory

Throws:

IOException

syncMetaData

public void syncMetaData()
                  throws IOException

Specified by:

syncMetaData in class Directory

Throws:

IOException