org.olat.lms.search

类 SearchServiceImpl

java.lang.Object

org.olat.lms.search.SearchServiceImpl

所有已实现的接口:

SearchService

public class SearchServiceImpl
extends java.lang.Object
implements SearchService

作者:

Christian Guretzki

方法概要

方法

限定符和类型	方法和说明
void	addToIndex(org.apache.lucene.document.Document document) Add a document to existing index.
void	deleteFromIndex(org.apache.lucene.document.Document document) Delete a document in existing index.
SearchResults	doSearch(java.lang.String queryString, java.util.List<java.lang.String> condQueries, Identity identity, Roles roles, int firstResult, int maxResults, boolean doHighlighting) Do search a certain query.
long	getQueryCount()
SearchModule	getSearchModuleConfig() access the module configuration
SearchServiceStatus	getStatus() Return current state of search service, Includes full-indexing, index and search.
void	init() Initializes service.
boolean	isEnabled()
void	setMaxIndexTime(long maxIndexTime) [used by spring]
void	setMetadataFields(SearchMetadataFieldsProvider metadataFields) [used by spring] Spring setter to inject the available metadata
java.util.Set<java.lang.String>	spellCheck(java.lang.String query) Check a query for similar words.
void	startIndexing(boolean testMode) Start a new full index.
void	stop() Shuts down search service.
void	stopIndexing() Stop current full-indexing.

从类继承的方法 java.lang.Object

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

方法详细资料

setMaxIndexTime

public void setMaxIndexTime(long maxIndexTime)

[used by spring]

setMetadataFields

public void setMetadataFields(SearchMetadataFieldsProvider metadataFields)

[used by spring] Spring setter to inject the available metadata

参数:

metadataFields -

init

public void init()

从接口复制的说明: SearchService

Initializes service.

指定者:

init 在接口中 SearchService

stop

public void stop()

从接口复制的说明: SearchService

Shuts down search service.

指定者:

stop 在接口中 SearchService

doSearch

public SearchResults doSearch(java.lang.String queryString,
                     java.util.List<java.lang.String> condQueries,
                     Identity identity,
                     Roles roles,
                     int firstResult,
                     int maxResults,
                     boolean doHighlighting)
                       throws ServiceNotAvailableException,
                              QueryException

从接口复制的说明: SearchService

Do search a certain query. The results will be filtered for the identity and roles.

指定者:

doSearch 在接口中 SearchService

参数:

queryString - Search query-string.

identity - Filter results for this identity (user).

roles - Filter results for this roles (role of user).

返回:

SearchResults object for this query

抛出:

ServiceNotAvailableException

QueryException

spellCheck

public java.util.Set<java.lang.String> spellCheck(java.lang.String query)

从接口复制的说明: SearchService

Check a query for similar words.

指定者:

spellCheck 在接口中 SearchService

返回:

List of similar words which exist in index or null if

startIndexing

public void startIndexing(boolean testMode)

从接口复制的说明: SearchService

Start a new full index.

指定者:

startIndexing 在接口中 SearchService

参数:

testMode - if set to true existing index won't be replaced after new index has been generated

stopIndexing

public void stopIndexing()

从接口复制的说明: SearchService

Stop current full-indexing.

指定者:

stopIndexing 在接口中 SearchService

addToIndex

public void addToIndex(org.apache.lucene.document.Document document)

从接口复制的说明: SearchService

Add a document to existing index.

指定者:

addToIndex 在接口中 SearchService

参数:

document - New document.

deleteFromIndex

public void deleteFromIndex(org.apache.lucene.document.Document document)

从接口复制的说明: SearchService

Delete a document in existing index.

指定者:

deleteFromIndex 在接口中 SearchService

参数:

document - Delete this document.

getQueryCount

public long getQueryCount()

指定者:

getQueryCount 在接口中 SearchService

getStatus

public SearchServiceStatus getStatus()

从接口复制的说明: SearchService

Return current state of search service, Includes full-indexing, index and search.

指定者:

getStatus 在接口中 SearchService

返回:

getSearchModuleConfig

public SearchModule getSearchModuleConfig()

从接口复制的说明: SearchService

access the module configuration

指定者:

getSearchModuleConfig 在接口中 SearchService

返回:

isEnabled

public boolean isEnabled()

指定者:

isEnabled 在接口中 SearchService

返回:

true when the search service is enabled