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