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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
|
package de.lmu.ifi.dbs.elki.database;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2011
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.util.BitSet;
import java.util.Collection;
import java.util.Collections;
import de.lmu.ifi.dbs.elki.data.type.SimpleTypeInformation;
import de.lmu.ifi.dbs.elki.data.type.TypeUtil;
import de.lmu.ifi.dbs.elki.database.ids.ArrayDBIDs;
import de.lmu.ifi.dbs.elki.database.ids.ArrayModifiableDBIDs;
import de.lmu.ifi.dbs.elki.database.ids.DBID;
import de.lmu.ifi.dbs.elki.database.ids.DBIDUtil;
import de.lmu.ifi.dbs.elki.database.ids.StaticDBIDs;
import de.lmu.ifi.dbs.elki.database.relation.DBIDView;
import de.lmu.ifi.dbs.elki.database.relation.MaterializedRelation;
import de.lmu.ifi.dbs.elki.database.relation.Relation;
import de.lmu.ifi.dbs.elki.datasource.DatabaseConnection;
import de.lmu.ifi.dbs.elki.datasource.FileBasedDatabaseConnection;
import de.lmu.ifi.dbs.elki.datasource.bundle.MultipleObjectsBundle;
import de.lmu.ifi.dbs.elki.datasource.bundle.ObjectBundle;
import de.lmu.ifi.dbs.elki.index.Index;
import de.lmu.ifi.dbs.elki.index.IndexFactory;
import de.lmu.ifi.dbs.elki.logging.Logging;
import de.lmu.ifi.dbs.elki.utilities.documentation.Description;
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.Parameterizable;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.Parameterization;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ObjectListParameter;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ObjectParameter;
/**
* This database class uses array-based storage and thus does not allow for
* dynamic insert, delete and update operations. However, array access is
* expected to be faster and use less memory.
*
* @author Arthur Zimek
* @author Erich Schubert
*
* @apiviz.landmark
* @apiviz.composedOf ArrayDBIDs
* @apiviz.uses DatabaseConnection
*/
@Description("Database using an in-memory hashtable and at least providing linear scans.")
public class StaticArrayDatabase extends AbstractDatabase implements Database, Parameterizable {
/**
* Our logger
*/
private static final Logging logger = Logging.getLogger(StaticArrayDatabase.class);
/**
* IDs of this database
*/
private ArrayDBIDs ids;
/**
* The DBID representation we use
*/
private DBIDView idrep;
/**
* The data source we get the initial data from.
*/
protected DatabaseConnection databaseConnection;
/**
* Constructor.
*
* @param databaseConnection Database connection to get the initial data from.
* @param indexFactories Indexes to add
*/
public StaticArrayDatabase(DatabaseConnection databaseConnection, Collection<IndexFactory<?, ?>> indexFactories) {
super();
this.databaseConnection = databaseConnection;
this.ids = null;
this.idrep = null;
// Add indexes.
if(indexFactories != null) {
this.indexFactories.addAll(indexFactories);
}
}
/**
* Constructor with no indexes.
*/
public StaticArrayDatabase() {
this(null, null);
}
/**
* Initialize the database by getting the initial data from the database
* connection.
*/
@Override
public void initialize() {
if(databaseConnection != null) {
if(logger.isDebugging()) {
logger.debugFine("Loading data from database connection.");
}
MultipleObjectsBundle objpackages = databaseConnection.loadData();
// Run at most once.
databaseConnection = null;
// Find DBID column
int idrepnr = findDBIDColumn(objpackages);
// Build DBID array
if(idrepnr == -1) {
this.ids = DBIDUtil.generateStaticDBIDRange(objpackages.dataLength());
}
else {
final ArrayModifiableDBIDs newids = DBIDUtil.newArray(objpackages.dataLength());
for(int j = 0; j < objpackages.dataLength(); j++) {
DBID newid = (DBID) objpackages.data(j, idrepnr);
newids.add(newid);
}
this.ids = newids;
}
// Replace id representation.
// TODO: this is an ugly hack
this.idrep = new DBIDView(this, this.ids);
relations.add(this.idrep);
// insert into db - note: DBIDs should have been prepared before this!
Relation<?>[] targets = alignColumns(objpackages);
for(int j = 0; j < objpackages.dataLength(); j++) {
// insert object
final DBID newid = ids.get(j);
for(int i = 0; i < targets.length; i++) {
// DBIDs were handled above.
if(i == idrepnr) {
continue;
}
@SuppressWarnings("unchecked")
final Relation<Object> relation = (Relation<Object>) targets[i];
relation.set(newid, objpackages.data(j, i));
}
}
for(Relation<?> relation : relations) {
SimpleTypeInformation<?> meta = relation.getDataTypeInformation();
// Try to add indexes where appropriate
for(IndexFactory<?, ?> factory : indexFactories) {
if(factory.getInputTypeRestriction().isAssignableFromType(meta)) {
@SuppressWarnings("unchecked")
final IndexFactory<Object, ?> ofact = (IndexFactory<Object, ?>) factory;
@SuppressWarnings("unchecked")
final Relation<Object> orep = (Relation<Object>) relation;
final Index index = ofact.instantiate(orep);
addIndex(index);
index.insertAll(ids);
}
}
}
// fire insertion event
eventManager.fireObjectsInserted(ids);
}
}
@Override
public void addIndex(Index index) {
this.indexes.add(index);
// TODO: actually add index to the representation used?
this.addChildResult(index);
}
@Override
public Collection<Index> getIndexes() {
return Collections.unmodifiableList(this.indexes);
}
@Override
public void removeIndex(Index index) {
this.indexes.remove(index);
this.getHierarchy().remove(this, index);
}
/**
* Find an DBID column.
*
* @param pack Package to process
* @return DBID column
*/
protected int findDBIDColumn(ObjectBundle pack) {
for(int i = 0; i < pack.metaLength(); i++) {
SimpleTypeInformation<?> meta = pack.meta(i);
if(TypeUtil.DBID.isAssignableFromType(meta)) {
return i;
}
}
return -1;
}
/**
* Find a mapping from package columns to database columns, eventually adding
* new database columns when needed.
*
* @param pack Package to process
* @return Column mapping
*/
protected Relation<?>[] alignColumns(ObjectBundle pack) {
// align representations.
Relation<?>[] targets = new Relation<?>[pack.metaLength()];
BitSet used = new BitSet(relations.size());
for(int i = 0; i < targets.length; i++) {
SimpleTypeInformation<?> meta = pack.meta(i);
// TODO: aggressively try to match exact metas first?
// Try to match unused representations only
for(int j = used.nextClearBit(0); j >= 0 && j < relations.size(); j = used.nextClearBit(j + 1)) {
Relation<?> relation = relations.get(j);
if(relation.getDataTypeInformation().isAssignableFromType(meta)) {
targets[i] = relation;
used.set(j);
break;
}
}
if(targets[i] == null) {
targets[i] = addNewRelation(meta);
used.set(relations.size() - 1);
}
}
return targets;
}
/**
* Add a new representation for the given meta.
*
* @param meta meta data
* @return new representation
*/
private Relation<?> addNewRelation(SimpleTypeInformation<?> meta) {
@SuppressWarnings("unchecked")
SimpleTypeInformation<Object> ometa = (SimpleTypeInformation<Object>) meta;
Relation<?> relation = new MaterializedRelation<Object>(this, ometa, ids);
relations.add(relation);
getHierarchy().add(this, relation);
return relation;
}
@Deprecated
@Override
public final int size() {
return ids.size();
}
@Deprecated
@Override
public StaticDBIDs getDBIDs() {
return DBIDUtil.makeUnmodifiable(ids);
}
@Override
protected Logging getLogger() {
return logger;
}
/**
* Parameterization class.
*
* @author Erich Schubert
*
* @apiviz.exclude
*/
public static class Parameterizer extends AbstractParameterizer {
/**
* Holds the database connection to get the initial data from.
*/
protected DatabaseConnection databaseConnection = null;
/**
* Indexes to add.
*/
private Collection<IndexFactory<?, ?>> indexFactories;
@Override
protected void makeOptions(Parameterization config) {
super.makeOptions(config);
// Get database connection.
final ObjectParameter<DatabaseConnection> dbcP = new ObjectParameter<DatabaseConnection>(OptionID.DATABASE_CONNECTION, DatabaseConnection.class, FileBasedDatabaseConnection.class);
if(config.grab(dbcP)) {
databaseConnection = dbcP.instantiateClass(config);
}
// Get indexes.
final ObjectListParameter<IndexFactory<?, ?>> indexFactoryP = new ObjectListParameter<IndexFactory<?, ?>>(INDEX_ID, IndexFactory.class, true);
if(config.grab(indexFactoryP)) {
indexFactories = indexFactoryP.instantiateClasses(config);
}
}
@Override
protected StaticArrayDatabase makeInstance() {
return new StaticArrayDatabase(databaseConnection, indexFactories);
}
}
}
|