de.lmu.ifi.dbs.elki.database.ids

Interface DBIDIter

All Known Implementing Classes:

DBIDIterAdapter, EmptyDBIDs.EmptyDBIDIterator, IntegerArrayStaticDBIDs.DBIDItr, IntegerDBID.DBIDItr, IntegerDBIDRange.DBIDItr, KNNUtil.DBIDItr, MaskedDBIDs.DBIDItr, MaskedDBIDs.InvDBIDItr, TroveArrayDBIDs.DBIDItr, TroveHashSetModifiableDBIDs.DBIDItr

public interface DBIDIter

Iterator for DBIDs. Important note: this iterator has a significantly different syntax and semantics than the Java iterators. It is much more aligned with C than with Java, but at the same time, the syntax is much more compatible with for loops. Usage example:

for (DBIDIter iter = ids.iter(); iter.valid(); iter.advance()) { iter.getDBID(); }

We list some fundamental differences.

• iter.valid() refers to the current element, Iterator.next() to the next.
• iter.advance() does not return an element. Use get... to access it.
• DBIDIter.get... do not advance the iterator.

Method Summary

Methods

Modifier and Type	Method and Description
void	advance() Moves the iterator forward to the next entry.
DBID	getDBID() Get the current DBID.
int	getIntegerID() Return the integer value of the object ID, if possible.
boolean	valid() Returns true if the iterator currently points to a valid object.

Method Detail

valid

boolean valid()

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

Returns:

a boolean value

advance

void advance()

Moves the iterator forward to the next entry.

Throws:

NoSuchElementException - if the iterator is already exhausted

getIntegerID

int getIntegerID()

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

Returns:

integer id

getDBID

DBID getDBID()

Get the current DBID.

Returns:

current DBID