com.orientechnologies.orient.core.iterator

Class ORecordIteratorCluster<REC extends ORecord>

java.lang.Object

com.orientechnologies.orient.core.iterator.OIdentifiableIterator<REC>

com.orientechnologies.orient.core.iterator.ORecordIteratorCluster<REC>

All Implemented Interfaces:

Iterable<REC>, Iterator<REC>

public class ORecordIteratorCluster<REC extends ORecord>
extends OIdentifiableIterator<REC>

Iterator class to browse forward and backward the records of a cluster. Once browsed in a direction, the iterator cannot change it.

Author:

Luca Garulli (l.garulli--(at)--orientdb.com)

Field Summary

Fields inherited from class com.orientechnologies.orient.core.iterator.OIdentifiableIterator

brokenRIDs, browsedRecords, current, currentTxEntryPosition, database, firstClusterEntry, lastClusterEntry, limit, liveUpdated, lockingStrategy, totalAvailableRecords, txEntries

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ORecordIteratorCluster(ODatabaseDocumentInternal database)
	ORecordIteratorCluster(ODatabaseDocumentInternal iDatabase, int iClusterId)
	ORecordIteratorCluster(ODatabaseDocumentInternal iDatabase, int iClusterId, long firstClusterEntry, long lastClusterEntry)
	ORecordIteratorCluster(ODatabaseDocumentInternal iDatabase, int iClusterId, long firstClusterEntry, long lastClusterEntry, OStorage.LOCKING_STRATEGY iLockingStrategy) Deprecated.

Method Summary

Modifier and Type	Method and Description
ORecordIteratorCluster<REC>	begin() Move the iterator to the begin of the range.
boolean	hasNext()
boolean	hasPrevious()
ORecordIteratorCluster<REC>	last() Move the iterator to the end of the range.
REC	next() Return the element at the current position and move forward the stream to the next position available.
REC	previous() Return the element at the current position and move backward the stream to the previous position available.
ORecordIteratorCluster<REC>	setLiveUpdated(boolean iLiveUpdated) Tell to the iterator that the upper limit must be checked at every cycle.

Methods inherited from class com.orientechnologies.orient.core.iterator.OIdentifiableIterator

checkCurrentPosition, checkDirection, checkForSystemClusters, current, currentPosition, getBrokenRIDs, getCurrentEntry, getFetchPlan, getLimit, getRecord, getTransactionEntry, isLiveUpdated, isReuseSameRecord, iterator, nextPosition, prevPosition, readCurrentRecord, remove, resetCurrentPosition, setFetchPlan, setLimit, setReuseSameRecord

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ORecordIteratorCluster

public ORecordIteratorCluster(ODatabaseDocumentInternal iDatabase,
                              int iClusterId)

ORecordIteratorCluster

public ORecordIteratorCluster(ODatabaseDocumentInternal iDatabase,
                              int iClusterId,
                              long firstClusterEntry,
                              long lastClusterEntry)

ORecordIteratorCluster

protected ORecordIteratorCluster(ODatabaseDocumentInternal database)

ORecordIteratorCluster

@Deprecated
public ORecordIteratorCluster(ODatabaseDocumentInternal iDatabase,
                                          int iClusterId,
                                          long firstClusterEntry,
                                          long lastClusterEntry,
                                          OStorage.LOCKING_STRATEGY iLockingStrategy)

Deprecated.

Method Detail

hasPrevious

public boolean hasPrevious()

Specified by:

hasPrevious in class OIdentifiableIterator<REC extends ORecord>

hasNext

public boolean hasNext()

previous

public REC previous()

Return the element at the current position and move backward the stream to the previous position available.

Specified by:

previous in class OIdentifiableIterator<REC extends ORecord>

Returns:

the previous record found, otherwise the NoSuchElementException exception is thrown when no more records are found.

next

public REC next()

Return the element at the current position and move forward the stream to the next position available.

Returns:

the next record found, otherwise the NoSuchElementException exception is thrown when no more records are found.

begin

public ORecordIteratorCluster<REC> begin()

Move the iterator to the begin of the range. If no range was specified move to the first record of the cluster.

Specified by:

begin in class OIdentifiableIterator<REC extends ORecord>

Returns:

The object itself

last

public ORecordIteratorCluster<REC> last()

Move the iterator to the end of the range. If no range was specified move to the last record of the cluster.

Specified by:

last in class OIdentifiableIterator<REC extends ORecord>

Returns:

The object itself

setLiveUpdated

public ORecordIteratorCluster<REC> setLiveUpdated(boolean iLiveUpdated)

Tell to the iterator that the upper limit must be checked at every cycle. Useful when concurrent deletes or additions change the size of the cluster while you're browsing it. Default is false.

Overrides:

setLiveUpdated in class OIdentifiableIterator<REC extends ORecord>

Parameters:

iLiveUpdated - True to activate it, otherwise false (default)

See Also:

OIdentifiableIterator.isLiveUpdated()