Package com.logicaldoc.gui.frontend.client.services

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

Nested Classes

Modifier and Type	Interface	Description
static class	SearchEngineService.Instance

Method Summary

Modifier and Type	Method	Description
String	check()	Checks the indexer
long	countEntries()	Counts the total number of entries
GUISearchEngine	getInfo()	Loads a search engine that contains all search engine details.
void	purge()	Launches the purge
GUIResult	query(String query, int page, int size)	Executes a low-level query in the fulltext index
void	remove(Long[] entryIds)	Removes a set of entries from the index
void	reorderTokenFilters(String[] filters)	Reorders the token filters.
void	rescheduleAll(boolean dropIndex)	Reschedule all entries for indexing
void	save(GUISearchEngine searchEngine)	Saves search engine settings
void	saveTokenFilterSettings(String filter, GUIParameter[] settings)	Saves the settings of the specified token filter
void	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 language
void	setTokenFilterStatus(String language, boolean active)	Changes the activation status of a token filter
void	unlock()	Unlocks the indexer

Method Detail

getInfo

GUISearchEngine getInfo()
                 throws ServerException

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

long countEntries()
           throws ServerException

Counts the total number of entries

Returns:

number of entries in the index

Throws:

ServerException - an error happened in the server application

unlock

void unlock()
     throws ServerException

Unlocks the indexer

Throws:

ServerException - an error happened in the server application

check

String check()
      throws ServerException

Checks the indexer

Returns:

check report

Throws:

ServerException - an error happened in the server application

rescheduleAll

void rescheduleAll(boolean dropIndex)
            throws ServerException

Reschedule all entries for indexing

Parameters:

dropIndex - must the index be dropped also?

Throws:

ServerException - an error happened in the server application

save

void save(GUISearchEngine searchEngine)
   throws ServerException

Saves search engine settings

Parameters:

searchEngine - the engine to update

Throws:

ServerException - an error happened in the server application

setLanguageStatus

void setLanguageStatus(String language,
                       boolean active)
                throws ServerException

Changes the activation status of a language

Parameters:

language - the language to change

active - the new active status

Throws:

ServerException - an error happened in the server application

setAliases

void setAliases(String extension,
                String aliases)
         throws ServerException

Sets the parser aliases for the given extension. Aliases must be a comma-separated values

Parameters:

extension - the file extension e.g.: xml

aliases - comma-separated list of aliases e.g.: html,htmlx

Throws:

ServerException - an error happened in the server application

reorderTokenFilters

void reorderTokenFilters(String[] filters)
                  throws ServerException

Reorders the token filters.

Parameters:

filters - the ordered list of the filters

Throws:

ServerException - an error happened in the server application

saveTokenFilterSettings

void saveTokenFilterSettings(String filter,
                             GUIParameter[] settings)
                      throws ServerException

Saves the settings of the specified token filter

Parameters:

filter - token filter

settings - parameters

Throws:

ServerException - an error happened in the server application

setTokenFilterStatus

void setTokenFilterStatus(String language,
                          boolean active)
                   throws ServerException

Changes the activation status of a token filter

Parameters:

language - the language

active - the new activation status

Throws:

ServerException - an error happened in the server application

purge

void purge()
    throws ServerException

Launches the purge

Throws:

ServerException - an error happened in the server application

query

GUIResult query(String query,
                int page,
                int size)
         throws ServerException

Executes a low-level query in the fulltext index

Parameters:

query - the query to use

page - the page to retrieve

size - the maximum number of entries to retrieve

Returns:

the result

Throws:

ServerException - an error happened in the server application

remove

void remove(Long[] entryIds)
     throws ServerException

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