|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SearchIndexer
Interface of pluggable indexer. An Indexer can add documents to the main Lucene index.
Method Summary | |
---|---|
String |
getDescription()
Returns the indexer service description |
List<org.apache.lucene.document.Document> |
getDocuments(String strIdDocument)
Returns a List of lucene documents to add to the index |
List<String> |
getListType()
Returns all the types
of document the service may index. |
String |
getName()
Returns the indexer service name |
String |
getSpecificSearchAppUrl()
Returns the search app dedicated to the documents indexed by the service |
String |
getVersion()
Returns the indexer service version |
void |
indexDocuments()
Index all lucene documents from the plugin, replace List |
boolean |
isEnable()
Tells whether the service is enable or not |
Method Detail |
---|
void indexDocuments() throws IOException, InterruptedException, SiteMessageException
IOException
- If an IO error occured
InterruptedException
- If a thread error occured
SiteMessageException
- occurs when a site message need to be displayedList<org.apache.lucene.document.Document> getDocuments(String strIdDocument) throws IOException, InterruptedException, SiteMessageException
strIdDocument
- document id
IOException
- If an IO error occured
InterruptedException
- If a thread error occured
SiteMessageException
- occurs when a site message need to be displayedString getName()
String getVersion()
String getDescription()
boolean isEnable()
List<String> getListType()
types
of document the service may index.
(See SearchItem.getType()
)
String getSpecificSearchAppUrl()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |