fr.paris.lutece.plugins.document.service.search

Class DocumentIndexer

java.lang.Object

fr.paris.lutece.plugins.document.service.search.DocumentIndexer

All Implemented Interfaces:

fr.paris.lutece.portal.service.search.SearchIndexer

public class DocumentIndexer
extends Object
implements fr.paris.lutece.portal.service.search.SearchIndexer

Document Indexer

Field Summary

Fields

Modifier and Type	Field and Description
static String	INDEXER_NAME
static String	SHORT_NAME

Constructor Summary

Constructors

Constructor and Description
DocumentIndexer()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the indexer service description
static org.apache.lucene.document.Document	getDocument(Document document, String strUrl, String strRole, String strPortletDocumentId) Builds a document which will be used by Lucene during the indexing of the pages of the site with the following fields : summary, uid, url, contents, title and description.
List<org.apache.lucene.document.Document>	getDocuments(String strIdDocument) Returns a collection of lucene documents with the same id
List<String>	getListType()
String	getName() Returns the indexer service name
String	getSpecificSearchAppUrl()
String	getVersion() Returns the indexer service version
void	indexDocuments() index all lucene documents
boolean	isEnable() Tells whether the service is enable or not

Methods inherited from class java.lang.Object

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

Field Detail

INDEXER_NAME

public static final String INDEXER_NAME

See Also:

Constant Field Values

SHORT_NAME

public static final String SHORT_NAME

See Also:

Constant Field Values

Constructor Detail

DocumentIndexer

public DocumentIndexer()

Method Detail

indexDocuments

public void indexDocuments()
                    throws IOException,
                           InterruptedException

index all lucene documents

Specified by:

indexDocuments in interface fr.paris.lutece.portal.service.search.SearchIndexer

Throws:

IOException - i/o exception

InterruptedException - interrupted exception

getDocuments

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

Returns a collection of lucene documents with the same id

Specified by:

getDocuments in interface fr.paris.lutece.portal.service.search.SearchIndexer

Parameters:

strIdDocument - the document id

Returns:

lucene documents

Throws:

IOexception - i/o exception

InterruptedException - interrupted exception

IOException

getName

public String getName()

Returns the indexer service name

Specified by:

getName in interface fr.paris.lutece.portal.service.search.SearchIndexer

Returns:

the indexer service name

getVersion

public String getVersion()

Returns the indexer service version

Specified by:

getVersion in interface fr.paris.lutece.portal.service.search.SearchIndexer

Returns:

The indexer service version

getDescription

public String getDescription()

Returns the indexer service description

Specified by:

getDescription in interface fr.paris.lutece.portal.service.search.SearchIndexer

Returns:

The indexer service description

isEnable

public boolean isEnable()

Tells whether the service is enable or not

Specified by:

isEnable in interface fr.paris.lutece.portal.service.search.SearchIndexer

Returns:

true if enable, otherwise false

getDocument

public static org.apache.lucene.document.Document getDocument(Document document,
                                                              String strUrl,
                                                              String strRole,
                                                              String strPortletDocumentId)
                                                       throws IOException,
                                                              InterruptedException

Builds a document which will be used by Lucene during the indexing of the pages of the site with the following fields : summary, uid, url, contents, title and description.

Parameters:

document - the document to index

strUrl - the url of the documents

strRole - the lutece role of the page associate to the document

strPortletDocumentId - the document id concatened to the id portlet with a & in the middle

Returns:

the built Document

Throws:

IOException - The IO Exception

InterruptedException - The InterruptedException

getListType

public List<String> getListType()

Specified by:

getListType in interface fr.paris.lutece.portal.service.search.SearchIndexer

getSpecificSearchAppUrl

public String getSpecificSearchAppUrl()

Specified by:

getSpecificSearchAppUrl in interface fr.paris.lutece.portal.service.search.SearchIndexer