de.lmu.ifi.dbs.elki.database.query.knn

Class KNNUtil.DBIDItr

java.lang.Object

de.lmu.ifi.dbs.elki.database.query.knn.KNNUtil.DBIDItr

All Implemented Interfaces:

DBIDIter, DBIDRef, Iter

Enclosing class:

KNNUtil

protected static class KNNUtil.DBIDItr
extends Object
implements DBIDIter

Proxy iterator for accessing DBIDs.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) DistanceResultPair<?>	cur Current result
(package private) Iterator<? extends DistanceResultPair<?>>	itr The real iterator.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KNNUtil.DBIDItr(Iterator<? extends DistanceResultPair<?>> itr) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	advance() Moves the iterator forward to the next entry.
int	compareDBID(DBIDRef o) Compare two objects by the value of the referenced DBID.
DBID	getDBID() Get the referenced DBID.
int	getIntegerID() Return the integer value of the object ID, if possible.
boolean	sameDBID(DBIDRef other) Compare the current value of two referenced DBIDs.
boolean	valid() Returns true if the iterator currently points to a valid object.

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.ids.DBIDRef

equals, hashCode

Field Detail

cur

DistanceResultPair<?> cur

Current result

itr

Iterator<? extends DistanceResultPair<?>> itr

The real iterator.

Constructor Detail

KNNUtil.DBIDItr

protected KNNUtil.DBIDItr(Iterator<? extends DistanceResultPair<?>> itr)

Constructor.

Method Detail

valid

public boolean valid()

Description copied from interface: Iter

Returns true if the iterator currently points to a valid object.

Specified by:

valid in interface Iter

Returns:

a boolean value

advance

public void advance()

Description copied from interface: Iter

Moves the iterator forward to the next entry.

Specified by:

advance in interface Iter

getIntegerID

public int getIntegerID()

Description copied from interface: DBIDRef

Return the integer value of the object ID, if possible.

Specified by:

getIntegerID in interface DBIDRef

Returns:

integer id

getDBID

public DBID getDBID()

Description copied from interface: DBIDIter

Get the referenced DBID. Efficiency note: this may require materialization of a DBID object - if possible, use DBIDRef based APIs instead.

Specified by:

getDBID in interface DBIDIter

Specified by:

getDBID in interface DBIDRef

Returns:

referenced DBID

sameDBID

public boolean sameDBID(DBIDRef other)

Description copied from interface: DBIDRef

Compare the current value of two referenced DBIDs.

Specified by:

sameDBID in interface DBIDRef

Parameters:

other - Other DBID reference (or DBID)

Returns:

true when the references currently refer to the same.

compareDBID

public int compareDBID(DBIDRef o)

Description copied from interface: DBIDRef

Compare two objects by the value of the referenced DBID.

Specified by:

compareDBID in interface DBIDRef

Parameters:

o - Other DBID or object

Returns:

-1, 0 or +1