Package com.jalios.jcms.search
Class SpellSuggestEngine
java.lang.Object
com.jalios.jcms.QueryFilter
com.jalios.jcms.search.SpellSuggestEngine
- All Implemented Interfaces:
JcmsConstants,PluginComponent,JaliosConstants,Comparable
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
-
Field Summary
Fields inherited from class com.jalios.jcms.QueryFilter
BACKOFFICE_SEARCH, FRONTOFFICE_SEARCH, order, PORTLET_QUERYFields 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_YEARFields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GENERATIONAL_STORE_DIRECTORY, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PHOTO_XLARGE, PHOTO_XLARGE_HEIGHT, PHOTO_XLARGE_PROP_PREFIX, PHOTO_XLARGE_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, SVGSPRITE_ICON_PREFIX, TEMPLATE_TAB, THEME_DIR, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, TYPES_UNKNOWN_CLASS_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidRemove all words from the spellcheckerintfloatorg.apache.lucene.search.spell.SpellCheckerorg.apache.lucene.store.DirectoryfloatbooleanvoidBuild the spellChecker index from the lucene publication search engine and from the lucene category search engine.voidsetHitsThreshold(int hitsNbr) Set the number of hits below which a suggestion should be searched and proposed.voidsetScoreThreshold(float score) Set the score below which a suggestion should be searched and proposed.voidsetWordsThreshold(int wordsNbr) Set the number of words above which a suggestion is NOT proposed.Methods inherited from class com.jalios.jcms.QueryFilter
callFilterDBResult, callFilterDBResult, compareTo, equals, filterCriteria, filterDBResult, filterQueryHandler, filterResultSet, getOrder, getSearchDefault, getSearchDescription, getSearchLabel, getSearchParam, init, isBackOfficeSearch, isFrontOfficeSearch, isPortletQuery
-
Constructor Details
-
SpellSuggestEngine
- Throws:
Exception
-
-
Method Details
-
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 org.apache.lucene.search.spell.SpellChecker getSpellChecker()- Returns:
- the SpellChecker used by this SpellSuggestEngine.
-
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
-