org.compass.core.impl
Class DefaultCompass.TransactionalSearchEngineOptimizer

java.lang.Object
  org.compass.core.impl.DefaultCompass.TransactionalSearchEngineOptimizer

All Implemented Interfaces:

SearchEngineOptimizer, LuceneSearchEngineOptimizer

Enclosing class:

DefaultCompass

public static class DefaultCompass.TransactionalSearchEngineOptimizer
extends Object
implements LuceneSearchEngineOptimizer

Constructor Summary

DefaultCompass.TransactionalSearchEngineOptimizer(LuceneSearchEngineOptimizer searchEngineOptimizer, Compass compass)

Method Summary

boolean	canBeScheduled() Can the optimizer be scheduled or not.
LuceneSearchEngineFactory	getSearchEngineFactory()
LuceneSearchEngineOptimizer	getWrappedOptimizer()
boolean	isRunning() Returns true if the optimizer is running.
boolean	needOptimization() Returns true if the search engine index requires optimization (depends on the optimizer configured).
boolean	needOptimization(String subIndex) Returns true of the sub index requires optimization (depends on the optimizer configured).
void	optimize() Optimizes the search engine index if it requires optimization.
void	optimize(String subIndex) Optimizes the sub index if it requires optimization.
void	setSearchEngineFactory(LuceneSearchEngineFactory searchEngineFactory)
void	start() Starts the given optimizer.
void	stop() Stops the given optimizer.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCompass.TransactionalSearchEngineOptimizer

public DefaultCompass.TransactionalSearchEngineOptimizer(LuceneSearchEngineOptimizer searchEngineOptimizer,
                                                         Compass compass)

Method Detail

getWrappedOptimizer

public LuceneSearchEngineOptimizer getWrappedOptimizer()

start

public void start()
           throws SearchEngineException

Description copied from interface: SearchEngineOptimizer

Starts the given optimizer. Will start a scheduled optimizer if configured.

Specified by:

start in interface SearchEngineOptimizer

Throws:

SearchEngineException

stop

public void stop()
          throws SearchEngineException

Description copied from interface: SearchEngineOptimizer

Stops the given optimizer. Will stop the scheduled optimizer if configured.

Note that if the optimizer is stopped while optimizing, it might take some time till the optimizer will actually stop.

Specified by:

stop in interface SearchEngineOptimizer

Throws:

SearchEngineException

isRunning

public boolean isRunning()

Description copied from interface: SearchEngineOptimizer

Returns true if the optimizer is running.

Specified by:

isRunning in interface SearchEngineOptimizer

Returns:

true if the optimizer is running

needOptimization

public boolean needOptimization()
                         throws SearchEngineException

Description copied from interface: SearchEngineOptimizer

Returns true if the search engine index requires optimization (depends on the optimizer configured).

Specified by:

needOptimization in interface SearchEngineOptimizer

Returns:

true if the search engine index requires optimization

Throws:

SearchEngineException

optimize

public void optimize()
              throws SearchEngineException

Description copied from interface: SearchEngineOptimizer

Optimizes the search engine index if it requires optimization.

Specified by:

optimize in interface SearchEngineOptimizer

Throws:

SearchEngineException

setSearchEngineFactory

public void setSearchEngineFactory(LuceneSearchEngineFactory searchEngineFactory)

Specified by:

setSearchEngineFactory in interface LuceneSearchEngineOptimizer

getSearchEngineFactory

public LuceneSearchEngineFactory getSearchEngineFactory()

Specified by:

getSearchEngineFactory in interface LuceneSearchEngineOptimizer

canBeScheduled

public boolean canBeScheduled()

Description copied from interface: LuceneSearchEngineOptimizer

Can the optimizer be scheduled or not.

Specified by:

canBeScheduled in interface LuceneSearchEngineOptimizer

needOptimization

public boolean needOptimization(String subIndex)
                         throws SearchEngineException

Description copied from interface: SearchEngineOptimizer

Returns true of the sub index requires optimization (depends on the optimizer configured).

Specified by:

needOptimization in interface SearchEngineOptimizer

Parameters:

subIndex - The sub index to check if needs optimization

Returns:

true if the sub index requires optimization

Throws:

SearchEngineException

optimize

public void optimize(String subIndex)
              throws SearchEngineException

Description copied from interface: SearchEngineOptimizer

Optimizes the sub index if it requires optimization.

Specified by:

optimize in interface SearchEngineOptimizer

Parameters:

subIndex - The sub index to optimize

Throws:

SearchEngineException