Package elki.database.relation

Class DBIDView

java.lang.Object

elki.database.relation.DBIDView

All Implemented Interfaces:

Relation<DBID>

public class DBIDView
extends java.lang.Object
implements Relation<DBID>

Pseudo-representation that is the object ID itself.

Since:

0.4.0

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field	Description
private DBIDs	ids	The ids object

Constructor Summary

Constructors

Constructor	Description
DBIDView(DBIDs ids)	Constructor.

Method Summary

Modifier and Type	Method	Description
DBID	get(DBIDRef id)	Get the representation of an object.
SimpleTypeInformation<DBID>	getDataTypeInformation()	Get the data type of this representation
DBIDs	getDBIDs()	Get the IDs the query is defined for.
java.lang.String	getLongName()	Get a long (human readable) name for the relation.
DBIDIter	iterDBIDs()	Get an iterator access to the DBIDs.
void	setDBIDs(DBIDs ids)	Set the DBIDs of the view.
int	size()	Get the number of DBIDs.

Methods inherited from class java.lang.Object

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

Methods inherited from interface elki.database.relation.Relation

forEach

Field Detail

ids

private DBIDs ids

The ids object

Constructor Detail

DBIDView

public DBIDView(DBIDs ids)

Constructor.

Parameters:

ids - DBIDs

Method Detail

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

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.

If possible, prefer Relation.iterDBIDs().

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()) {
    relation.get(iter); // Get the current element
 }
 
 

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 java.lang.String getLongName()

Description copied from interface: Relation

Get a long (human readable) name for the relation.

Specified by:

getLongName in interface Relation<DBID>

Returns:

Relation name