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.AbstractRelation<DBID>

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

All Implemented Interfaces:

DatabaseQuery, Relation<DBID>, HierarchicalResult, Result

public class DBIDView
extends AbstractRelation<DBID>

Pseudo-representation that is the object ID itself.

Since:

0.4.0

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
private DBIDs	ids The ids object
private static Logging	LOG Class logger

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(DBIDs ids) Constructor.

Method Summary

Modifier and Type	Method and 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.
protected Logging	getLogger() Get the class logger.
java.lang.String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
java.lang.String	getShortName() A short name for the result, useful for file names.
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 de.lmu.ifi.dbs.elki.database.relation.AbstractRelation

getDistanceQuery, getKNNQuery, getRangeQuery, getRKNNQuery, getSimilarityQuery, getSimilarityRangeQuery

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.database.relation.Relation

forEach, getKNNQuery, getRangeQuery, getRKNNQuery, getSimilarityRangeQuery

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

getHierarchy, setHierarchy

Field Detail

LOG

private static final Logging LOG

Class logger

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.

Parameters:

id - Object ID

Returns:

object instance

getDataTypeInformation

public SimpleTypeInformation<DBID> getDataTypeInformation()

Description copied from interface: Relation

Get the data type of this representation

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().

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
 }
 
 

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.

Returns:

Size

getLongName

public java.lang.String getLongName()

Description copied from interface: Result

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

Returns:

result name

getShortName

public java.lang.String getShortName()

Description copied from interface: Result

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

Returns:

result name

getLogger

protected Logging getLogger()

Description copied from class: AbstractRelation

Get the class logger.

Specified by:

getLogger in class AbstractRelation<DBID>

Returns:

Logger