org.exoplatform.wiki.service.impl
Class WikiSearchServiceConnector

java.lang.Object
  org.exoplatform.container.component.BaseComponentPlugin
      org.exoplatform.commons.api.search.SearchServiceConnector
          org.exoplatform.wiki.service.impl.WikiSearchServiceConnector

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

public class WikiSearchServiceConnector
extends org.exoplatform.commons.api.search.SearchServiceConnector

The WikiSearchServiceConnector provide a connector service for the common unified search. It implements a direct search in the jcr based on several criteria

Field Summary

static String	DATE_TIME_FORMAT Date format expected by the unified search
static String	WIKI_PAGE_ICON URL of the icon used in the unified search to represent the results

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

desc, name

Constructor Summary

WikiSearchServiceConnector(org.exoplatform.container.xml.InitParams initParams)
Initialise the wiki service connector

Method Summary

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) The connectors must implement this search method, with the following parameters and return a collection of SearchResult

Methods inherited from class org.exoplatform.commons.api.search.SearchServiceConnector

getDisplayName, getSearchType, setDisplayName, setSearchType

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

Field Detail

WIKI_PAGE_ICON

public static final String WIKI_PAGE_ICON

URL of the icon used in the unified search to represent the results

See Also:

Constant Field Values

DATE_TIME_FORMAT

public static String DATE_TIME_FORMAT

Date format expected by the unified search

Constructor Detail

WikiSearchServiceConnector

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

Initialise the wiki service connector

Parameters:

initParams - Parameters

Method Detail

search

public 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)

The connectors must implement this search method, with the following parameters and return a collection of SearchResult

Specified by:

search in class org.exoplatform.commons.api.search.SearchServiceConnector

Parameters:

context - Search context

query - The user-input query to search for

sites - Search on these specified sites only (e.g acme, intranet...)

offset - Start offset of the result set

limit - Maximum size of the result set

sort - The field to sort the result set

order - Sort order (ASC, DESC)

Returns:

a collection of SearchResult