View Javadoc
1   /*******************************************************************************
2    *   Gisgraphy Project 
3    * 
4    *   This library is free software; you can redistribute it and/or
5    *   modify it under the terms of the GNU Lesser General Public
6    *   License as published by the Free Software Foundation; either
7    *   version 2.1 of the License, or (at your option) any later version.
8    * 
9    *   This library is distributed in the hope that it will be useful,
10   *   but WITHOUT ANY WARRANTY; without even the implied warranty of
11   *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12   *   Lesser General Public License for more details.
13   * 
14   *   You should have received a copy of the GNU Lesser General Public
15   *   License along with this library; if not, write to the Free Software
16   *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA
17   * 
18   *  Copyright 2008  Gisgraphy project 
19   *  David Masclet <davidmasclet@gisgraphy.com>
20   *  
21   *  
22   *******************************************************************************/
23  package com.gisgraphy.fulltext.spell;
24  
25  import java.util.Map;
26  
27  /**
28   * 
29   * @author <a href="mailto:david.masclet@gisgraphy.com">David Masclet</a>
30   * 
31   */
32  public interface ISpellCheckerIndexer {
33  
34      /**
35       * Re-index all the {@linkplain SpellCheckerDictionaryNames}
36       * 
37       * @throws a
38       *                 {@link SpellCheckerException} if the spellChecker is not
39       *                 alive or if an error occured
40       * @return a map with dictioanry name as key and boolean as value. the
41       *         boolean is equal to true if the index has succeed for the
42       *         dictionary
43       */
44      public Map<String, Boolean> buildAllIndex();
45  
46      /**
47       * re-index the dictionary for the specified spellchecker dictionary name
48       * 
49       * @param spellCheckerDictionaryName
50       *                the spellChecker Dictionary to index / re-index
51       * @throws a
52       *                 {@link SpellCheckerException} if the spellChecker is not
53       *                 alive or if an error occured
54       */
55      public boolean buildIndex(
56  	    SpellCheckerDictionaryNames spellCheckerDictionaryName);
57  
58  }