Package com.yahoo.documentapi

Class VisitorIterator.ExplicitBucketSource

java.lang.Object

com.yahoo.documentapi.VisitorIterator.ExplicitBucketSource

All Implemented Interfaces:

VisitorIterator.BucketSource

Enclosing class:

VisitorIterator

protected static class VisitorIterator.ExplicitBucketSource
extends java.lang.Object
implements VisitorIterator.BucketSource

Provides an explicit set of bucket IDs to iterate over. Will immediately set these as pending in the ProgressToken, as it is presumed this set is rather small. Changing the distribution bit count for this source is effectively a no-op, as explicit bucket IDs should not be implicitly changed.

Constructor Summary

Constructors

Constructor	Description
ExplicitBucketSource(java.util.Set<com.yahoo.document.BucketId> superbuckets, int distributionBitCount, ProgressToken progress)

Method Summary

Modifier and Type	Method	Description
int	getDistributionBitCount()
VisitorIterator.BucketProgress	getNext()
long	getTotalBucketCount()
boolean	hasNext()
void	setDistributionBitCount(int distributionBitCount, ProgressToken progress)
boolean	shouldYield()
void	update(com.yahoo.document.BucketId superbucket, com.yahoo.document.BucketId progress, ProgressToken token)
boolean	visitsAllBuckets()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExplicitBucketSource

public ExplicitBucketSource(java.util.Set<com.yahoo.document.BucketId> superbuckets,
                            int distributionBitCount,
                            ProgressToken progress)

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface VisitorIterator.BucketSource

shouldYield

public boolean shouldYield()

Specified by:

shouldYield in interface VisitorIterator.BucketSource

visitsAllBuckets

public boolean visitsAllBuckets()

Specified by:

visitsAllBuckets in interface VisitorIterator.BucketSource

getTotalBucketCount

public long getTotalBucketCount()

Specified by:

getTotalBucketCount in interface VisitorIterator.BucketSource

getNext

public VisitorIterator.BucketProgress getNext()

Specified by:

getNext in interface VisitorIterator.BucketSource

getDistributionBitCount

public int getDistributionBitCount()

Specified by:

getDistributionBitCount in interface VisitorIterator.BucketSource

setDistributionBitCount

public void setDistributionBitCount(int distributionBitCount,
                                    ProgressToken progress)

Specified by:

setDistributionBitCount in interface VisitorIterator.BucketSource

update

public void update(com.yahoo.document.BucketId superbucket,
                   com.yahoo.document.BucketId progress,
                   ProgressToken token)

Specified by:

update in interface VisitorIterator.BucketSource