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
 java.lang.String getDescription()
          Returns the indexer service description
 java.util.List<org.apache.lucene.document.Document> getDocuments(java.lang.String strIdDocument)
          Returns a List of lucene documents to add to the index
 java.lang.String getName()
          Returns the indexer service name
 java.lang.String getVersion()
          Returns the indexer service version
 void indexDocuments()
          Index all lucene documents from the plugin, replace List getDocuments( ) method
 boolean isEnable()
          Tells whether the service is enable or not
 

Method Detail

indexDocuments

void indexDocuments()
                    throws java.io.IOException,
                           java.lang.InterruptedException,
                           SiteMessageException
Index all lucene documents from the plugin, replace List getDocuments( ) method

Throws:
java.io.IOException - If an IO error occured
java.lang.InterruptedException - If a thread error occured
SiteMessageException - occurs when a site message need to be displayed

getDocuments

java.util.List<org.apache.lucene.document.Document> getDocuments(java.lang.String strIdDocument)
                                                                 throws java.io.IOException,
                                                                        java.lang.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:
java.io.IOException - If an IO error occured
java.lang.InterruptedException - If a thread error occured
SiteMessageException - occurs when a site message need to be displayed

getName

java.lang.String getName()
Returns the indexer service name

Returns:
the indexer service name

getVersion

java.lang.String getVersion()
Returns the indexer service version

Returns:
the indexer service version

getDescription

java.lang.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


Copyright © 2010 Mairie de Paris. All Rights Reserved.