com.jalios.jcms.search

Interface CategorySearchEngine

All Known Implementing Classes:

LuceneCategorySearchEngine

public interface CategorySearchEngine

This interface must be implemented by category search engines (indexer and searcher) such as LuceneCategorySearchEngine.

Since:

jcms-5.5.0

Version:

$Revision: 87434 $

Author:

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(Category cat) Method to implement to index Category into the search engine.
void	add(java.util.Collection<Category> coll) Method to implement to index a Collection of Category into the search engine.
void	clearAll() Method to implement to clear all Category from the search engine.
void	delete(Category cat) Method to implement to delete Category from the search engine.
void	delete(java.util.Collection<Category> coll) Method to implement to delete a Collection of Category from the search engine.
java.util.Date	getIndexingDate(Category cat) Method to implement to retrieve the Date at which the specified Category was indexed in the search engine.
boolean	search(QueryHandler qh, java.util.HashSet<? extends Publication> pubSet, QueryResultSet resultSet) Perform a full-text search.
void	update(Category cat) Method to implement to update Category in the search engine.
void	update(java.util.Collection<Category> coll) Method to implement to update Collection of Category in the search engine.

Field Detail

REVISION

static final java.lang.String REVISION

See Also:

Constant Field Values

Method Detail

add

void add(Category cat)

Method to implement to index Category into the search engine.

Parameters:

cat - the Category to index .

Since:

jcms-5.5.0

update

void update(Category cat)

Method to implement to update Category in the search engine.

Parameters:

cat - the Category to reindex .

Since:

jcms-5.5.0

delete

void delete(Category cat)

Method to implement to delete Category from the search engine.

Parameters:

cat - the Category to reindex .

Since:

jcms-5.5.0

add

void add(java.util.Collection<Category> coll)

Method to implement to index a Collection of Category into the search engine.

Parameters:

coll - the Collection of Category to index .

Since:

jcms-5.5.0

update

void update(java.util.Collection<Category> coll)

Method to implement to update Collection of Category in the search engine.

Parameters:

coll - the Collection of Category to reindex .

Since:

jcms-5.5.0

delete

void delete(java.util.Collection<Category> coll)

Method to implement to delete a Collection of Category from the search engine.

Parameters:

coll - the Collection of Category to reindex .

Since:

jcms-5.5.0

getIndexingDate

java.util.Date getIndexingDate(Category cat)

Method to implement to retrieve the Date at which the specified Category was indexed in the search engine.

Parameters:

cat - the Category for which to retrieve the indexing date.

Returns:

the indexing date of the category or null if was not indexed.

Since:

jcms-6.0.1

clearAll

void clearAll()

Method to implement to clear all Category from the search engine.

Since:

jcms-5.5.0

search

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

Perform a full-text search.

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

Returns:

true if a search was performed in the CategorySearchEngine. 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