com.jalios.jcms.search
Interface FileSearchEngine
- All Known Implementing Classes:
- LuceneFileSearchEngine
public interface FileSearchEngine
This interface must be implemented by file search engines such as LuceneFileSearchEngine.
- Since:
- jcms-3.0
- Version:
- $Revision: 22056 $
- Author:
- Olivier Dedieu , Olivier Jaquemet
REVISION
static final String REVISION
- See Also:
- Constant Field Values
search
void search(QueryHandler qh,
HashSet<? extends Publication> pubSet,
QueryResultSet resultSet)
- Perform a full-text search on indexed files
- Parameters:
qh
- the Queryhandler in which to find search text and search options.pubSet
- a HashSet containing all the Publication
to search.
if empty, search is not performed at all.
if null, all Publication
found will be returned.
This set MUST NOT be modified by implementation.resultSet
- the QueryResultSet
that must be filled
with matching Publication
- Since:
- jcms-5.5.0
getFileCount
int getFileCount()
- Returns:
- the number of indexed files
- Since:
- jcms-4.1
isAvailable
boolean isAvailable()
- Returns:
- true if the FileSearchEngine is available
- Since:
- jcms-4.1
Copyright © 2001-2007 Jalios SA. All Rights Reserved.