Snapper 1.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)
           
 int getSearchedDocsNumber()
           
 long getSearchedTime()
           
 SearchResult getSearchResult()
           
 SearchResult getSearchResult(int begin, int end)
           
 java.util.List getSearchResultPathList(int begin, int end)
           
 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 setUpHighLighter(java.util.Properties prop)
           
 void setUpSearcher(java.util.Properties prop)
           
 

Method Detail

setUpSearcher

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

setUpHighLighter

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

searchDocs

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

searchDocs

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

searchDocs

public 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

public 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

public 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

public int getSearchedDocsNumber()

getSearchedTime

public long getSearchedTime()

getDocumentByID

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

hightlightDocumentByID

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

getSearchResult

public SearchResult getSearchResult()

getSearchResult

public SearchResult getSearchResult(int begin,
                                    int end)

getSearchResultPathList

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

close

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

Snapper 1.0 API