fr.paris.lutece.plugins.directory.service.directorysearch
Interface IDirectorySearchIndexer

All Known Implementing Classes:
DirectoryIndexer

public interface IDirectorySearchIndexer

IDirectorySearchIndexer


Method Summary
 java.lang.String getDescription()
          Returns the indexer service description
 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
 void processIndexing(org.apache.lucene.index.IndexWriter indexWriter, boolean bCreate, java.lang.StringBuffer sbLog)
          add to the index writer the document associate to the key specified in parameter
 

Method Detail

processIndexing

void processIndexing(org.apache.lucene.index.IndexWriter indexWriter,
                     boolean bCreate,
                     java.lang.StringBuffer sbLog)
                     throws java.io.IOException,
                            java.lang.InterruptedException,
                            fr.paris.lutece.portal.service.message.SiteMessageException
add to the index writer the document associate to the key specified in parameter

Parameters:
indexWriter - lucene index writer
bCreate - true for indexing all directory false for use incremental indexing
sbLog - the buffer logger
Throws:
java.io.IOException - If an IO error occured
java.lang.InterruptedException - If a thread error occured
fr.paris.lutece.portal.service.message.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 © 2009 Mairie de Paris. All Rights Reserved.