org.exoplatform.services.wcm.search.connector

Class BaseContentSearchServiceConnector

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.commons.api.search.SearchServiceConnector

org.exoplatform.services.wcm.search.connector.BaseSearchServiceConnector

org.exoplatform.services.wcm.search.connector.BaseContentSearchServiceConnector

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

Direct Known Subclasses:

DocumentSearchServiceConnector

public abstract class BaseContentSearchServiceConnector
extends BaseSearchServiceConnector

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	excluded_nodetypes

Fields inherited from class org.exoplatform.services.wcm.search.connector.BaseSearchServiceConnector

DEFAULT_SITENAME, documentService, driveService_, NONE_NAGVIGATION, PAGE_NAGVIGATION, PORTLET_NAME, siteSearch_, sortByDate, sortByRelevancy, sortByTitle

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

desc, name

Constructor Summary

Constructors

Constructor and Description
BaseContentSearchServiceConnector(org.exoplatform.container.xml.InitParams initParams)

Method Summary

Modifier and Type	Method and Description
protected QueryCriteria	createQueryCriteria(String query, long offset, long limit, String sort, String order) creates the QueryCriteria object based on the search service
protected String	getDetails(ResultNode retNode, org.exoplatform.commons.api.search.data.SearchContext context) gets the detail about result node
protected String	getFileType(ResultNode node) gets the file type
protected String	getImageUrl(javax.jcr.Node node) gets the image url
protected abstract String[]	getNodeTypes() returns the primary types of the specific search service: nt:file for file search, null for document search
protected abstract String[]	getSearchedDocTypes() returns the primary types of the specific search service: nt:file for file search, all other document types for document search
protected String	getTitleResult(ResultNode node) gets the title of result, based on the result type
protected AbstractPageList<ResultNode>	searchNodes(QueryCriteria criteria, org.exoplatform.commons.api.search.data.SearchContext context) searches base on the search service type

Methods inherited from class org.exoplatform.services.wcm.search.connector.BaseSearchServiceConnector

convertResult, fileSize, filterNode, formatDate, getDate, getDriveTitle, getPath, getPreviewUrl, removeAccents, search

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

getDisplayName, getSearchType, isEnable, setDisplayName, setEnable, 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

excluded_nodetypes

public static List<String> excluded_nodetypes

Constructor Detail

BaseContentSearchServiceConnector

public BaseContentSearchServiceConnector(org.exoplatform.container.xml.InitParams initParams)
                                  throws Exception

Throws:

Exception

Method Detail

createQueryCriteria

protected QueryCriteria createQueryCriteria(String query,
                                            long offset,
                                            long limit,
                                            String sort,
                                            String order)

creates the QueryCriteria object based on the search service

Specified by:

createQueryCriteria in class BaseSearchServiceConnector

Parameters:

query - the query string

offset - the offset

limit - the limit

sort - sort field

order - order by

Returns:

the QueryCriteria

searchNodes

protected AbstractPageList<ResultNode> searchNodes(QueryCriteria criteria,
                                                   org.exoplatform.commons.api.search.data.SearchContext context)
                                            throws Exception

searches base on the search service type

Specified by:

searchNodes in class BaseSearchServiceConnector

Parameters:

criteria - the query criteria

Returns:

page list containing the result

Throws:

Exception

getFileType

protected String getFileType(ResultNode node)
                      throws Exception

Description copied from class: BaseSearchServiceConnector

gets the file type

Specified by:

getFileType in class BaseSearchServiceConnector

Returns:

Throws:

Exception

getSearchedDocTypes

protected abstract String[] getSearchedDocTypes()

returns the primary types of the specific search service: nt:file for file search, all other document types for document search

Returns:

searched doc types

getNodeTypes

protected abstract String[] getNodeTypes()

returns the primary types of the specific search service: nt:file for file search, null for document search

Returns:

searched doc types

getTitleResult

protected String getTitleResult(ResultNode node)
                         throws Exception

gets the title of result, based on the result type

Specified by:

getTitleResult in class BaseSearchServiceConnector

Returns:

Throws:

Exception

getImageUrl

protected String getImageUrl(javax.jcr.Node node)

gets the image url

Specified by:

getImageUrl in class BaseSearchServiceConnector

Returns:

getDetails

protected String getDetails(ResultNode retNode,
                            org.exoplatform.commons.api.search.data.SearchContext context)
                     throws Exception

gets the detail about result node

Specified by:

getDetails in class BaseSearchServiceConnector

Parameters:

retNode - the node

Throws:

Exception