IREngine.java
01 /*
02  *  Copyright (c) 1995-2012, The University of Sheffield. See the file
03  *  COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
04  *
05  *  This file is part of GATE (see http://gate.ac.uk/), and is free
06  *  software, licenced under the GNU Library General Public License,
07  *  Version 2, June 1991 (in the distribution as file licence.html,
08  *  and also available at http://gate.ac.uk/gate/licence.html).
09  *
10  *  Valentin Tablan 17/05/2002
11  *
12  *  $Id: IREngine.java 15333 2012-02-07 13:18:33Z ian_roberts $
13  *
14  */
15 package gate.creole.ir;
16 
17 /**
18  * Defines an information retrieval engine which needs to supply a
19  {@link IndexManager} and a {@link Search}.
20  */
21 
22 public interface IREngine {
23 
24   /**
25    * Gets the search component of this IR engine.
26    @return {@link Search} value.
27    */
28   public Search getSearch();
29 
30   /**
31    * Gets the index manager component of this IR engine.
32    @return {@link IndexManager} value.
33    */
34   public IndexManager getIndexmanager();
35 
36   /**
37    * Gets the name for this IR engine.
38    @return {@link String} value.
39    */
40   public String getName();
41 
42 //  /**
43 //   * Returns the index type.
44 //   * @return and int.
45 //   */
46 //  public int getIndexType();
47 
48 }