org.alfresco.repo.search.impl.lucene

Class ADMLuceneSearcherImpl

java.lang.Object

org.alfresco.repo.search.impl.lucene.AbstractLuceneBase

org.alfresco.repo.search.impl.lucene.ADMLuceneSearcherImpl

All Implemented Interfaces:

LuceneSearcher, org.alfresco.service.cmr.search.SearchService

public class ADMLuceneSearcherImpl
extends AbstractLuceneBase
implements LuceneSearcher

The Lucene implementation of Searcher At the moment we support only lucene based queries. TODO: Support for other query languages

Author:

andyh

Field Summary

Fields inherited from class org.alfresco.repo.search.impl.lucene.AbstractLuceneBase

deltaId, store

Fields inherited from interface org.alfresco.service.cmr.search.SearchService

LANGUAGE_CMIS_ALFRESCO, LANGUAGE_CMIS_STRICT, LANGUAGE_FTS_ALFRESCO, LANGUAGE_LUCENE, LANGUAGE_SOLR_ALFRESCO, LANGUAGE_SOLR_CMIS, LANGUAGE_SOLR_FTS_ALFRESCO, LANGUAGE_XPATH

Constructor Summary

Constructors

Constructor and Description
ADMLuceneSearcherImpl()

Method Summary

Modifier and Type	Method and Description
boolean	contains(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName propertyQName, String googleLikePattern)
boolean	contains(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName propertyQName, String googleLikePattern, org.alfresco.service.cmr.search.SearchParameters.Operator defaultOperator)
protected String	findSortField(org.alfresco.service.cmr.search.SearchParameters searchParameters, ClosingIndexSearcher searcher, String field, Locale sortLocale)
ClosingIndexSearcher	getClosingIndexSearcher() Get a lucene searcher
org.alfresco.service.namespace.NamespacePrefixResolver	getNamespacePrefixResolver()
static ADMLuceneSearcherImpl	getNodeSearcher() Get a select-node-based searcher
org.alfresco.service.cmr.repository.NodeService	getNodeService()
QueryRegisterComponent	getQueryRegister()
static ADMLuceneSearcherImpl	getSearcher(org.alfresco.service.cmr.repository.StoreRef storeRef, LuceneConfig config) Get an intialised searcher for the store.
static ADMLuceneSearcherImpl	getSearcher(org.alfresco.service.cmr.repository.StoreRef storeRef, LuceneIndexer indexer, LuceneConfig config) Get an initialised searcher for the store and transaction Normally we do not search against a a store and delta.
org.alfresco.repo.tenant.TenantService	getTenantService()
List<org.alfresco.util.Pair<String,Integer>>	getTopTerms(String field, int count) Get top terms
boolean	indexExists() Check if the index exists
boolean	like(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName propertyQName, String sqlLikePattern, boolean includeFTS)
org.alfresco.service.cmr.search.ResultSet	query(org.alfresco.service.cmr.search.SearchParameters searchParameters)
org.alfresco.service.cmr.search.ResultSet	query(org.alfresco.service.cmr.repository.StoreRef store, org.alfresco.service.namespace.QName queryId, org.alfresco.service.cmr.search.QueryParameter[] queryParameters)
org.alfresco.service.cmr.search.ResultSet	query(org.alfresco.service.cmr.repository.StoreRef store, String language, String query)
org.alfresco.service.cmr.search.ResultSet	query(org.alfresco.service.cmr.repository.StoreRef store, String language, String queryString, org.alfresco.service.cmr.search.QueryParameterDefinition[] queryParameterDefinitions)
List<org.alfresco.service.cmr.repository.NodeRef>	selectNodes(org.alfresco.service.cmr.repository.NodeRef contextNodeRef, String xpath, org.alfresco.service.cmr.search.QueryParameterDefinition[] parameters, org.alfresco.service.namespace.NamespacePrefixResolver namespacePrefixResolver, boolean followAllParentLinks)
List<org.alfresco.service.cmr.repository.NodeRef>	selectNodes(org.alfresco.service.cmr.repository.NodeRef contextNodeRef, String xpath, org.alfresco.service.cmr.search.QueryParameterDefinition[] parameters, org.alfresco.service.namespace.NamespacePrefixResolver namespacePrefixResolver, boolean followAllParentLinks, String language)
List<Serializable>	selectProperties(org.alfresco.service.cmr.repository.NodeRef contextNodeRef, String xpath, org.alfresco.service.cmr.search.QueryParameterDefinition[] parameters, org.alfresco.service.namespace.NamespacePrefixResolver namespacePrefixResolver, boolean followAllParentLinks)
List<Serializable>	selectProperties(org.alfresco.service.cmr.repository.NodeRef contextNodeRef, String xpath, org.alfresco.service.cmr.search.QueryParameterDefinition[] parameters, org.alfresco.service.namespace.NamespacePrefixResolver namespacePrefixResolver, boolean followAllParentLinks, String language)
void	setNamespacePrefixResolver(org.alfresco.service.namespace.NamespacePrefixResolver namespacePrefixResolver) Set the name space service
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) Ste the node service
void	setQueryLanguages(Map<String,LuceneQueryLanguageSPI> queryLanguages)
void	setQueryRegister(QueryRegisterComponent queryRegister) Set the query register
void	setTenantService(org.alfresco.repo.tenant.TenantService tenantService)

Methods inherited from class org.alfresco.repo.search.impl.lucene.AbstractLuceneBase

closeDeltaReader, closeDeltaWriter, deleteIndex, doReadOnly, getDeltaId, getDeltaReader, getDeltaWriter, getDictionaryService, getLuceneConfig, getReader, getSearcher, getSearcher, getStatus, initialise, saveDelta, setDictionaryService, setInfo, setLuceneConfig, setStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

ADMLuceneSearcherImpl

public ADMLuceneSearcherImpl()

Method Detail

getSearcher

public static ADMLuceneSearcherImpl getSearcher(org.alfresco.service.cmr.repository.StoreRef storeRef,
                                                LuceneIndexer indexer,
                                                LuceneConfig config)

Get an initialised searcher for the store and transaction Normally we do not search against a a store and delta. Currently only gets the searcher against the main index.

Parameters:

storeRef - StoreRef

indexer - LuceneIndexer

config - LuceneConfig

Returns:

- the searcher implementation

getSearcher

public static ADMLuceneSearcherImpl getSearcher(org.alfresco.service.cmr.repository.StoreRef storeRef,
                                                LuceneConfig config)

Get an intialised searcher for the store. No transactional ammendsmends are searched.

Parameters:

storeRef - StoreRef

config - LuceneConfig

Returns:

the searcher

getNodeSearcher

public static ADMLuceneSearcherImpl getNodeSearcher()

Get a select-node-based searcher

Returns:

ADMLuceneSearcherImpl

setNamespacePrefixResolver

public void setNamespacePrefixResolver(org.alfresco.service.namespace.NamespacePrefixResolver namespacePrefixResolver)

Description copied from interface: LuceneSearcher

Set the name space service

Specified by:

setNamespacePrefixResolver in interface LuceneSearcher

Parameters:

namespacePrefixResolver - NamespacePrefixResolver

getNamespacePrefixResolver

public org.alfresco.service.namespace.NamespacePrefixResolver getNamespacePrefixResolver()

getNodeService

public org.alfresco.service.cmr.repository.NodeService getNodeService()

getTenantService

public org.alfresco.repo.tenant.TenantService getTenantService()

getQueryRegister

public QueryRegisterComponent getQueryRegister()

indexExists

public boolean indexExists()

Description copied from interface: LuceneSearcher

Check if the index exists

Specified by:

indexExists in interface LuceneSearcher

Returns:

- true if it exists

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Description copied from interface: LuceneSearcher

Ste the node service

Specified by:

setNodeService in interface LuceneSearcher

Parameters:

nodeService - NodeService

setTenantService

public void setTenantService(org.alfresco.repo.tenant.TenantService tenantService)

setQueryRegister

public void setQueryRegister(QueryRegisterComponent queryRegister)

Set the query register

Parameters:

queryRegister - QueryRegisterComponent

setQueryLanguages

public void setQueryLanguages(Map<String,LuceneQueryLanguageSPI> queryLanguages)

query

public org.alfresco.service.cmr.search.ResultSet query(org.alfresco.service.cmr.repository.StoreRef store,
                                                       String language,
                                                       String queryString,
                                                       org.alfresco.service.cmr.search.QueryParameterDefinition[] queryParameterDefinitions)
                                                throws SearcherException

Specified by:

query in interface org.alfresco.service.cmr.search.SearchService

Throws:

SearcherException

query

public org.alfresco.service.cmr.search.ResultSet query(org.alfresco.service.cmr.search.SearchParameters searchParameters)

Specified by:

query in interface org.alfresco.service.cmr.search.SearchService

findSortField

protected String findSortField(org.alfresco.service.cmr.search.SearchParameters searchParameters,
                               ClosingIndexSearcher searcher,
                               String field,
                               Locale sortLocale)

query

public org.alfresco.service.cmr.search.ResultSet query(org.alfresco.service.cmr.repository.StoreRef store,
                                                       String language,
                                                       String query)

Specified by:

query in interface org.alfresco.service.cmr.search.SearchService

query

public org.alfresco.service.cmr.search.ResultSet query(org.alfresco.service.cmr.repository.StoreRef store,
                                                       org.alfresco.service.namespace.QName queryId,
                                                       org.alfresco.service.cmr.search.QueryParameter[] queryParameters)

Specified by:

query in interface org.alfresco.service.cmr.search.SearchService

selectNodes

public List<org.alfresco.service.cmr.repository.NodeRef> selectNodes(org.alfresco.service.cmr.repository.NodeRef contextNodeRef,
                                                                     String xpath,
                                                                     org.alfresco.service.cmr.search.QueryParameterDefinition[] parameters,
                                                                     org.alfresco.service.namespace.NamespacePrefixResolver namespacePrefixResolver,
                                                                     boolean followAllParentLinks,
                                                                     String language)
                                                              throws org.alfresco.service.cmr.repository.InvalidNodeRefException,
                                                                     org.alfresco.service.cmr.repository.XPathException

Specified by:

selectNodes in interface org.alfresco.service.cmr.search.SearchService

Throws:

org.alfresco.service.cmr.repository.InvalidNodeRefException

org.alfresco.service.cmr.repository.XPathException

See Also:

NodeSearcher

selectProperties

public List<Serializable> selectProperties(org.alfresco.service.cmr.repository.NodeRef contextNodeRef,
                                           String xpath,
                                           org.alfresco.service.cmr.search.QueryParameterDefinition[] parameters,
                                           org.alfresco.service.namespace.NamespacePrefixResolver namespacePrefixResolver,
                                           boolean followAllParentLinks,
                                           String language)
                                    throws org.alfresco.service.cmr.repository.InvalidNodeRefException,
                                           org.alfresco.service.cmr.repository.XPathException

Specified by:

selectProperties in interface org.alfresco.service.cmr.search.SearchService

Throws:

org.alfresco.service.cmr.repository.InvalidNodeRefException

org.alfresco.service.cmr.repository.XPathException

See Also:

NodeSearcher

contains

public boolean contains(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                        org.alfresco.service.namespace.QName propertyQName,
                        String googleLikePattern)

Specified by:

contains in interface org.alfresco.service.cmr.search.SearchService

Returns:

Returns true if the pattern is present, otherwise false.

contains

public boolean contains(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                        org.alfresco.service.namespace.QName propertyQName,
                        String googleLikePattern,
                        org.alfresco.service.cmr.search.SearchParameters.Operator defaultOperator)

Specified by:

contains in interface org.alfresco.service.cmr.search.SearchService

Returns:

Returns true if the pattern is present, otherwise false.

like

public boolean like(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                    org.alfresco.service.namespace.QName propertyQName,
                    String sqlLikePattern,
                    boolean includeFTS)

Specified by:

like in interface org.alfresco.service.cmr.search.SearchService

Returns:

Returns true if the pattern is present, otherwise false.

selectNodes

public List<org.alfresco.service.cmr.repository.NodeRef> selectNodes(org.alfresco.service.cmr.repository.NodeRef contextNodeRef,
                                                                     String xpath,
                                                                     org.alfresco.service.cmr.search.QueryParameterDefinition[] parameters,
                                                                     org.alfresco.service.namespace.NamespacePrefixResolver namespacePrefixResolver,
                                                                     boolean followAllParentLinks)
                                                              throws org.alfresco.service.cmr.repository.InvalidNodeRefException,
                                                                     org.alfresco.service.cmr.repository.XPathException

Specified by:

selectNodes in interface org.alfresco.service.cmr.search.SearchService

Throws:

org.alfresco.service.cmr.repository.InvalidNodeRefException

org.alfresco.service.cmr.repository.XPathException

selectProperties

public List<Serializable> selectProperties(org.alfresco.service.cmr.repository.NodeRef contextNodeRef,
                                           String xpath,
                                           org.alfresco.service.cmr.search.QueryParameterDefinition[] parameters,
                                           org.alfresco.service.namespace.NamespacePrefixResolver namespacePrefixResolver,
                                           boolean followAllParentLinks)
                                    throws org.alfresco.service.cmr.repository.InvalidNodeRefException,
                                           org.alfresco.service.cmr.repository.XPathException

Specified by:

selectProperties in interface org.alfresco.service.cmr.search.SearchService

Throws:

org.alfresco.service.cmr.repository.InvalidNodeRefException

org.alfresco.service.cmr.repository.XPathException

getTopTerms

public List<org.alfresco.util.Pair<String,Integer>> getTopTerms(String field,
                                                                int count)

Description copied from interface: LuceneSearcher

Get top terms

Specified by:

getTopTerms in interface LuceneSearcher

Parameters:

field - String

count - int

Returns:

List

getClosingIndexSearcher

public ClosingIndexSearcher getClosingIndexSearcher()

Description copied from interface: LuceneSearcher

Get a lucene searcher

Specified by:

getClosingIndexSearcher in interface LuceneSearcher

Returns:

ClosingIndexSearcher