1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
package de.lmu.ifi.dbs.elki.database.lucene;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2015
Ludwig-Maximilians-Universität München
Lehr- und Forschungseinheit für Datenbanksysteme
ELKI Development Team
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import java.io.File;
import java.io.IOException;
import org.apache.lucene.index.CorruptIndexException;
import org.apache.lucene.index.IndexReader;
import org.apache.lucene.store.Directory;
import org.apache.lucene.store.FSDirectory;
import de.lmu.ifi.dbs.elki.database.AbstractDatabase;
import de.lmu.ifi.dbs.elki.database.ids.DBID;
import de.lmu.ifi.dbs.elki.database.ids.DBIDRange;
import de.lmu.ifi.dbs.elki.database.ids.DBIDUtil;
import de.lmu.ifi.dbs.elki.database.query.distance.DistanceQuery;
import de.lmu.ifi.dbs.elki.database.query.knn.KNNQuery;
import de.lmu.ifi.dbs.elki.database.query.range.RangeQuery;
import de.lmu.ifi.dbs.elki.database.relation.DBIDView;
import de.lmu.ifi.dbs.elki.logging.Logging;
import de.lmu.ifi.dbs.elki.utilities.exceptions.AbortException;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.OptionID;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.Parameterization;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.FileParameter;
/**
* Database backend using Lucene 3.
*
* @author Erich Schubert
* @since 0.6.0
*/
public class LuceneDatabase extends AbstractDatabase {
/**
* Class logger.
*/
public static final Logging LOG = Logging.getLogger(LuceneDatabase.class);
/**
* IDs of this database
*/
private DBIDRange ids;
/**
* The DBID representation we use
*/
private DBIDView idrep;
/**
* Lucene database directory.
*/
private Directory directory;
/**
* Lucene index reader.
*/
private IndexReader reader;
/**
* Document representation.
*/
private LuceneDocumentRelation docrep;
/**
* Constructor.
*
* @param directory Lucene directory.
*/
public LuceneDatabase(Directory directory) {
super();
this.directory = directory;
}
@Override
public void initialize() {
try {
reader = IndexReader.open(directory);
ids = DBIDUtil.generateStaticDBIDRange(reader.maxDoc());
// ID relation:
idrep = new DBIDView(ids);
relations.add(idrep);
getHierarchy().add(this, idrep);
// Documents relation:
docrep = new LuceneDocumentRelation(ids, reader);
relations.add(docrep);
getHierarchy().add(this, docrep);
eventManager.fireObjectsInserted(ids);
}
catch(CorruptIndexException e) {
throw new AbortException("Index is corrupt.", e);
}
catch(IOException e) {
throw new AbortException("I/O error reading index.", e);
}
}
@Override
public <O> RangeQuery<O> getRangeQuery(DistanceQuery<O> distanceQuery, Object... hints) {
if(distanceQuery.getDistanceFunction() instanceof LuceneDistanceFunction) {
@SuppressWarnings("unchecked")
final RangeQuery<O> rq = (RangeQuery<O>) new LuceneDistanceRangeQuery((DistanceQuery<DBID>) distanceQuery, reader, ids);
return rq;
}
return super.getRangeQuery(distanceQuery, hints);
}
@Override
public <O> KNNQuery<O> getKNNQuery(DistanceQuery<O> distanceQuery, Object... hints) {
if(distanceQuery.getDistanceFunction() instanceof LuceneDistanceFunction) {
@SuppressWarnings("unchecked")
final KNNQuery<O> kq = (KNNQuery<O>) new LuceneDistanceKNNQuery((DistanceQuery<DBID>) distanceQuery, reader, ids);
return kq;
}
return super.getKNNQuery(distanceQuery, hints);
}
@Override
protected Logging getLogger() {
return LOG;
}
/**
* Parameterization class.
*
* @author Erich Schubert
*/
public static final class Parameterizer extends AbstractParameterizer {
/**
* Option ID for the index folder.
*/
public static final OptionID INDEX_DIR_ID = new OptionID("lucene.index", "Lucene index directory.");
/**
* Index folder.
*/
File idir;
@Override
protected void makeOptions(Parameterization config) {
super.makeOptions(config);
FileParameter fileP = new FileParameter(INDEX_DIR_ID, FileParameter.FileType.INPUT_FILE);
if(config.grab(fileP)) {
idir = fileP.getValue();
}
}
@Override
protected LuceneDatabase makeInstance() {
try {
return new LuceneDatabase(FSDirectory.open(idir));
}
catch(IOException e) {
throw new AbortException("I/O error opening index.", e);
}
}
}
}
|
