fr.paris.lutece.portal.service.search

Interface SearchIndexer

All Known Implementing Classes:

PageIndexer

public interface SearchIndexer

Interface of pluggable indexer. An Indexer can add documents to the main Lucene index.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the indexer service description
List<org.apache.lucene.document.Document>	getDocuments(String strIdDocument) Returns a List of lucene documents to add to the index
List<String>	getListType() Returns all the types of document the service may index.
String	getName() Returns the indexer service name
String	getSpecificSearchAppUrl() Returns the search app dedicated to the documents indexed by the service
String	getVersion() Returns the indexer service version
void	indexDocuments() Index all lucene documents from the plugin, replace List<Document> getDocuments( ) method
boolean	isEnable() Tells whether the service is enable or not

Method Detail

indexDocuments

void indexDocuments()
             throws IOException,
                    InterruptedException,
                    SiteMessageException

Index all lucene documents from the plugin, replace List<Document> getDocuments( ) method

Throws:

IOException - If an IO error occured

InterruptedException - If a thread error occured

SiteMessageException - occurs when a site message need to be displayed

getDocuments

List<org.apache.lucene.document.Document> getDocuments(String strIdDocument)
                                                throws IOException,
                                                       InterruptedException,
                                                       SiteMessageException

Returns a List of lucene documents to add to the index

Parameters:

strIdDocument - document id

Returns:

A List of lucene documents to add to the index

Throws:

IOException - If an IO error occured

InterruptedException - If a thread error occured

SiteMessageException - occurs when a site message need to be displayed

getName

String getName()

Returns the indexer service name

Returns:

the indexer service name

getVersion

String getVersion()

Returns the indexer service version

Returns:

the indexer service version

getDescription

String getDescription()

Returns the indexer service description

Returns:

the indexer service description

isEnable

boolean isEnable()

Tells whether the service is enable or not

Returns:

true if enable, otherwise false

getListType

List<String> getListType()

Returns all the types of document the service may index. (See SearchItem.getType())

Returns:

The list

getSpecificSearchAppUrl

String getSpecificSearchAppUrl()

Returns the search app dedicated to the documents indexed by the service

Returns:

the url of the app page