org.exoplatform.services.wcm.search.connector

Class BaseSearchServiceConnector

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.commons.api.search.SearchServiceConnector

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

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

Direct Known Subclasses:

BaseContentSearchServiceConnector, PageSearchServiceConnector

public abstract class BaseSearchServiceConnector
extends org.exoplatform.commons.api.search.SearchServiceConnector

This abstract class is extended by the SearchService connectors which provide search result for a specific content type

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SITENAME
protected DocumentService	documentService
protected ManageDriveService	driveService_
static String	NONE_NAGVIGATION
static String	PAGE_NAGVIGATION
static String	PORTLET_NAME
protected SiteSearchService	siteSearch_
static String	sortByDate
static String	sortByRelevancy
static String	sortByTitle

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

desc, name

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected List<org.exoplatform.commons.api.search.data.SearchResult>	convertResult(AbstractPageList<ResultNode> pageList, int limit, int offset, org.exoplatform.commons.api.search.data.SearchContext context) converts data: from PageList<ResultNode> to List<SearchResult>
protected abstract QueryCriteria	createQueryCriteria(String query, long offset, long limit, String sort, String order) creates the QueryCriteria object based on the search service
protected String	fileSize(javax.jcr.Node node) gets the file size
protected abstract ResultNode	filterNode(ResultNode node) filters the node base on search type: document or file
protected String	formatDate(Calendar date) formats the date object in simple date format
protected Calendar	getDate(javax.jcr.Node node) returns the date information of node
protected abstract String	getDetails(ResultNode node, org.exoplatform.commons.api.search.data.SearchContext context) gets the detail about result node
protected String	getDriveTitle(DriveData driveData)
protected abstract String	getFileType(ResultNode node) gets the file type
protected abstract String	getImageUrl(javax.jcr.Node node) gets the image url
protected abstract String	getPath(ResultNode node, org.exoplatform.commons.api.search.data.SearchContext context) returns path of node in format: "{drivename}/{relative path from drive root node}
protected String	getPreviewUrl(ResultNode node, org.exoplatform.commons.api.search.data.SearchContext context) returns the preview url
protected abstract String	getTitleResult(ResultNode node) gets the title of result, based on the result type
protected static String	removeAccents(String query) Remove accents from query
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
protected abstract 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.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

sortByDate

public static final String sortByDate

See Also:

Constant Field Values

sortByRelevancy

public static final String sortByRelevancy

See Also:

Constant Field Values

sortByTitle

public static final String sortByTitle

See Also:

Constant Field Values

siteSearch_

protected SiteSearchService siteSearch_

documentService

protected DocumentService documentService

driveService_

protected ManageDriveService driveService_

DEFAULT_SITENAME

public static final String DEFAULT_SITENAME

See Also:

Constant Field Values

PAGE_NAGVIGATION

public static final String PAGE_NAGVIGATION

See Also:

Constant Field Values

NONE_NAGVIGATION

public static final String NONE_NAGVIGATION

See Also:

Constant Field Values

PORTLET_NAME

public static final String PORTLET_NAME

See Also:

Constant Field Values

Constructor Detail

BaseSearchServiceConnector

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

Throws:

Exception

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

createQueryCriteria

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

creates the QueryCriteria object based on the search service

Parameters:

query - the query string

offset - the offset

limit - the limit

sort - sort field

order - order by

Returns:

the QueryCriteria

searchNodes

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

searches base on the search service type

Parameters:

criteria - the query criteria

Returns:

page list containing the result

Throws:

Exception

filterNode

protected abstract ResultNode filterNode(ResultNode node)
                                  throws javax.jcr.RepositoryException

filters the node base on search type: document or file

Returns:

the node object

Throws:

javax.jcr.RepositoryException

convertResult

protected List<org.exoplatform.commons.api.search.data.SearchResult> convertResult(AbstractPageList<ResultNode> pageList,
                                                                                   int limit,
                                                                                   int offset,
                                                                                   org.exoplatform.commons.api.search.data.SearchContext context)

converts data: from PageList<ResultNode> to List<SearchResult>

Parameters:

pageList -

Returns:

fileSize

protected String fileSize(javax.jcr.Node node)
                   throws Exception

gets the file size

Parameters:

node - The node

Returns:

the file size

Throws:

Exception

getDate

protected Calendar getDate(javax.jcr.Node node)
                    throws Exception

returns the date information of node

Parameters:

node - the node

Returns:

the date

Throws:

Exception

formatDate

protected String formatDate(Calendar date)

formats the date object in simple date format

Parameters:

date - the Date object

Returns:

the String representation

getDriveTitle

protected String getDriveTitle(DriveData driveData)

removeAccents

protected static String removeAccents(String query)

Remove accents from query

Parameters:

query -

Returns:

getPath

protected abstract String getPath(ResultNode node,
                                  org.exoplatform.commons.api.search.data.SearchContext context)
                           throws Exception

returns path of node in format: "{drivename}/{relative path from drive root node}

Parameters:

node - the node

Returns:

the expected path

Throws:

Exception

getPreviewUrl

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

returns the preview url

Parameters:

node - the node

Returns:

the expected path

Throws:

Exception

getFileType

protected abstract String getFileType(ResultNode node)
                               throws Exception

gets the file type

Returns:

Throws:

Exception

getTitleResult

protected abstract String getTitleResult(ResultNode node)
                                  throws Exception

gets the title of result, based on the result type

Parameters:

node -

Returns:

Throws:

Exception

getImageUrl

protected abstract String getImageUrl(javax.jcr.Node node)

gets the image url

Returns:

getDetails

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

gets the detail about result node

Parameters:

node - the node

Throws:

Exception