fr.paris.lutece.portal.service.search
Class PageIndexer

java.lang.Object
  extended by fr.paris.lutece.portal.service.search.PageIndexer
All Implemented Interfaces:
SearchIndexer

public class PageIndexer
extends java.lang.Object
implements SearchIndexer

Indexer service for pages


Field Summary
protected static IPageService _pageService
           
static java.lang.String INDEX_TYPE_PAGE
           
static java.lang.String INDEXER_NAME
           
protected static java.lang.String PARAMETER_PAGE_ID
           
protected static java.lang.String PROPERTY_INDEXER_ENABLE
           
protected static java.lang.String PROPERTY_PAGE_BASE_URL
           
protected static java.lang.String PROPERTY_SEARCH_PAGE_URL
           
 
Constructor Summary
PageIndexer()
           
 
Method Summary
 java.lang.String getDescription()
          Returns the indexer service description
protected  org.apache.lucene.document.Document getDocument(Page page, java.lang.String strUrl)
          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.
 java.util.List<org.apache.lucene.document.Document> getDocuments(java.lang.String nIdDocument)
          Returns a List of lucene documents to add to the index
 java.util.List<java.lang.String> getListType()
          Returns all the types of document the service may index.
 java.lang.String getName()
          Returns the indexer service name
 java.lang.String getSpecificSearchAppUrl()
          Returns the search app dedicated to the documents indexed by the service
 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INDEX_TYPE_PAGE

public static final java.lang.String INDEX_TYPE_PAGE
See Also:
Constant Field Values

INDEXER_NAME

public static final java.lang.String INDEXER_NAME
See Also:
Constant Field Values

PROPERTY_PAGE_BASE_URL

protected static final java.lang.String PROPERTY_PAGE_BASE_URL
See Also:
Constant Field Values

PROPERTY_SEARCH_PAGE_URL

protected static final java.lang.String PROPERTY_SEARCH_PAGE_URL
See Also:
Constant Field Values

PROPERTY_INDEXER_ENABLE

protected static final java.lang.String PROPERTY_INDEXER_ENABLE
See Also:
Constant Field Values

PARAMETER_PAGE_ID

protected static final java.lang.String PARAMETER_PAGE_ID
See Also:
Constant Field Values

_pageService

protected static IPageService _pageService
Constructor Detail

PageIndexer

public PageIndexer()
Method Detail

indexDocuments

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

Specified by:
indexDocuments in interface SearchIndexer
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

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

Specified by:
getDocuments in interface SearchIndexer
Parameters:
nIdDocument - 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

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

Specified by:
getName in interface SearchIndexer
Returns:
the indexer service name

getVersion

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

Specified by:
getVersion in interface SearchIndexer
Returns:
the indexer service version

getDescription

public java.lang.String getDescription()
Returns the indexer service description

Specified by:
getDescription in interface SearchIndexer
Returns:
the indexer service description

isEnable

public boolean isEnable()
Tells whether the service is enable or not

Specified by:
isEnable in interface SearchIndexer
Returns:
true if enable, otherwise false

getDocument

protected org.apache.lucene.document.Document getDocument(Page page,
                                                          java.lang.String strUrl)
                                                   throws java.io.IOException,
                                                          java.lang.InterruptedException,
                                                          SiteMessageException
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:
strUrl - The base URL for documents
page - the page to index
Returns:
the built Document
Throws:
java.io.IOException - The IO Exception
java.lang.InterruptedException - The InterruptedException
SiteMessageException - occurs when a site message need to be displayed

getListType

public java.util.List<java.lang.String> getListType()
Returns all the types of document the service may index. (See SearchItem.getType())

Specified by:
getListType in interface SearchIndexer
Returns:
The list

getSpecificSearchAppUrl

public java.lang.String getSpecificSearchAppUrl()
Returns the search app dedicated to the documents indexed by the service

Specified by:
getSpecificSearchAppUrl in interface SearchIndexer
Returns:
the url of the app page


Copyright © 2012 Mairie de Paris. All Rights Reserved.