org.compass.core.lucene.engine.store
Class AbstractLuceneSearchEngineStore

java.lang.Object
  org.compass.core.lucene.engine.store.AbstractLuceneSearchEngineStore

All Implemented Interfaces:

LuceneSearchEngineStore

Direct Known Subclasses:

FSLuceneSearchEngineStore, JdbcLuceneSearchEngineStore, RAMLuceneSearchEngineStore

public abstract class AbstractLuceneSearchEngineStore
extends Object
implements LuceneSearchEngineStore

Author:

kimchy

Nested Class Summary

protected class

AbstractLuceneSearchEngineStore.CopyFromHolder

Nested classes/interfaces inherited from interface org.compass.core.lucene.engine.store.LuceneSearchEngineStore

LuceneSearchEngineStore.LuceneStoreCallback

Field Summary

protected org.apache.commons.logging.Log	log
protected LuceneStoreTemplate	template

Constructor Summary

AbstractLuceneSearchEngineStore()

Method Summary

String[]	calcSubIndexes(String[] subIndexes, String[] aliases) Returns the sub indexes that intersect with the given sub indexes and aliases provided.
void	close() Closes the store.
void	closeDirectory(Directory dir) Closes the given directory.
void	configure(LuceneSearchEngineFactory searchEngineFactory, CompassSettings settings, CompassMapping mapping) Configures the store.
void	copyFrom(LuceneSearchEngineStore searchEngineStore) Copies the index from the given store into the current store.
void	createIndex() Creates the index (if it is already exists, delets it first).
protected void	doAfterFailedCopyFrom(AbstractLuceneSearchEngineStore.CopyFromHolder holder)
protected void	doAfterSuccessfulCopyFrom(AbstractLuceneSearchEngineStore.CopyFromHolder holder)
protected AbstractLuceneSearchEngineStore.CopyFromHolder	doBeforeCopyFrom()
protected void	doClose()
protected abstract Directory	doGetDirectoryForPath(String path, boolean create)
Directory	getDirectoryByAlias(String alias, boolean create) Returns the directory that maps to the given alias.
Directory	getDirectoryBySubIndex(String subIndex, boolean create) Returns the directory that match the given sub index.
LuceneSettings	getLuceneSettings() Returns the lucene settings.
int	getNumberOfAliasesByAlias(String alias) Returns the number of aliaes that map to the sub index that is derived by the given alias.
int	getNumberOfAliasesBySubIndex(String subIndex) Returns the number of aliases that map to the given sub index.
String[]	getSubIndexes() Returns all the sub indexes defined within the store.
String	getSubIndexForAlias(String alias) Returns the sub index value that match the given alias.
boolean	indexExists() Returns true if one of the sub indexes index does not exists.
protected Boolean	indexExists(Directory dir)
protected boolean	indexExists(String subIndex)
void	performScheduledTasks() Performs any scheduled tasks, managed by the index manager.
void	registerEventListeners(SearchEngine searchEngine, SearchEngineEventManager eventManager) A callback to register event listeners when a SearchEngine is created.
String	toString()
boolean	verifyIndex() Verify that the index exists.
protected boolean	verifyIndex(String subIndex)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.compass.core.lucene.engine.store.LuceneSearchEngineStore

deleteIndex

Field Detail

log

protected org.apache.commons.logging.Log log

template

protected LuceneStoreTemplate template

Constructor Detail

AbstractLuceneSearchEngineStore

public AbstractLuceneSearchEngineStore()

Method Detail

configure

public void configure(LuceneSearchEngineFactory searchEngineFactory,
                      CompassSettings settings,
                      CompassMapping mapping)

Description copied from interface: LuceneSearchEngineStore

Configures the store.

Specified by:

configure in interface LuceneSearchEngineStore

close

public void close()

Description copied from interface: LuceneSearchEngineStore

Closes the store.

Specified by:

close in interface LuceneSearchEngineStore

doClose

protected void doClose()

performScheduledTasks

public void performScheduledTasks()

Description copied from interface: LuceneSearchEngineStore

Performs any scheduled tasks, managed by the index manager.

Specified by:

performScheduledTasks in interface LuceneSearchEngineStore

closeDirectory

public void closeDirectory(Directory dir)
                    throws SearchEngineException

Description copied from interface: LuceneSearchEngineStore

Closes the given directory.

Specified by:

closeDirectory in interface LuceneSearchEngineStore

Throws:

SearchEngineException

getSubIndexForAlias

public String getSubIndexForAlias(String alias)

Description copied from interface: LuceneSearchEngineStore

Returns the sub index value that match the given alias.

Specified by:

getSubIndexForAlias in interface LuceneSearchEngineStore

getNumberOfAliasesByAlias

public int getNumberOfAliasesByAlias(String alias)

Description copied from interface: LuceneSearchEngineStore

Returns the number of aliaes that map to the sub index that is derived by the given alias.

Specified by:

getNumberOfAliasesByAlias in interface LuceneSearchEngineStore

getNumberOfAliasesBySubIndex

public int getNumberOfAliasesBySubIndex(String subIndex)

Description copied from interface: LuceneSearchEngineStore

Returns the number of aliases that map to the given sub index.

Specified by:

getNumberOfAliasesBySubIndex in interface LuceneSearchEngineStore

getDirectoryByAlias

public Directory getDirectoryByAlias(String alias,
                                     boolean create)
                              throws SearchEngineException

Description copied from interface: LuceneSearchEngineStore

Returns the directory that maps to the given alias.

Specified by:

getDirectoryByAlias in interface LuceneSearchEngineStore

Throws:

SearchEngineException

getDirectoryBySubIndex

public Directory getDirectoryBySubIndex(String subIndex,
                                        boolean create)
                                 throws SearchEngineException

Description copied from interface: LuceneSearchEngineStore

Returns the directory that match the given sub index.

Specified by:

getDirectoryBySubIndex in interface LuceneSearchEngineStore

Throws:

SearchEngineException

doGetDirectoryForPath

protected abstract Directory doGetDirectoryForPath(String path,
                                                   boolean create)
                                            throws SearchEngineException

Throws:

SearchEngineException

indexExists

protected boolean indexExists(String subIndex)
                       throws SearchEngineException

Throws:

SearchEngineException

indexExists

protected Boolean indexExists(Directory dir)
                       throws IOException

Throws:

IOException

verifyIndex

protected boolean verifyIndex(String subIndex)
                       throws SearchEngineException

Throws:

SearchEngineException

createIndex

public void createIndex()
                 throws SearchEngineException

Description copied from interface: LuceneSearchEngineStore

Creates the index (if it is already exists, delets it first).

Specified by:

createIndex in interface LuceneSearchEngineStore

Throws:

SearchEngineException

verifyIndex

public boolean verifyIndex()
                    throws SearchEngineException

Description copied from interface: LuceneSearchEngineStore

Verify that the index exists. If the index exists, nothing happens, if it does not, the index is created.

Specified by:

verifyIndex in interface LuceneSearchEngineStore

Throws:

SearchEngineException

indexExists

public boolean indexExists()
                    throws SearchEngineException

Description copied from interface: LuceneSearchEngineStore

Returns true if one of the sub indexes index does not exists.

Specified by:

indexExists in interface LuceneSearchEngineStore

Throws:

SearchEngineException

getSubIndexes

public String[] getSubIndexes()

Description copied from interface: LuceneSearchEngineStore

Returns all the sub indexes defined within the store.

Specified by:

getSubIndexes in interface LuceneSearchEngineStore

calcSubIndexes

public String[] calcSubIndexes(String[] subIndexes,
                               String[] aliases)

Description copied from interface: LuceneSearchEngineStore

Returns the sub indexes that intersect with the given sub indexes and aliases provided. If the sub indexes and aliases are null, return all the sub indexes.

Specified by:

calcSubIndexes in interface LuceneSearchEngineStore

registerEventListeners

public void registerEventListeners(SearchEngine searchEngine,
                                   SearchEngineEventManager eventManager)

Description copied from interface: LuceneSearchEngineStore

A callback to register event listeners when a SearchEngine is created.

Specified by:

registerEventListeners in interface LuceneSearchEngineStore

Parameters:

searchEngine - The search engine created

eventManager - The event manager to register events with

copyFrom

public void copyFrom(LuceneSearchEngineStore searchEngineStore)
              throws SearchEngineException

Description copied from interface: LuceneSearchEngineStore

Copies the index from the given store into the current store.

Specified by:

copyFrom in interface LuceneSearchEngineStore

Parameters:

searchEngineStore - The store to copy from

Throws:

SearchEngineException

doBeforeCopyFrom

protected AbstractLuceneSearchEngineStore.CopyFromHolder doBeforeCopyFrom()
                                                                   throws SearchEngineException

Throws:

SearchEngineException

doAfterSuccessfulCopyFrom

protected void doAfterSuccessfulCopyFrom(AbstractLuceneSearchEngineStore.CopyFromHolder holder)
                                  throws SearchEngineException

Throws:

SearchEngineException

doAfterFailedCopyFrom

protected void doAfterFailedCopyFrom(AbstractLuceneSearchEngineStore.CopyFromHolder holder)
                              throws SearchEngineException

Throws:

SearchEngineException

getLuceneSettings

public LuceneSettings getLuceneSettings()

Description copied from interface: LuceneSearchEngineStore

Returns the lucene settings.

Specified by:

getLuceneSettings in interface LuceneSearchEngineStore

toString

public String toString()

Overrides:

toString in class Object