1 /*
2 * Copyright (c) 2002-2021, City of 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.plugins.blog.service.docsearch;
35
36 import fr.paris.lutece.portal.service.message.SiteMessageException;
37 import fr.paris.lutece.plugins.blog.business.Blog;
38 import org.apache.lucene.index.IndexWriter;
39
40 import java.io.IOException;
41
42 /**
43 *
44 * IBlogsSearchIndexer
45 *
46 */
47 public interface IBlogSearchIndexer
48 {
49 void updateDocument( IndexWriter indexWriter, Blog blog ) throws IOException;
50
51 /**
52 * add to the index writer the document associate to the key specified in parameter
53 *
54 * @param indexWriter
55 * lucene index writer
56 * @param bCreate
57 * true for indexing all directory false for use incremental indexing
58 * @param sbLog
59 * the buffer logger
60 * @throws IOException
61 * If an IO error occured
62 * @throws InterruptedException
63 * If a thread error occured
64 * @throws SiteMessageException
65 * occurs when a site message need to be displayed
66 */
67 void processIndexing( IndexWriter indexWriter, boolean bCreate, StringBuilder sbLog ) throws IOException, InterruptedException, SiteMessageException;
68
69 /**
70 * Returns the indexer service name
71 *
72 * @return the indexer service name
73 */
74 String getName( );
75
76 /**
77 * Returns the indexer service version
78 *
79 * @return the indexer service version
80 */
81 String getVersion( );
82
83 /**
84 * Returns the indexer service description
85 *
86 * @return the indexer service description
87 */
88 String getDescription( );
89
90 /**
91 * Tells whether the service is enable or not
92 *
93 * @return true if enable, otherwise false
94 */
95 boolean isEnable( );
96 }