com.logicaldoc.core.searchengine

Interface SearchEngine

All Known Implementing Classes:

StandardSearchEngine

public interface SearchEngine

Model of a search engine with search and I/O capabilities. Various implementations can be provided, and the configuration property searchengine must qualify the concrete implementation to use.

Since:

6.5

Author:

Marco Meschieri - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
void	addHit(Document document, InputStream content) Adds a new hit to the index
void	addHit(Document document, String content) Adds a new Hit into the index
String	check() Launch the check on the Index
void	close() Close all indexing operations, shuts down the engine.
void	deleteHit(long id) Deletes an hit in the index of the search engine.
void	deleteHits(Collection<Long> ids) Removed all passed hits from the index
void	dropIndexes() Drops the fulltext index
long	getCount() Returns the number of indexed documents in all indexes.
Hit	getHit(long id)
Object	getServer() Service method to get access from the internal core
void	init() To be called on the context startup, this method creates all indexes and unlock the existing ones
boolean	isLocked() Check if at least one index is locked
void	optimize() Launch the index optimization and triggers the build of spellcheck dictionary
Hits	search(String expression, String[] filters, String expressionLanguage, Integer rows) Search for hits.
void	unlock() This method can unlock a locked index.

Method Detail

addHit

void addHit(Document document,
          String content)
            throws Exception

Adds a new Hit into the index

Parameters:

document -

content -

Throws:

Exception

addHit

void addHit(Document document,
          InputStream content)
            throws Exception

Adds a new hit to the index

Parameters:

content - Stream of the document's file

document - The document that we want to add

Throws:

Exception

optimize

void optimize()

Launch the index optimization and triggers the build of spellcheck dictionary

check

String check()

Launch the check on the Index

deleteHit

void deleteHit(long id)

Deletes an hit in the index of the search engine.

Parameters:

id - - id of the hit

deleteHits

void deleteHits(Collection<Long> ids)

Removed all passed hits from the index

Parameters:

ids - Collection of hit identifiers

getHit

Hit getHit(long id)

search

Hits search(String expression,
          String[] filters,
          String expressionLanguage,
          Integer rows)

Search for hits.
Attention: The hits will be populated with just the fields stored in the index.

close

void close()

Close all indexing operations, shuts down the engine.

unlock

void unlock()

This method can unlock a locked index.

isLocked

boolean isLocked()

Check if at least one index is locked

Returns:

true if one or more indexes are locked

getCount

long getCount()

Returns the number of indexed documents in all indexes. Used for statistical output.

dropIndexes

void dropIndexes()

Drops the fulltext index

init

void init()

To be called on the context startup, this method creates all indexes and unlock the existing ones

getServer

Object getServer()

Service method to get access from the internal core