Interface SearchEngineService
- All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
- All Known Implementing Classes:
SearchEngineServiceImpl
@RemoteServiceRelativePath("searchengine")
public interface SearchEngineService
extends com.google.gwt.user.client.rpc.RemoteService
The client side stub for the Search Engine Service.
- Since:
- 6.0
- Author:
- Matteo Caruso - LogicalDOC
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptioncheck()
Checks the indexerlong
Counts the total number of entriesgetInfo()
Loads a search engine that contains all search engine details.void
purge()
Launches the purgeExecutes a low-level query in the fulltext indexvoid
Removes a set of entries from the indexvoid
reorderTokenFilters
(List<String> filters) Reorders the token filters.void
rescheduleAll
(boolean dropIndex) Reschedule all entries for indexingvoid
save
(GUISearchEngine searchEngine) Saves search engine settingsvoid
saveTokenFilterSettings
(String filter, List<GUIParameter> settings) Saves the settings of the specified token filtervoid
setAliases
(String extension, String aliases) Sets the parser aliases for the given extension.void
setLanguageStatus
(String language, boolean active) Changes the activation status of a languagevoid
setTokenFilterStatus
(String language, boolean active) Changes the activation status of a token filtervoid
unlock()
Unlocks the indexer
-
Method Details
-
getInfo
Loads a search engine that contains all search engine details.- Returns:
- details about the engine
- Throws:
ServerException
- an error happened in the server application
-
countEntries
Counts the total number of entries- Returns:
- number of entries in the index
- Throws:
ServerException
- an error happened in the server application
-
unlock
Unlocks the indexer- Throws:
ServerException
- an error happened in the server application
-
check
Checks the indexer- Returns:
- check report
- Throws:
ServerException
- an error happened in the server application
-
rescheduleAll
Reschedule all entries for indexing- Parameters:
dropIndex
- must the index be dropped also?- Throws:
ServerException
- an error happened in the server application
-
save
Saves search engine settings- Parameters:
searchEngine
- the engine to update- Throws:
ServerException
- an error happened in the server application
-
setLanguageStatus
Changes the activation status of a language- Parameters:
language
- the language to changeactive
- the new active status- Throws:
ServerException
- an error happened in the server application
-
setAliases
Sets the parser aliases for the given extension. Aliases must be a comma-separated values- Parameters:
extension
- the file extension e.g.: xmlaliases
- comma-separated list of aliases e.g.: html,htmlx- Throws:
ServerException
- an error happened in the server application
-
reorderTokenFilters
Reorders the token filters.- Parameters:
filters
- the ordered list of the filters- Throws:
ServerException
- an error happened in the server application
-
saveTokenFilterSettings
Saves the settings of the specified token filter- Parameters:
filter
- token filtersettings
- parameters- Throws:
ServerException
- an error happened in the server application
-
setTokenFilterStatus
Changes the activation status of a token filter- Parameters:
language
- the languageactive
- the new activation status- Throws:
ServerException
- an error happened in the server application
-
purge
Launches the purge- Throws:
ServerException
- an error happened in the server application
-
query
Executes a low-level query in the fulltext index- Parameters:
query
- the query to usepage
- the page to retrievesize
- the maximum number of entries to retrieve- Returns:
- the result
- Throws:
ServerException
- an error happened in the server application
-
remove
Removes a set of entries from the index- Parameters:
entryIds
- identifiers of the entries to delete- Throws:
ServerException
- an error happened in the server application
-