| DefaultIndexDefinition.java |
1 /*
2 * DefaultIndexDefinition.java
3 *
4 * Copyright (c) 1998-2004, 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.util.*;
18
19 public class DefaultIndexDefinition implements IndexDefinition{
20
21 /** List of IndexField - objects for indexing */
22 private List fields;
23
24 /** Location (path) of the index store directory */
25 private String location;
26
27 // /** Type of index see GateConstants.java*/
28 // private int indexType;
29
30 /** Sets the location of index
31 * @param location - index directory path
32 */
33 public void setIndexLocation(String location){
34 this.location = location;
35 }
36 /** @return String path of index store directory*/
37 public String getIndexLocation(){
38 return location;
39 }
40
41 // /** @return int index type*/
42 // public int getIndexType(){
43 // return indexType;
44 // }
45 //
46 // /** Sets the index type.
47 // * @param type - index type
48 // */
49 // public void setIndexType(int type){
50 // this.indexType = type;
51 // }
52
53 /** @return Iterator of IndexFields, fileds for indexing. */
54 public Iterator getIndexFields(){
55 return fields.iterator();
56 }
57
58 /** Add new IndexField object to fields list.*/
59 public void addIndexField(IndexField fld){
60 if (fields==null){
61 fields = new Vector();
62 }
63 fields.add(fld);
64 }
65
66 /**
67 * Sets the fully qualified class name for the IR engine to be used.
68 * @param irEngineClassName a String.
69 */
70 public void setIrEngineClassName(String irEngineClassName) {
71 this.irEngineClassName = irEngineClassName;
72 }
73
74 /**
75 * Gets the fully qualified class name for the IR engine to be used.
76 * @return a String.
77 */
78 public String getIrEngineClassName() {
79 return irEngineClassName;
80 }
81
82 /**Serialisation ID*/
83 static final long serialVersionUID = 2925395897153647322L;
84 private String irEngineClassName;
85 }