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()
          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
 boolean isEnable()
          Tells whether the service is enable or not
 

Method Detail

getDocuments

java.util.List<org.apache.lucene.document.Document> getDocuments()
                                                                 throws java.io.IOException,
                                                                        java.lang.InterruptedException
Returns a List of lucene documents to add to the index

Returns:
A List of lucene documents to add to the index
Throws:
java.io.IOException
java.lang.InterruptedException

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 © 2007 Mairie de Paris. All Rights Reserved.