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