com.orientechnologies.orient.core.iterator

Class ORecordIteratorClusters<REC extends ORecord>

java.lang.Object

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

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

All Implemented Interfaces:

Iterable<REC>, Iterator<REC>

Direct Known Subclasses:

ORecordIteratorClass

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

Iterator to browse multiple clusters forward and backward. Once browsed in a direction, the iterator cannot change it. This iterator with "live updates" set is able to catch updates to the cluster sizes while browsing. This is the case when concurrent clients/threads insert and remove item in any cluster the iterator is browsing. If the cluster are hot removed by from the database the iterator could be invalid and throw exception of cluster not found.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ORID	beginRange
protected int[]	clusterIds
protected int	currentClusterIdx
protected ORecord	currentRecord
protected ORID	endRange

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
	ORecordIteratorClusters(ODatabaseDocumentInternal iDatabase, int[] iClusterIds)
	ORecordIteratorClusters(ODatabaseDocumentInternal iDatabase, int[] iClusterIds, OStorage.LOCKING_STRATEGY iLockingStrategy) Deprecated.
protected	ORecordIteratorClusters(ODatabaseDocumentInternal iDatabase, OStorage.LOCKING_STRATEGY iLockingStrategy) Deprecated.

Method Summary

Modifier and Type	Method and Description
ORecordIteratorClusters<REC>	begin() Move the iterator to the begin of the range.
protected void	config()
ORID	getBeginRange()
int[]	getClusterIds()
ORID	getEndRange()
boolean	hasNext()
boolean	hasPrevious()
protected boolean	include(ORecord iRecord)
ORecordIteratorClusters<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.
ORecordIteratorClusters<REC>	setLiveUpdated(boolean iLiveUpdated) Tell to the iterator that the upper limit must be checked at every cycle.
ORecordIteratorClusters<REC>	setRange(ORID iBegin, ORID iEnd)
String	toString()
protected void	updateClusterRange()

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, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

clusterIds

protected int[] clusterIds

currentClusterIdx

protected int currentClusterIdx

currentRecord

protected ORecord currentRecord

beginRange

protected ORID beginRange

endRange

protected ORID endRange

Constructor Detail

ORecordIteratorClusters

public ORecordIteratorClusters(ODatabaseDocumentInternal iDatabase,
                               int[] iClusterIds)

ORecordIteratorClusters

@Deprecated
public ORecordIteratorClusters(ODatabaseDocumentInternal iDatabase,
                                           int[] iClusterIds,
                                           OStorage.LOCKING_STRATEGY iLockingStrategy)

Deprecated.

ORecordIteratorClusters

@Deprecated
protected ORecordIteratorClusters(ODatabaseDocumentInternal iDatabase,
                                              OStorage.LOCKING_STRATEGY iLockingStrategy)

Deprecated.

Method Detail

setRange

public ORecordIteratorClusters<REC> setRange(ORID iBegin,
                                             ORID iEnd)

hasPrevious

public boolean hasPrevious()

Specified by:

hasPrevious in class OIdentifiableIterator<REC extends ORecord>

hasNext

public boolean hasNext()

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.

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.

begin

public ORecordIteratorClusters<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 ORecordIteratorClusters<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 ORecordIteratorClusters<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()

getBeginRange

public ORID getBeginRange()

getEndRange

public ORID getEndRange()

getClusterIds

public int[] getClusterIds()

toString

public String toString()

Overrides:

toString in class Object

include

protected boolean include(ORecord iRecord)

updateClusterRange

protected void updateClusterRange()

config

protected void config()