Snapper 3.0 API

org.enhydra.snapper.api
Interface Searcher

All Known Implementing Classes:
LuceneSearcher

public interface Searcher

Searcher is a searching service. For example, Lucene index search engine

Author:
Milin Radivoj

Method Summary
 void close()
           
 ResultElement getDocumentByID(java.lang.String siteName, java.lang.String sitePath, int id, java.lang.String term)
           
 java.lang.String getPreviewSearchedTerm()
           
 int getSearchedDocsNumber()
           
 long getSearchedTime()
           
 SearchResult getSearchResult()
           
 SearchResult getSearchResult(int begin, int end)
           
 java.util.List getSearchResultPathList(int begin, int end)
           
 java.util.HashMap getWebDavSearchResult(int begin, int end, javax.servlet.http.HttpServletRequest arg0)
           
 java.lang.String hightlightDocumentByID(java.lang.String siteName, java.lang.String sitePath, java.lang.String term, java.lang.String stringToHightLight)
           
 void searchDocs(java.lang.String luceneQuery, java.lang.String filter)
           
 void searchDocs(java.lang.String luceneQuery, java.lang.String highlighterContentQuery, java.lang.String filter)
           
 void searchDocs(java.lang.String luceneQuery, java.lang.String highlighterContentQuery, java.lang.String highlighterPropertiesQuery, java.lang.String filter)
           
 void searchDocs(java.lang.String luceneQuery, java.lang.String highlighterContentQuery, java.lang.String highlighterPropertiesQuery, java.lang.String sortType, java.lang.String filter)
           
 void searchDocs(java.lang.String luceneQuery, java.lang.String highlighterContentQuery, java.lang.String highlighterPropertiesQuery, java.lang.String highlighterMetaDataQuery, java.lang.String sortType, java.lang.String filter)
           
 void setPreviewSearchedTerm(java.lang.String previewSearchedTerm)
           
 void setUpHighLighter(java.util.Properties prop)
           
 void setUpSearcher(java.util.Properties prop)
           
 

Method Detail

setUpSearcher

void setUpSearcher(java.util.Properties prop)
                   throws java.io.IOException
Throws:
java.io.IOException

setUpHighLighter

void setUpHighLighter(java.util.Properties prop)
                      throws java.io.IOException
Throws:
java.io.IOException

searchDocs

void searchDocs(java.lang.String luceneQuery,
                java.lang.String filter)
                throws java.io.IOException
Throws:
java.io.IOException

searchDocs

void searchDocs(java.lang.String luceneQuery,
                java.lang.String highlighterContentQuery,
                java.lang.String filter)
                throws java.io.IOException
Throws:
java.io.IOException

searchDocs

void searchDocs(java.lang.String luceneQuery,
                java.lang.String highlighterContentQuery,
                java.lang.String highlighterPropertiesQuery,
                java.lang.String filter)
                throws java.io.IOException
Throws:
java.io.IOException

searchDocs

void searchDocs(java.lang.String luceneQuery,
                java.lang.String highlighterContentQuery,
                java.lang.String highlighterPropertiesQuery,
                java.lang.String sortType,
                java.lang.String filter)
                throws java.io.IOException
Throws:
java.io.IOException

searchDocs

void searchDocs(java.lang.String luceneQuery,
                java.lang.String highlighterContentQuery,
                java.lang.String highlighterPropertiesQuery,
                java.lang.String highlighterMetaDataQuery,
                java.lang.String sortType,
                java.lang.String filter)
                throws java.io.IOException
Throws:
java.io.IOException

getSearchedDocsNumber

int getSearchedDocsNumber()

getSearchedTime

long getSearchedTime()

getDocumentByID

ResultElement getDocumentByID(java.lang.String siteName,
                              java.lang.String sitePath,
                              int id,
                              java.lang.String term)

hightlightDocumentByID

java.lang.String hightlightDocumentByID(java.lang.String siteName,
                                        java.lang.String sitePath,
                                        java.lang.String term,
                                        java.lang.String stringToHightLight)

getSearchResult

SearchResult getSearchResult()

getSearchResult

SearchResult getSearchResult(int begin,
                             int end)

getWebDavSearchResult

java.util.HashMap getWebDavSearchResult(int begin,
                                        int end,
                                        javax.servlet.http.HttpServletRequest arg0)

getSearchResultPathList

java.util.List getSearchResultPathList(int begin,
                                       int end)

close

void close()
           throws java.io.IOException
Throws:
java.io.IOException

getPreviewSearchedTerm

java.lang.String getPreviewSearchedTerm()

setPreviewSearchedTerm

void setPreviewSearchedTerm(java.lang.String previewSearchedTerm)

Snapper 3.0 API