Package org.exoplatform.wiki.service.impl

Class WikiSearchServiceConnector

  • All Implemented Interfaces:
    org.exoplatform.container.component.ComponentPlugin
    public class WikiSearchServiceConnector
extends org.exoplatform.commons.api.search.SearchServiceConnector
    Provides a connector service for the unified search. It implements a direct search based on several criteria.
    eXo level API
    Experimental

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String DATE_TIME_FORMAT
      Date and time format used in the unified search.
      static String WIKI_PAGE_ICON
      URL pointing to the icon representing the wiki pages in the unified search results.

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

        desc, name

    • Constructor Summary

      Constructors 
      Constructor Description
      WikiSearchServiceConnector​(org.exoplatform.container.xml.InitParams initParams)
      Initializes the Wiki search service.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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)
      Implements the search method by given criteria.

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

        getDisplayName, getSearchType, isEnable, isEnabledForAnonymous, isIndexed, setDisplayName, setEnable, setEnabledForAnonymous, setSearchType

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

        getDescription, getName, setDescription, setName

    • Field Detail

      • WIKI_PAGE_ICON

        public static final String WIKI_PAGE_ICON
        URL pointing to the icon representing the wiki pages in the unified search results.
        See Also:
        Constant Field Values

      • DATE_TIME_FORMAT

        public static String DATE_TIME_FORMAT
        Date and time format used in the unified search.

    • Constructor Detail

      • WikiSearchServiceConnector

        public WikiSearchServiceConnector​(org.exoplatform.container.xml.InitParams initParams)
        Initializes the Wiki search service.
        Parameters:
        initParams - The params object which is used for initializing the Wiki search service.

    • 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)
        Implements the search method by given criteria.
        Specified by:
        search in class org.exoplatform.commons.api.search.SearchServiceConnector
        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:
        Search results.