1 /*
2 * Copyright (c) 2002-2014, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.portal.service.search;
35
36 import fr.paris.lutece.portal.service.message.SiteMessageException;
37
38 import org.apache.lucene.document.Document;
39
40 import java.io.IOException;
41
42 import java.util.List;
43
44
45 /**
46 * Interface of pluggable indexer. An Indexer can add documents to the main Lucene index.
47 */
48 public interface SearchIndexer
49 {
50 /**
51 * Index all lucene documents from the plugin, replace List<Document> getDocuments( ) method
52 * @throws IOException If an IO error occured
53 * @throws InterruptedException If a thread error occured
54 * @throws SiteMessageException occurs when a site message need to be displayed
55 */
56 void indexDocuments( ) throws IOException, InterruptedException, SiteMessageException;
57
58 /**
59 * Returns a List of lucene documents to add to the index
60 * @param strIdDocument document id
61 * @return A List of lucene documents to add to the index
62 * @throws IOException If an IO error occured
63 * @throws InterruptedException If a thread error occured
64 * @throws SiteMessageException occurs when a site message need to be displayed
65 */
66 List<Document> getDocuments( String strIdDocument )
67 throws IOException, InterruptedException, SiteMessageException;
68
69 /**
70 * Returns the indexer service name
71 * @return the indexer service name
72 */
73 String getName( );
74
75 /**
76 * Returns the indexer service version
77 * @return the indexer service version
78 */
79 String getVersion( );
80
81 /**
82 * Returns the indexer service description
83 * @return the indexer service description
84 */
85 String getDescription( );
86
87 /**
88 * Tells whether the service is enable or not
89 * @return true if enable, otherwise false
90 */
91 boolean isEnable( );
92
93 /**
94 * Returns all the {@link fr.paris.lutece.portal.service.search.SearchItem#FIELD_TYPE types}
95 * of document the service may index.
96 * (See {@link fr.paris.lutece.portal.service.search.SearchItem#getType()})
97 * @return The list
98 */
99 List<String> getListType( );
100
101 /**
102 * Returns the search app dedicated to the documents indexed by the service
103 * @return the url of the app page
104 */
105 String getSpecificSearchAppUrl( );
106 }