Package com.yahoo.documentapi

Interface VisitorIterator.BucketSource

All Known Implementing Classes:

VisitorIterator.DistributionRangeBucketSource, VisitorIterator.ExplicitBucketSource

Enclosing class:

VisitorIterator

protected static interface VisitorIterator.BucketSource

Provides an abstract interface to VisitorIterator for how pending buckets are acquired, decoupling this from the iteration itself. Important: it is the responsibility of the VisitorIterator.BucketSource implementation to ensure that progress information is honored for (partially) finished buckets. From the point of view of the iterator itself, it should not have to deal with filtering away already finished buckets, as this is a detail best left to bucket sources.

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

Method Details

hasNext

boolean hasNext()

shouldYield

boolean shouldYield()

visitsAllBuckets

boolean visitsAllBuckets()

getNext

VisitorIterator.BucketProgress getNext()

getTotalBucketCount

long getTotalBucketCount()

getDistributionBitCount

int getDistributionBitCount()

setDistributionBitCount

void setDistributionBitCount(int distributionBitCount,
 ProgressToken progress)

update

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