|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--net.grcomputing.opencms.search.lucene.SearchHelper
Provides convenience functions for JSPs or external classes that want to provide Lucene search capablilites.
Field Summary | |
protected static java.lang.String[] |
indexedFields
Fields that get indexed. |
Fields inherited from interface net.grcomputing.opencms.search.lucene.I_XmlConfigConstants |
ATTR_ENABLED, ATTR_LOCATION, ATTR_NAME, ELE_ANALYZER, ELE_CLASS, ELE_DIRECTORIES, ELE_DIRECTORY, ELE_DOC_FACTORIES, ELE_EXTENSION, ELE_FILE_TYPE, ELE_INDEX_DIR, ELE_JSP_DOC_FACTORY, ELE_MERGE_FACTOR, ELE_PAGE_DOC_FACTORY, ELE_PERM_CHECK, ELE_PLAIN_DOC_FACTORY, ELE_PROJECT, ELE_SECTION, ELE_SUBSEARCH, ELE_XML_TEMPLATE_DOC_FACTORY, LUCENE_SEARCH_ELEMENT |
Constructor Summary | |
SearchHelper(CmsJspActionElement cms)
Creates new SearchHelper, getting information out of the main registry. |
|
SearchHelper(CmsObject cmsobject,
org.w3c.dom.Element luceneElement)
Creates new SearchHelper, using the registry provided. |
|
SearchHelper(CmsObject cmsobject,
java.lang.String registryPath)
Creates new SearchHelper, using the registry provided. |
Method Summary | |
Hits |
doSimpleSearch(java.lang.String term)
Does a very simple search, running a StopAnalyzer against a search within bodies. |
java.lang.String[] |
getIndexedFields()
Returns a list of indexed fields. |
java.lang.String |
getIndexPath()
Get the path for the Lucene search index. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static java.lang.String[] indexedFields
I_DocumentConstants
Constructor Detail |
public SearchHelper(CmsJspActionElement cms) throws CmsException
CmsException
- if no lucene config info can be found in registry,
or if there were problems trying to work with the registry.public SearchHelper(CmsObject cmsobject, java.lang.String registryPath) throws CmsException
CmsException
- if no registry is found, or
no lucene config info can be found in registry,
or if there were problems trying to work with the registry.public SearchHelper(CmsObject cmsobject, org.w3c.dom.Element luceneElement)
CmsException
- if no registry is found, or
no lucene config info can be found in registry,
or if there were problems trying to work with the registry.Method Detail |
public java.lang.String getIndexPath() throws CmsException
CmsException
- if there is no index element or no data in the
index element.public Hits doSimpleSearch(java.lang.String term) throws CmsException
CmsException
- if search fails or there is a problem getting the
the information necessary for a search.public java.lang.String[] getIndexedFields()
I_DocumentConstants
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |