package de.lmu.ifi.dbs.elki.database.relation;
/*
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 .
*/
import de.lmu.ifi.dbs.elki.data.type.SimpleTypeInformation;
import de.lmu.ifi.dbs.elki.database.Database;
import de.lmu.ifi.dbs.elki.database.datastore.DataStore;
import de.lmu.ifi.dbs.elki.database.datastore.DataStoreFactory;
import de.lmu.ifi.dbs.elki.database.datastore.DataStoreUtil;
import de.lmu.ifi.dbs.elki.database.datastore.WritableDataStore;
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.DBIDs;
import de.lmu.ifi.dbs.elki.database.ids.StaticDBIDs;
import de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult;
import de.lmu.ifi.dbs.elki.utilities.iterator.IterableIterator;
import de.lmu.ifi.dbs.elki.utilities.iterator.IterableUtil;
/**
* Represents a single representation. This is attached to a DBIDs object, which
* you are supposed to manage first. I.e. put the new DBID in, then invoke
* set(), remove the DBID, then delete().
*
* TODO: is this semantic sane?
*
* @author Erich Schubert
*
* @param Data type
*/
public class MaterializedRelation extends AbstractHierarchicalResult implements Relation {
/**
* Our database
*/
private final Database database;
/**
* The class of objects we store.
*/
private final SimpleTypeInformation type;
/**
* Map to hold the objects of the database.
*/
private final DataStore content;
/**
* The DBIDs this is supposed to be defined for.
*
* Note: we only keep an unmodifiable reference.
*/
private final StaticDBIDs ids;
/**
* The relation name.
*/
private String name;
/**
* The relation name (short version)
*/
private String shortname = "relation";
/**
* Constructor.
*
* @param database Database
* @param type Type information
* @param ids IDs
*/
public MaterializedRelation(Database database, SimpleTypeInformation type, DBIDs ids) {
this(database, type, ids, null);
}
/**
* Constructor.
*
* @param database Database
* @param type Type information
* @param ids IDs
* @param name Name
*/
public MaterializedRelation(Database database, SimpleTypeInformation type, DBIDs ids, String name) {
// We can't call this() since we'll have generics issues then.
super();
this.database = database;
this.type = type;
this.ids = DBIDUtil.makeUnmodifiable(ids);
this.name = name;
this.content = DataStoreUtil.makeStorage(ids, DataStoreFactory.HINT_DB, type.getRestrictionClass());
}
/**
* Constructor.
*
* @param database Database
* @param type Type information
* @param ids IDs
* @param name Name
* @param content Content
*/
public MaterializedRelation(Database database, SimpleTypeInformation type, DBIDs ids, String name, DataStore content) {
super();
this.database = database;
this.type = type;
this.ids = DBIDUtil.makeUnmodifiable(ids);
this.name = name;
this.content = content;
}
/**
* Constructor.
* @param name Name
* @param shortname Short name of the result
* @param type Type information
* @param content Content
* @param ids IDs
*/
public MaterializedRelation(String name, String shortname, SimpleTypeInformation type, DataStore content, DBIDs ids) {
super();
this.database = null;
this.type = type;
this.ids = DBIDUtil.makeUnmodifiable(ids);
this.name = name;
this.shortname = shortname;
this.content = content;
}
@Override
public Database getDatabase() {
return database;
}
@Override
public O get(DBID id) {
return content.get(id);
}
@Override
public void set(DBID id, O val) {
assert (ids.contains(id));
if(content instanceof WritableDataStore) {
((WritableDataStore) content).put(id, val);
}
}
/**
* Delete an objects values.
*
* @param id ID to delete
*/
@Override
public void delete(DBID id) {
assert (!ids.contains(id));
if(content instanceof WritableDataStore) {
((WritableDataStore) content).delete(id);
}
}
@Override
public StaticDBIDs getDBIDs() {
return ids;
}
@Override
public IterableIterator iterDBIDs() {
return IterableUtil.fromIterable(ids);
}
@Override
public int size() {
return ids.size();
}
@Override
public SimpleTypeInformation getDataTypeInformation() {
return type;
}
@Override
public String getLongName() {
if(name != null) {
return name;
}
return type.toString();
}
@Override
public String getShortName() {
return shortname;
}
}