org.exoplatform.services.wcm.search

Class SiteSearchServiceImpl

java.lang.Object

org.exoplatform.services.wcm.search.SiteSearchServiceImpl

All Implemented Interfaces:

SiteSearchService

public class SiteSearchServiceImpl
extends Object
implements SiteSearchService

The SiteSearchService component is used in the Search portlet that allows users to find all information matching with your given keyword.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SiteSearchServiceImpl.DataCreator
static class	SiteSearchServiceImpl.NodeFilter
static class	SiteSearchServiceImpl.PageDataCreator
static class	SiteSearchServiceImpl.PageNodeFilter
static class	SiteSearchServiceImpl.PageTitleDataCreator

Field Summary

Fields inherited from interface org.exoplatform.services.wcm.search.SiteSearchService

PAGE_MODE_MORE, PAGE_MODE_NONE, PAGE_MODE_PAGINATION, PATH_PORTAL_SITES

Constructor Summary

Constructors

Constructor and Description
SiteSearchServiceImpl(LivePortalManagerService portalManagerService, TemplateService templateService, WCMConfigurationService configurationService, org.exoplatform.services.jcr.RepositoryService repositoryService, org.exoplatform.services.cache.CacheService caService, org.exoplatform.container.xml.InitParams initParams) Instantiates a new site search service impl.

Method Summary

Modifier and Type	Method and Description
void	addExcludeIncludeDataTypePlugin(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
AbstractPageList<ResultNode>	searchPageContents(org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider, QueryCriteria queryCriteria, Locale locale, int pageSize, boolean isSearchContent) Searches for pages.
AbstractPageList<ResultNode>	searchSiteContents(org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider, QueryCriteria queryCriteria, Locale locale, int pageSize, boolean isSearchContent) Searches for content nodes of a site.

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteSearchServiceImpl

public SiteSearchServiceImpl(LivePortalManagerService portalManagerService,
                             TemplateService templateService,
                             WCMConfigurationService configurationService,
                             org.exoplatform.services.jcr.RepositoryService repositoryService,
                             org.exoplatform.services.cache.CacheService caService,
                             org.exoplatform.container.xml.InitParams initParams)
                      throws Exception

Instantiates a new site search service impl.

Parameters:

portalManagerService - the portal manager service

templateService - the template service

configurationService - the configuration service

repositoryService - the repository service

initParams - the init params

Throws:

Exception - the exception

Method Detail

addExcludeIncludeDataTypePlugin

public void addExcludeIncludeDataTypePlugin(ExcludeIncludeDataTypePlugin plugin)

Description copied from interface: SiteSearchService

Adds the exclude/include data type plugin.

Specified by:

addExcludeIncludeDataTypePlugin in interface SiteSearchService

Parameters:

plugin - The plugin to be added.

searchSiteContents

public AbstractPageList<ResultNode> searchSiteContents(org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider,
                                                       QueryCriteria queryCriteria,
                                                       Locale locale,
                                                       int pageSize,
                                                       boolean isSearchContent)
                                                throws Exception

Description copied from interface: SiteSearchService

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.

Specified by:

searchSiteContents in interface SiteSearchService

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

public AbstractPageList<ResultNode> searchPageContents(org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider,
                                                       QueryCriteria queryCriteria,
                                                       Locale locale,
                                                       int pageSize,
                                                       boolean isSearchContent)
                                                throws Exception

Description copied from interface: SiteSearchService

Searches for pages.

Specified by:

searchPageContents in interface SiteSearchService

Parameters:

sessionProvider - The session provider.

queryCriteria - The query criteria.

pageSize - The page size.

Returns:

The list of pages.

Throws:

Exception - The exception

getFoundNodes

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

Description copied from interface: SiteSearchService

Gets map containing list of found nodes

Specified by:

getFoundNodes in interface SiteSearchService

Parameters:

userId - user name

queryStatement - the query statement

Returns:

getDropNodes

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

Description copied from interface: SiteSearchService

Gets map containing list of dropped nodes

Specified by:

getDropNodes in interface SiteSearchService

Parameters:

userId - user name

queryStatement - the query statement

Returns:

clearCache

public void clearCache(String userId,
                       String queryStatement)

Specified by:

clearCache in interface SiteSearchService