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 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 /** 50 * add to the index writer the document associate to the key specified in parameter 51 * 52 * @param indexWriter 53 * lucene index writer 54 * @param bCreate 55 * true for indexing all directory false for use incremental indexing 56 * @param sbLog 57 * the buffer logger 58 * @throws IOException 59 * If an IO error occured 60 * @throws InterruptedException 61 * If a thread error occured 62 * @throws SiteMessageException 63 * occurs when a site message need to be displayed 64 */ 65 void processIndexing( IndexWriter indexWriter, boolean bCreate, StringBuilder sbLog ) throws IOException, InterruptedException, SiteMessageException; 66 67 /** 68 * Returns the indexer service name 69 * 70 * @return the indexer service name 71 */ 72 String getName( ); 73 74 /** 75 * Returns the indexer service version 76 * 77 * @return the indexer service version 78 */ 79 String getVersion( ); 80 81 /** 82 * Returns the indexer service description 83 * 84 * @return the indexer service description 85 */ 86 String getDescription( ); 87 88 /** 89 * Tells whether the service is enable or not 90 * 91 * @return true if enable, otherwise false 92 */ 93 boolean isEnable( ); 94 }