1   /*
2    *  IndexDefinition.java
3    *
4    *  Copyright (c) 1998-2005, The University of Sheffield.
5    *
6    *  This file is part of GATE (see http://gate.ac.uk/), and is free
7    *  software, licenced under the GNU Library General Public License,
8    *  Version 2, June 1991 (in the distribution as file licence.html,
9    *  and also available at http://gate.ac.uk/gate/licence.html).
10   *
11   *  Rosen Marinov, 19/Apr/2002
12   *
13   */
14  
15  package gate.creole.ir;
16  
17  import java.io.Serializable;
18  import java.util.Iterator;
19  
20  public interface IndexDefinition extends Serializable{
21  
22    static final long serialVersionUID = 3632609241787241616L;
23  
24    /** @return String  path of index store directory*/
25    public String getIndexLocation();
26  
27    /**  @return Iterator of IndexFields, fileds for indexing. */
28    public Iterator getIndexFields();
29  
30  //  /**  @return int index type*/
31  //  public int getIndexType();
32  
33    /**
34     * Gets the type of IR engine to be used for indexing
35     * @return a String.
36     */
37    public String getIrEngineClassName();
38  }