org.exoplatform.commons.api.search

Class SearchServiceConnector

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.commons.api.search.SearchServiceConnector

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

Direct Known Subclasses:

WikiSearchServiceConnector

public abstract class SearchServiceConnector
extends org.exoplatform.container.component.BaseComponentPlugin

Is extended by all SearchService connectors, and allows to build configuration needed by a list of connectors that is used for the Unified Search.

Field Summary

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Constructor and Description
SearchServiceConnector(org.exoplatform.container.xml.InitParams initParams) Initializes a search service connector.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayName() Gets a display name.
String	getSearchType() Gets a search type.
abstract Collection<org.exoplatform.commons.api.search.data.SearchResult>	search(org.exoplatform.commons.api.search.data.SearchContext context, String query, Collection<String> sites, int offset, int limit, String sort, String order) Returns a collection of search results from the connectors.
void	setDisplayName(String displayName) Sets a display name.
void	setSearchType(String searchType) Sets a search type.

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchServiceConnector

public SearchServiceConnector(org.exoplatform.container.xml.InitParams initParams)

Initializes a search service connector. The constructor is default that connectors must implement.

Parameters:

initParams - The parameters which are used for initializing the search service connector from configuration.

Level API:

Experimental

Method Detail

getSearchType

public String getSearchType()

Gets a search type.

Returns:

The string.

Level API:

Experimental

setSearchType

public void setSearchType(String searchType)

Sets a search type.

Parameters:

searchType - The search type to be set.

Level API:

Experimental

getDisplayName

public String getDisplayName()

Gets a display name.

Returns:

The string.

Level API:

Experimental

setDisplayName

public void setDisplayName(String displayName)

Sets a display name.

Parameters:

displayName - The display name to be set.

Level API:

Experimental

search

public abstract Collection<org.exoplatform.commons.api.search.data.SearchResult> search(org.exoplatform.commons.api.search.data.SearchContext context,
                                                                      String query,
                                                                      Collection<String> sites,
                                                                      int offset,
                                                                      int limit,
                                                                      String sort,
                                                                      String order)

Returns a collection of search results from the connectors. The connectors must implement this search method, with the parameters below.

Parameters:

context - The search context.

query - The query statement.

sites - Specified sites where the search is performed (for example Acme, or Intranet).

offset - The start point from which the search results are returned.

limit - The limitation number of search results.

sort - The sorting criteria (title, relevancy and date).

order - The sorting order (ascending and descending).

Returns:

The collection of search results.

Level API:

Experimental