Package org.silverpeas.core.index.search

Class SimpleSearchEngine

java.lang.Object

org.silverpeas.core.index.search.SimpleSearchEngine

All Implemented Interfaces:

SearchEngine

@Singleton
public class SimpleSearchEngine
extends Object
implements SearchEngine

A SimpleSearchEngine search Silverpeas indexes index and give access to the retrieved index entries.

Method Summary

Modifier and Type	Method	Description
PlainSearchResult	search(QueryDescription query)	Search the index for the required documents.
Set<String>	suggestKeywords(String keywordFragment)	gets a list of suggestion from a partial String

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

search

public PlainSearchResult search(QueryDescription query)
                         throws ParseException

Description copied from interface: SearchEngine

Search the index for the required documents.

If QueryDescription.setAdminScope(boolean) as been called with a true value (it MUST be only set by administration features), no filtering is performed on index search result.

In other context than the one of administration scope, a filtering is performed on the index search result. The filtering is using ComponentAuthorization API which permits each component to apply theirs access security rules.

Specified by:

search in interface SearchEngine

Parameters:

query - the search query.

Returns:

the results.

Throws:

ParseException

suggestKeywords

public Set<String> suggestKeywords(String keywordFragment)

gets a list of suggestion from a partial String

Specified by:

suggestKeywords in interface SearchEngine

Parameters:

keywordFragment - string to execute the search

Returns:

a set of result sorted by alphabetic order