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: 49040 $

Author:

Olivier Dedieu , Olivier Jaquemet

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REVISION

Method Summary

Methods

Modifier and Type	Method and Description
void	add(FileDocument fileDocument) Method to implement to index FileDocument into the search engine.
void	delete(FileDocument fileDocument) Method to implement to delete FileDocument from the search engine.
int	getFileCount()
boolean	isAvailable()
java.util.LinkedHashMap<java.lang.String,java.lang.Float>	search(QueryHandler qh) Return the list of publication's identifier with a lucene search.
boolean	search(QueryHandler qh, java.util.HashSet<? extends Publication> pubSet, QueryResultSet resultSet, boolean searchInDB) Perform a full-text search on indexed files
java.util.LinkedHashMap<java.lang.String,java.lang.Float>	search(QueryHandler qh, java.util.List<java.lang.String> idList) Filters the given list of publication's identifier with a lucene search.
void	update(FileDocument fileDocument) Method to implement to update FileDocument in the search engine.

Field Detail

REVISION

static final java.lang.String REVISION

See Also:

Constant Field Values

Method Detail

search

boolean search(QueryHandler qh,
             java.util.HashSet<? extends Publication> pubSet,
             QueryResultSet resultSet,
             boolean searchInDB)

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

searchInDB - if false, only JStore publication are set in pubSet

Returns:

true if a search was performed in the FileSearchEngine. Useful to differenciate a query returning zero result from a query not performed due to missing paramerters (text for example)

Since:

jcms-5.5.0

search

java.util.LinkedHashMap<java.lang.String,java.lang.Float> search(QueryHandler qh,
                                                               java.util.List<java.lang.String> idList)

Filters the given list of publication's identifier with a lucene search.

Parameters:

qh - the Queryhandler in which to find search text and search options.

idList - the list of publication's identifier

Returns:

a map of publication's matching the lucene query and their score. This map is a subset of idList and respect its order.

Since:

jcms-6.2.0

search

java.util.LinkedHashMap<java.lang.String,java.lang.Float> search(QueryHandler qh)

Return the list of publication's identifier with a lucene search.

Parameters:

qh - the Queryhandler in which to find search text and search options.

Returns:

a map of publication's matching the lucene query and their score.

Since:

jcms-6.2.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

add

void add(FileDocument fileDocument)

Method to implement to index FileDocument into the search engine.

Parameters:

fileDocument - the FileDocument to index .

Since:

jcms-5.5.0

update

void update(FileDocument fileDocument)

Method to implement to update FileDocument in the search engine.

Parameters:

fileDocument - the FileDocument to reindex .

Since:

jcms-5.5.0

delete

void delete(FileDocument fileDocument)

Method to implement to delete FileDocument from the search engine.

Parameters:

fileDocument - the FileDocument to delete from index .

Since:

jcms-5.5.0