com.jalios.jcms.search
Class SpellSuggestEngine

java.lang.Object
  extended by com.jalios.jcms.QueryFilter
      extended by com.jalios.jcms.search.SpellSuggestEngine
All Implemented Interfaces:
JcmsConstants, PluginComponent, JaliosConstants, Comparable

public class SpellSuggestEngine
extends QueryFilter
implements JcmsConstants

This engine can be used when doing text search. It suggests alternative text based on a lucene Spell Checker. This lucene SpellChecker is populated from a Dictionnary created using Publication and Category lucene search engine index.

Since:
jcms-5.5.0
Version:
$Revision: 22056 $
Author:
Olivier Jaquemet

Field Summary
static String REVISION
           
 
Fields inherited from class com.jalios.jcms.QueryFilter
BACKOFFICE_SEARCH, FRONTOFFICE_SEARCH, order, PORTLET_QUERY
 
Fields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CRYPT_MD5, CRYPT_UNDEFINED, CRYPT_UNIX, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML
 
Fields inherited from interface com.jalios.util.JaliosConstants
CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR
 
Constructor Summary
SpellSuggestEngine()
           
 
Method Summary
 void clearSpellChecker()
          Remove all words from the spellchecker
 int getHitsThreshold()
           
 String getIndexingSchedule()
           
 float getScoreThreshold()
           
 SpellChecker getSpellChecker()
           
 org.apache.lucene.store.Directory getSpellCheckerIndexDir()
           
 float getWordsThreshold()
           
 boolean isIndexing()
           
 void populateSpellChecker()
          Build the spellChecker index from the lucene publication search engine and from the lucene category search engine.
 void setHitsThreshold(int hitsNbr)
          Set the number of hits below which a suggestion should be searched and proposed.
 void setScoreThreshold(float score)
          Set the score below which a suggestion should be searched and proposed.
 void setWordsThreshold(int wordsNbr)
          Set the number of words above which a suggestion is NOT proposed.
 
Methods inherited from class com.jalios.jcms.QueryFilter
compareTo, equals, filterQueryHandler, filterResultSet, getSearchDefault, getSearchDescription, getSearchLabel, getSearchParam, init, isBackOfficeSearch, isFrontOfficeSearch, isPortletQuery
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REVISION

public static final String REVISION
See Also:
Constant Field Values
Constructor Detail

SpellSuggestEngine

public SpellSuggestEngine()
                   throws Exception
Throws:
Exception
Method Detail

isIndexing

public boolean isIndexing()

clearSpellChecker

public void clearSpellChecker()
Remove all words from the spellchecker


populateSpellChecker

public void populateSpellChecker()
Build the spellChecker index from the lucene publication search engine and from the lucene category search engine.


getSpellCheckerIndexDir

public org.apache.lucene.store.Directory getSpellCheckerIndexDir()
Returns:
the SpellChecker index directory used by this SpellSuggestEngine.

getSpellChecker

public SpellChecker getSpellChecker()
Returns:
the SpellChecker used by this SpellSuggestEngine.

getIndexingSchedule

public String getIndexingSchedule()
Returns:
the indexing schedule

getHitsThreshold

public int getHitsThreshold()
Returns:
the number of hits below which a suggestion should be searched and proposed.

setHitsThreshold

public void setHitsThreshold(int hitsNbr)
Set the number of hits below which a suggestion should be searched and proposed.

Parameters:
hitsNbr - a number of hits

getScoreThreshold

public float getScoreThreshold()
Returns:
the score below which a suggestion should be searched and proposed.

setScoreThreshold

public void setScoreThreshold(float score)
Set the score below which a suggestion should be searched and proposed.

Parameters:
score - a score value

getWordsThreshold

public float getWordsThreshold()
Returns:
the number of words above which a suggestion is NOT proposed.

setWordsThreshold

public void setWordsThreshold(int wordsNbr)
Set the number of words above which a suggestion is NOT proposed.

Parameters:
wordsNbr - a number of words


Copyright © 2001-2007 Jalios SA. All Rights Reserved.