org.compass.core.lucene.engine.optimizer
Interface LuceneSearchEngineOptimizer

All Known Implementing Classes:
AbstractIndexInfoOptimizer, AbstractOptimizer, DefaultLuceneSearchEngineOptimizer

public interface LuceneSearchEngineOptimizer

An internal Lucene interface for managing index optimizations.

Author:
kimchy

Method Summary
 boolean canBeScheduled()
          Can the optimizer be scheduled or not.
 void optimize()
          Optimizes the search engine index if it requires optimization.
 void optimize(int maxNumberOfSegments)
          Forces an optimization to occur and maintain to the number of "mergeFactor" segments.
 void optimize(String subIndex)
          Optimizes the sub index if it requires optimization.
 void optimize(String subIndex, int maxNumberOfSegments)
          Forces an optimization to occur for the specific sub index and maintain to the number of "mergeFactor" segments.
 

Method Detail

canBeScheduled

boolean canBeScheduled()
Can the optimizer be scheduled or not.


optimize

void optimize()
              throws SearchEngineException
Optimizes the search engine index if it requires optimization.

Throws:
SearchEngineException

optimize

void optimize(int maxNumberOfSegments)
              throws SearchEngineException
Forces an optimization to occur and maintain to the number of "mergeFactor" segments.

Throws:
SearchEngineException

optimize

void optimize(String subIndex)
              throws SearchEngineException
Optimizes the sub index if it requires optimization.

Parameters:
subIndex - The sub index to optimize
Throws:
SearchEngineException

optimize

void optimize(String subIndex,
              int maxNumberOfSegments)
              throws SearchEngineException
Forces an optimization to occur for the specific sub index and maintain to the number of "mergeFactor" segments.

Throws:
SearchEngineException


Copyright (c) 2004-2009 The Compass Project.