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

Interface Relation<O>

Type Parameters:

O - Object type

All Superinterfaces:

DatabaseQuery, HierarchicalResult, Result

All Known Implementing Classes:

ClusterOrderResult.PredecessorAdapter, ClusterOrderResult.ReachabilityDistanceAdapter, ConvertToStringView, DBIDView, MaterializedRelation, ProjectedView, ProxyView, SOD.SODProxyScoreResult

public interface Relation<O>
extends DatabaseQuery, HierarchicalResult

An object representation from a database

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(DBIDRef id) Delete an objects values.
O	get(DBIDRef id) Get the representation of an object.
Database	getDatabase() Get the associated database.
SimpleTypeInformation<O>	getDataTypeInformation() Get the data type of this representation
DBIDs	getDBIDs() Get the IDs the query is defined for.
DBIDIter	iterDBIDs() Get an iterator access to the DBIDs.
void	set(DBIDRef id, O val) Set an object representation.
int	size() Get the number of DBIDs.

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

getHierarchy, setHierarchy

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

getLongName, getShortName

Method Detail

getDatabase

Database getDatabase()

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

Returns:

Database

get

O get(DBIDRef id)

Get the representation of an object.

Parameters:

id - Object ID

Returns:

object instance

set

void set(DBIDRef id,
       O val)

Set an object representation.

Parameters:

id - Object ID

val - Value

delete

void delete(DBIDRef id)

Delete an objects values.

Parameters:

id - ID to delete

getDataTypeInformation

SimpleTypeInformation<O> getDataTypeInformation()

Get the data type of this representation

Returns:

Data type

getDBIDs

DBIDs getDBIDs()

Get the IDs the query is defined for.

Returns:

IDs this is defined for

iterDBIDs

DBIDIter iterDBIDs()

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();
 }
 
 

Returns:

iterator for the DBIDs.

size

int size()

Get the number of DBIDs.

Returns:

Size