org.craftercms.engine.search

Class SiteAwareSearchService

java.lang.Object

org.craftercms.engine.search.SiteAwareSearchService

All Implemented Interfaces:

org.craftercms.search.service.QueryFactory<org.craftercms.search.service.Query>, org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

public class SiteAwareSearchService
extends Object
implements org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

SearchService wrapper that forces all operations to use an index ID based on the current site. If a method is called with no index ID, one is created by appending the current site name + a separator + a default index suffix. If an index ID is provided, then the actual, final index ID is formed by appending the current site name + a separator + the provided index ID as a suffix.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field and Description
protected org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>	actualSearchService
static String	DEFAULT_INDEX_ID_SEPARATOR
protected String	defaultIndexIdSuffix
protected String	indexIdSeparator

Constructor Summary

Constructors

Constructor and Description
SiteAwareSearchService()

Method Summary

Modifier and Type	Method and Description
void	commit()
void	commit(String indexId)
org.craftercms.search.service.Query	createQuery()
org.craftercms.search.service.Query	createQuery(Map<String,String[]> params)
void	delete(String site, String id)
void	delete(String indexId, String site, String id)
protected String	getActualIndexId(String indexIdSuffix)
protected String	getCurrentSiteName()
Map<String,Object>	search(org.craftercms.search.service.Query query)
Map<String,Object>	search(String indexId, org.craftercms.search.service.Query query)
void	setActualSearchService(org.craftercms.search.service.SearchService<org.craftercms.search.service.Query> actualSearchService)
void	setDefaultIndexIdSuffix(String defaultIndexIdSuffix)
void	setIndexIdSeparator(String indexIdSeparator)
void	update(String site, String id, String xml, boolean ignoreRootInFieldNames)
void	update(String indexId, String site, String id, String xml, boolean ignoreRootInFieldNames)
void	updateContent(String site, String id, org.craftercms.core.service.Content content)
void	updateContent(String site, String id, org.craftercms.core.service.Content content, Map<String,List<String>> additionalFields)
void	updateContent(String site, String id, File file)
void	updateContent(String site, String id, File file, Map<String,List<String>> additionalFields)
void	updateContent(String indexId, String site, String id, org.craftercms.core.service.Content content)
void	updateContent(String indexId, String site, String id, org.craftercms.core.service.Content content, Map<String,List<String>> additionalFields)
void	updateContent(String indexId, String site, String id, File file)
void	updateContent(String indexId, String site, String id, File file, Map<String,List<String>> additionalFields)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INDEX_ID_SEPARATOR

public static final String DEFAULT_INDEX_ID_SEPARATOR

See Also:

Constant Field Values

defaultIndexIdSuffix

protected String defaultIndexIdSuffix

indexIdSeparator

protected String indexIdSeparator

actualSearchService

protected org.craftercms.search.service.SearchService<org.craftercms.search.service.Query> actualSearchService

Constructor Detail

SiteAwareSearchService

public SiteAwareSearchService()

Method Detail

setDefaultIndexIdSuffix

public void setDefaultIndexIdSuffix(String defaultIndexIdSuffix)

setIndexIdSeparator

public void setIndexIdSeparator(String indexIdSeparator)

setActualSearchService

public void setActualSearchService(org.craftercms.search.service.SearchService<org.craftercms.search.service.Query> actualSearchService)

createQuery

public org.craftercms.search.service.Query createQuery()

Specified by:

createQuery in interface org.craftercms.search.service.QueryFactory<org.craftercms.search.service.Query>

createQuery

public org.craftercms.search.service.Query createQuery(Map<String,String[]> params)

Specified by:

createQuery in interface org.craftercms.search.service.QueryFactory<org.craftercms.search.service.Query>

search

public Map<String,Object> search(org.craftercms.search.service.Query query)
                          throws org.craftercms.search.exception.SearchException

Specified by:

search in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

search

public Map<String,Object> search(String indexId,
                                 org.craftercms.search.service.Query query)
                          throws org.craftercms.search.exception.SearchException

Specified by:

search in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

update

public void update(String site,
                   String id,
                   String xml,
                   boolean ignoreRootInFieldNames)
            throws org.craftercms.search.exception.SearchException

Specified by:

update in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

update

public void update(String indexId,
                   String site,
                   String id,
                   String xml,
                   boolean ignoreRootInFieldNames)
            throws org.craftercms.search.exception.SearchException

Specified by:

update in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

delete

public void delete(String site,
                   String id)
            throws org.craftercms.search.exception.SearchException

Specified by:

delete in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

delete

public void delete(String indexId,
                   String site,
                   String id)
            throws org.craftercms.search.exception.SearchException

Specified by:

delete in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

updateContent

public void updateContent(String site,
                          String id,
                          File file)
                   throws org.craftercms.search.exception.SearchException

Specified by:

updateContent in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

updateContent

public void updateContent(String indexId,
                          String site,
                          String id,
                          File file)
                   throws org.craftercms.search.exception.SearchException

Specified by:

updateContent in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

updateContent

public void updateContent(String site,
                          String id,
                          File file,
                          Map<String,List<String>> additionalFields)
                   throws org.craftercms.search.exception.SearchException

Specified by:

updateContent in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

updateContent

public void updateContent(String indexId,
                          String site,
                          String id,
                          File file,
                          Map<String,List<String>> additionalFields)
                   throws org.craftercms.search.exception.SearchException

Specified by:

updateContent in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

updateContent

public void updateContent(String site,
                          String id,
                          org.craftercms.core.service.Content content)
                   throws org.craftercms.search.exception.SearchException

Specified by:

updateContent in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

updateContent

public void updateContent(String indexId,
                          String site,
                          String id,
                          org.craftercms.core.service.Content content)
                   throws org.craftercms.search.exception.SearchException

Specified by:

updateContent in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

updateContent

public void updateContent(String site,
                          String id,
                          org.craftercms.core.service.Content content,
                          Map<String,List<String>> additionalFields)
                   throws org.craftercms.search.exception.SearchException

Specified by:

updateContent in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

updateContent

public void updateContent(String indexId,
                          String site,
                          String id,
                          org.craftercms.core.service.Content content,
                          Map<String,List<String>> additionalFields)
                   throws org.craftercms.search.exception.SearchException

Specified by:

updateContent in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

commit

public void commit()
            throws org.craftercms.search.exception.SearchException

Specified by:

commit in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

commit

public void commit(String indexId)
            throws org.craftercms.search.exception.SearchException

Specified by:

commit in interface org.craftercms.search.service.SearchService<org.craftercms.search.service.Query>

Throws:

org.craftercms.search.exception.SearchException

getActualIndexId

protected String getActualIndexId(String indexIdSuffix)

getCurrentSiteName

protected String getCurrentSiteName()