de.lmu.ifi.dbs.elki.database.relation

Class DBIDView

java.lang.Object

de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

de.lmu.ifi.dbs.elki.database.relation.DBIDView

All Implemented Interfaces:

DatabaseQuery, Relation<DBID>, HierarchicalResult, Result

public class DBIDView
extends AbstractHierarchicalResult
implements Relation<DBID>

Pseudo-representation that is the object ID itself.

Field Summary

Fields

Modifier and Type	Field and Description
private Database	database The database
private DBIDs	ids The ids object

Fields inherited from interface de.lmu.ifi.dbs.elki.database.query.DatabaseQuery

HINT_BULK, HINT_EXACT, HINT_HEAVY_USE, HINT_NO_CACHE, HINT_OPTIMIZED_ONLY, HINT_SINGLE

Constructor Summary

Constructors

Constructor and Description
DBIDView(Database database, DBIDs ids) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(DBIDRef id) Delete an objects values.
DBID	get(DBIDRef id) Get the representation of an object.
Database	getDatabase() Get the associated database.
SimpleTypeInformation<DBID>	getDataTypeInformation() Get the data type of this representation
DBIDs	getDBIDs() Get the IDs the query is defined for.
String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
String	getShortName() A short name for the result, useful for file names.
DBIDIter	iterDBIDs() Get an iterator access to the DBIDs.
void	set(DBIDRef id, DBID val) Set an object representation.
void	setDBIDs(DBIDs ids) Set the DBIDs of the view.
int	size() Get the number of DBIDs.

Methods inherited from class de.lmu.ifi.dbs.elki.result.AbstractHierarchicalResult

addChildResult, getHierarchy, setHierarchy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.lmu.ifi.dbs.elki.result.HierarchicalResult

getHierarchy, setHierarchy

Field Detail

database

private final Database database

The database

ids

private DBIDs ids

The ids object

Constructor Detail

DBIDView

public DBIDView(Database database,
        DBIDs ids)

Constructor.

Parameters:

database -

ids -

Method Detail

getDatabase

public Database getDatabase()

Description copied from interface: Relation

Get the associated database. Note: in some situations, this might be null!

Specified by:

getDatabase in interface Relation<DBID>

Returns:

Database

get

public DBID get(DBIDRef id)

Description copied from interface: Relation

Get the representation of an object.

Specified by:

get in interface Relation<DBID>

Parameters:

id - Object ID

Returns:

object instance

set

public void set(DBIDRef id,
       DBID val)

Description copied from interface: Relation

Set an object representation.

Specified by:

set in interface Relation<DBID>

Parameters:

id - Object ID

val - Value

delete

public void delete(DBIDRef id)

Description copied from interface: Relation

Delete an objects values.

Specified by:

delete in interface Relation<DBID>

Parameters:

id - ID to delete

getDataTypeInformation

public SimpleTypeInformation<DBID> getDataTypeInformation()

Description copied from interface: Relation

Get the data type of this representation

Specified by:

getDataTypeInformation in interface Relation<DBID>

Returns:

Data type

getDBIDs

public DBIDs getDBIDs()

Description copied from interface: Relation

Get the IDs the query is defined for.

Specified by:

getDBIDs in interface Relation<DBID>

Returns:

IDs this is defined for

iterDBIDs

public DBIDIter iterDBIDs()

Description copied from interface: Relation

Get an iterator access to the DBIDs. To iterate over all IDs, use the following code fragment:

 for(DBIDIter iter = relation.iterDBIDs(); iter.valid(); iter.advance()) {
    DBID id = iter.getDBID();
 }
 
 

Specified by:

iterDBIDs in interface Relation<DBID>

Returns:

iterator for the DBIDs.

setDBIDs

public void setDBIDs(DBIDs ids)

Set the DBIDs of the view.

Parameters:

ids - IDs to use

size

public int size()

Description copied from interface: Relation

Get the number of DBIDs.

Specified by:

size in interface Relation<DBID>

Returns:

Size

getLongName

public String getLongName()

Description copied from interface: Result

A "pretty" name for the result, for use in titles, captions and menus.

Specified by:

getLongName in interface Result

Returns:

result name

getShortName

public String getShortName()

Description copied from interface: Result

A short name for the result, useful for file names.

Specified by:

getShortName in interface Result

Returns:

result name