01: /*
02: * Copyright 2004-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16:
17: package org.compass.core.lucene.engine.spellcheck;
18:
19: import org.apache.lucene.index.IndexReader;
20: import org.apache.lucene.search.spell.CompassSpellChecker;
21: import org.compass.core.engine.SearchEngineException;
22:
23: /**
24: * A callback to perform {@link org.apache.lucene.search.spell.CompassSpellChecker} operations with.
25: *
26: * @author kimchy
27: */
28: public interface SpellCheckerCallback<T> {
29:
30: /**
31: * A callback to execute speckk check operations.
32: *
33: * <p>Note, this callback might have the spellChecker as <code>null</code>. This means there is no
34: * spell index yet present.
35: */
36: T execute(CompassSpellChecker spellChecker, IndexReader reader)
37: throws SearchEngineException;
38: }
|