View Javadoc
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.plugins.lucene.service.indexer;
35  
36  import java.util.Map;
37  
38  /**
39   *
40   * IFileIndexerFactory manages multiple {@link IFileIndexer}.
41   * 
42   * @see {@link IFileIndexerFactory#getIndexer(String)}
43   *
44   */
45  public interface IFileIndexerFactory
46  {
47      /**
48       * Bean name, to retrieve the factory from the Spring context.
49       */
50      String BEAN_FILE_INDEXER_FACTORY = "lucene.fileIndexerFactory";
51  
52      /**
53       * Sets the indexers map
54       * 
55       * @param mapIndexers
56       *            the indexers to manage
57       */
58      void setIndexersMap( Map<String, IFileIndexer> mapIndexers );
59  
60      /**
61       * Returns the indexer matching the given MIMETYPE
62       * 
63       * @param strMimeType
64       *            the mime type
65       * @return the index found, <code>null</code> otherwise.
66       */
67      IFileIndexer getIndexer( String strMimeType );
68  }