org.exoplatform.services.wcm.search

Interface SiteSearchService

public interface SiteSearchService

Is used in the Search portlet that allows users to find all information matching with your given keyword.

It is configured in the core/core-configuration/src/main/webapp/WEB-INF/conf/configuration.xml file as follows:
war:/conf/wcm-core/core-search-configuration.xml

The component configuration maps the SiteSearchService component with its own implementation: SiteSearchServiceImpl.

 <component>
     <key>org.exoplatform.services.wcm.search.SiteSearchService</key>
     <type>org.exoplatform.services.wcm.search.SiteSearchServiceImpl</type>
     <component-plugins>
         ...
     </component-plugins>
     <init-params>
         <value-param>
             <name>isEnabledFuzzySearch</name>
             <value>true</value>
         </value-param>
         <value-param>
             <name>fuzzySearchIndex</name>
             <value/>
         </value-param>
     </init-params>
 </component>
 

Level API:

Experimental

Field Summary

Fields

Modifier and Type	Field and Description
static String	PAGE_MODE_MORE
static String	PAGE_MODE_NONE
static String	PAGE_MODE_PAGINATION
static String	PATH_PORTAL_SITES

Method Summary

Methods

Modifier and Type	Method and Description
void	addExcludeIncludeDataTypePlugin(org.exoplatform.services.wcm.search.ExcludeIncludeDataTypePlugin plugin) Adds the exclude/include data type plugin.
void	clearCache(String userId, String queryStatement)
Map<Integer,Integer>	getDropNodes(String userId, String queryStatement) Gets map containing list of dropped nodes
Map<?,Integer>	getFoundNodes(String userId, String queryStatement) Gets map containing list of found nodes
org.exoplatform.services.wcm.search.base.AbstractPageList<org.exoplatform.services.wcm.search.ResultNode>	searchPageContents(SessionProvider sessionProvider, org.exoplatform.services.wcm.search.QueryCriteria queryCriteria, int pageSize, boolean isSearchContent) Searches for pages.
org.exoplatform.services.wcm.search.base.AbstractPageList<org.exoplatform.services.wcm.search.ResultNode>	searchSiteContents(SessionProvider sessionProvider, org.exoplatform.services.wcm.search.QueryCriteria queryCriteria, int pageSize, boolean isSearchContent) Searches for content nodes of a site.

Field Detail

PAGE_MODE_NONE

static final String PAGE_MODE_NONE

See Also:

Constant Field Values

PAGE_MODE_MORE

static final String PAGE_MODE_MORE

See Also:

Constant Field Values

PAGE_MODE_PAGINATION

static final String PAGE_MODE_PAGINATION

See Also:

Constant Field Values

PATH_PORTAL_SITES

static final String PATH_PORTAL_SITES

See Also:

Constant Field Values

Method Detail

addExcludeIncludeDataTypePlugin

void addExcludeIncludeDataTypePlugin(org.exoplatform.services.wcm.search.ExcludeIncludeDataTypePlugin plugin)

Adds the exclude/include data type plugin.

Parameters:

plugin - The plugin to be added.

searchSiteContents

org.exoplatform.services.wcm.search.base.AbstractPageList<org.exoplatform.services.wcm.search.ResultNode> searchSiteContents(SessionProvider sessionProvider,
                                                                                                                           org.exoplatform.services.wcm.search.QueryCriteria queryCriteria,
                                                                                                                           int pageSize,
                                                                                                                           boolean isSearchContent)
                                                                                                                             throws Exception

Searches for content nodes of a site. This method finds all nodes of a site with nodetype that is document, nt:resource or nt:file, then checks their content. If the node content has key word, it will be put into the list result.
This function has 3 parameters, but the most important is QueryCriteria. With this parameter, you only set 5 properties:

• SiteName: Name of the site which is searched. If the site name is "null", the search will be performed in all sites of system.
• Keyword: The key word to search.
• SearchDocument and SearchWebContent: The values of these two parameters must be set to "true" or "false".
• SearchWebpage: Searches for content of nodes which are added to one or more pages.

Parameters:

sessionProvider - The session provider.

queryCriteria - The query criteria.

pageSize - The page size.

isSearchContent - If "true", search is performed by content. If "false", search is performed by page.

Returns:

The list of paginated content based on the query.

Throws:

Exception - The exception

searchPageContents

org.exoplatform.services.wcm.search.base.AbstractPageList<org.exoplatform.services.wcm.search.ResultNode> searchPageContents(SessionProvider sessionProvider,
                                                                                                                           org.exoplatform.services.wcm.search.QueryCriteria queryCriteria,
                                                                                                                           int pageSize,
                                                                                                                           boolean isSearchContent)
                                                                                                                             throws Exception

Searches for pages.

Parameters:

sessionProvider - The session provider.

queryCriteria - The query criteria.

pageSize - The page size.

Returns:

The list of pages.

Throws:

Exception - The exception

getFoundNodes

Map<?,Integer> getFoundNodes(String userId,
                           String queryStatement)

Gets map containing list of found nodes

Parameters:

userId - user name

queryStatement - the query statement

Returns:

getDropNodes

Map<Integer,Integer> getDropNodes(String userId,
                                String queryStatement)

Gets map containing list of dropped nodes

Parameters:

userId - user name

queryStatement - the query statement

Returns:

clearCache

void clearCache(String userId,
              String queryStatement)