com.gisgraphy.fulltext.spell

## Interface ISpellCheckerIndexer

- All Known Implementing Classes:
    SpellCheckerIndexer

      public interface ISpellCheckerIndexer

  Author:
    David Masclet

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,Boolean>` | `buildAllIndex()` Re-index all the SpellCheckerDictionaryNames
    `boolean` | `buildIndex(com.gisgraphy.fulltext.spell.SpellCheckerDictionaryNames spellCheckerDictionaryName)` re-index the dictionary for the specified spellchecker dictionary name

- - ### Method Detail

    - #### buildAllIndex

          Map<String,Boolean> buildAllIndex()

      Re-index all the SpellCheckerDictionaryNames
      Returns:
        a map with dictioanry name as key and boolean as value. the boolean is equal to true if the index has succeed for the dictionary
      Throws:
        `a` - `SpellCheckerException` if the spellChecker is not alive or if an error occured

    - #### buildIndex

          boolean buildIndex(com.gisgraphy.fulltext.spell.SpellCheckerDictionaryNames spellCheckerDictionaryName)

      re-index the dictionary for the specified spellchecker dictionary name
      Parameters:
        `spellCheckerDictionaryName` - the spellChecker Dictionary to index / re-index
      Throws:
        `a` - `SpellCheckerException` if the spellChecker is not alive or if an error occured

Copyright © 2015. All rights reserved.