fr.paris.lutece.plugins.announce.service.announcesearch

Class DefaultAnnounceIndexer

java.lang.Object

fr.paris.lutece.plugins.announce.service.announcesearch.DefaultAnnounceIndexer

All Implemented Interfaces:

IAnnounceSearchIndexer

public class DefaultAnnounceIndexer
extends Object
implements IAnnounceSearchIndexer

DefaultAnnounceIndexer

Constructor Summary

Constructors

Constructor and Description
DefaultAnnounceIndexer()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the indexer service description
static org.apache.lucene.document.Document	getDocument(Announce announce, String strUrl, fr.paris.lutece.portal.service.plugin.Plugin plugin) Builds a document which will be used by Lucene during the indexing of the announces list
static List<org.apache.lucene.document.Document>	getDocuments(String strDocument) Get the subject document
String	getName() Returns the indexer service name
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, StringBuffer sbLogs) add to the index writer the document associate to the key specified in parameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultAnnounceIndexer

public DefaultAnnounceIndexer()

Method Detail

getDescription

public String getDescription()

Returns the indexer service description

Specified by:

getDescription in interface IAnnounceSearchIndexer

Returns:

the indexer service description

processIndexing

public void processIndexing(org.apache.lucene.index.IndexWriter indexWriter,
                            boolean bCreate,
                            StringBuffer sbLogs)
                     throws IOException,
                            InterruptedException,
                            fr.paris.lutece.portal.service.message.SiteMessageException

add to the index writer the document associate to the key specified in parameter

Specified by:

processIndexing in interface IAnnounceSearchIndexer

Parameters:

indexWriter - lucene index writer

bCreate - true for indexing all directory false for use incremental indexing

sbLogs - the buffer logger

Throws:

IOException - If an IO error occured

InterruptedException - If a thread error occured

fr.paris.lutece.portal.service.message.SiteMessageException - occurs when a site message need to be displayed

getDocuments

public static List<org.apache.lucene.document.Document> getDocuments(String strDocument)
                                                              throws IOException,
                                                                     InterruptedException,
                                                                     fr.paris.lutece.portal.service.message.SiteMessageException

Get the subject document

Parameters:

strDocument - id of the subject to index

Returns:

The list of lucene documents

Throws:

IOException - If an IO Exception occurred

InterruptedException - If the indexer is interrupted

fr.paris.lutece.portal.service.message.SiteMessageException - the exception

getDocument

public static org.apache.lucene.document.Document getDocument(Announce announce,
                                                              String strUrl,
                                                              fr.paris.lutece.portal.service.plugin.Plugin plugin)
                                                       throws IOException,
                                                              InterruptedException

Builds a document which will be used by Lucene during the indexing of the announces list

Parameters:

announce - the announce

strUrl - the url

plugin - the plugin

Returns:

the document

Throws:

IOException - If an IO Exception occurred

InterruptedException - If the indexer is interrupted

getName

public String getName()

Returns the indexer service name

Specified by:

getName in interface IAnnounceSearchIndexer

Returns:

the indexer service name

getVersion

public String getVersion()

Returns the indexer service version

Specified by:

getVersion in interface IAnnounceSearchIndexer

Returns:

the indexer service version

isEnable

public boolean isEnable()

Tells whether the service is enable or not

Specified by:

isEnable in interface IAnnounceSearchIndexer

Returns:

true if enable, otherwise false