| org.compass.core.engine.SearchEngineOptimizer
All known Subclasses: org.compass.core.lucene.engine.optimizer.LuceneSearchEngineOptimizerManager,
| SearchEngineOptimizer | | public interface SearchEngineOptimizer (Code) | | Optimizes search engine index data.
Using it, one can controll the lifecycle of the optimizer using the
start() and stop() methods (note that does not
mean that it will start a scheduled optimizer, it depends on the
configuration supplied).
You can also check if the search engine required optimization using the
needOptimization() method, and run the optimization process
using the optimize() method.
author:
kimchy |
| Method Summary | |
| boolean | isRunning()
Returns true if the optimizer is running. | | void | optimize()
Optimizes the search engine index if it requires optimization. | | void | optimize(String subIndex)
Optimizes the sub index if it requires optimization. | | void | start()
Starts the given optimizer. | | void | stop()
Stops the given optimizer. |
| isRunning | | boolean isRunning()(Code) | | Returns true if the optimizer is running.
true if the optimizer is running |
| stop | | void stop() throws SearchEngineException(Code) | | 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.
throws:
SearchEngineException - |
|
|